:py:mod:`bluecast.tests.test_error_analysis_base_classes`
=========================================================

.. py:module:: bluecast.tests.test_error_analysis_base_classes


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

Classes
~~~~~~~

.. autoapisummary::

   bluecast.tests.test_error_analysis_base_classes.ConcreteDataReader
   bluecast.tests.test_error_analysis_base_classes.ConcreteErrorPreprocessor
   bluecast.tests.test_error_analysis_base_classes.ConcreteErrorAnalyser
   bluecast.tests.test_error_analysis_base_classes.ConcreteErrorDistributionPlotter



Functions
~~~~~~~~~

.. autoapisummary::

   bluecast.tests.test_error_analysis_base_classes.test_base_class_datareader_notimplemented_error
   bluecast.tests.test_error_analysis_base_classes.test_base_class_erroranalyser_notimplemented_error
   bluecast.tests.test_error_analysis_base_classes.test_base_class_errorpreprocessor_notimplemented_error
   bluecast.tests.test_error_analysis_base_classes.test_data_reader_not_implemented
   bluecast.tests.test_error_analysis_base_classes.test_error_preprocessor_not_implemented
   bluecast.tests.test_error_analysis_base_classes.test_error_analyser_not_implemented
   bluecast.tests.test_error_analysis_base_classes.test_error_distribution_plotter_not_implemented
   bluecast.tests.test_error_analysis_base_classes.test_plot_error_distributions_with_splits
   bluecast.tests.test_error_analysis_base_classes.test_plot_error_distributions_no_split



.. py:function:: test_base_class_datareader_notimplemented_error()


.. py:function:: test_base_class_erroranalyser_notimplemented_error()


.. py:function:: test_base_class_errorpreprocessor_notimplemented_error()


.. py:class:: ConcreteDataReader


   Bases: :py:obj:`bluecast.evaluation.base_classes.DataReader`

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

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


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



.. py:class:: ConcreteErrorPreprocessor


   Bases: :py:obj:`bluecast.evaluation.base_classes.ErrorPreprocessor`

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

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


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



.. py:class:: ConcreteErrorAnalyser


   Bases: :py:obj:`bluecast.evaluation.base_classes.ErrorAnalyser`

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

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



.. py:class:: ConcreteErrorDistributionPlotter


   Bases: :py:obj:`bluecast.evaluation.base_classes.ErrorDistributionPlotter`

   Abstract class to define the plots for error analysis

   .. py:method:: plot_error_distributions(df: polars.DataFrame, hue_column: str = 'target_class') -> None



.. py:function:: test_data_reader_not_implemented()


.. py:function:: test_error_preprocessor_not_implemented()


.. py:function:: test_error_analyser_not_implemented()


.. py:function:: test_error_distribution_plotter_not_implemented()


.. py:function:: test_plot_error_distributions_with_splits()


.. py:function:: test_plot_error_distributions_no_split()