:py:mod:`bluecast.evaluation.base_classes`
==========================================

.. py:module:: bluecast.evaluation.base_classes

.. autoapi-nested-parse::

   Base classes for evaluation purposes



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   bluecast.evaluation.base_classes.DataReader
   bluecast.evaluation.base_classes.ErrorPreprocessor
   bluecast.evaluation.base_classes.ErrorAnalyser
   bluecast.evaluation.base_classes.ErrorDistributionPlotter




.. py:class:: DataReader


   Bases: :py:obj:`abc.ABC`

   Abstract class to define error reading out of fold datasets from BlueCast pipelines.

   .. py:method:: read_data_from_bluecast_instance() -> polars.DataFrame
      :abstractmethod:


   .. py:method:: read_data_from_bluecast_cv_instance() -> polars.DataFrame
      :abstractmethod:



.. py:class:: ErrorPreprocessor


   Bases: :py:obj:`abc.ABC`

   Abstract class to define analysing prediction errors on out of fold datasets

   .. py:method:: stack_predictions_by_class(df: polars.DataFrame) -> polars.DataFrame
      :abstractmethod:


   .. py:method:: calculate_errors(df) -> polars.DataFrame
      :abstractmethod:



.. py:class:: ErrorAnalyser


   Bases: :py:obj:`abc.ABC`

   Abstract class to define the analysis of prediction errors on out of fold datasets

   .. py:method:: analyse_errors(df, descending: bool = True) -> None
      :abstractmethod:



.. py:class:: ErrorDistributionPlotter


   Bases: :py:obj:`abc.ABC`

   Abstract class to define the plots for error analysis

   .. py:method:: plot_error_distributions(df: polars.DataFrame, target_column: str)
      :abstractmethod: