src.report.advanced_classification_report

Classes

AdvancedClassificationReport(**kwargs)

class src.report.advanced_classification_report.AdvancedClassificationReport(**kwargs)

Author:

Alberto M. Esmoris PEna

Class to handle advanced reports related to classifications. See Report, ClassificationModel, AdvancedClassificationEvaluator, and AdvancedClassificationEvaluation.

Variables:

• evals (list of ClassificationEvaluation) – The many evaluations on the classification based on the requested filters.

• class_names (list of str) – The names for each class involved in the classification.

• domain_name – See AdvancedClassificationEvaluator.

• num_points – See AdvancedClassificationEvaluation.

• num_fpoints – See AdvancedClassificationEvaluation.

CONFMAT_SEPARATOR = '----------------'

__init__(**kwargs)

Initialize an instance of AdvancedClassificationReport.

Parameters:

kwargs – The key-word arguments defining the report’s attributes.

to_global_eval_string()

Generate the string representing the advanced classification report with respect to the advanced global evaluation.

Returns:

String representing the advanced classification report with respect to the advanced global evaluation.

to_class_eval_string()

Generate the string representing the advanced classification report with respect to the advanced class-wise evaluation.

Returns:

String representing the advanced classification report with respect to the advanced class-wise evaluation.

to_confusion_matrices_string()

Generate the string representing the advanced classification report

with respect to the advanced confusion matrices.

Returns:

String representing the advanced classification report with respect to the advanced confusion matrices.

to_class_distribution_string()

Generate the string representing the advanced classification report with respect to the advanced class distribution.

Returns:

String representing the advanced classification report with respect to the advanced class distribution.

to_file(report_path=None, class_report_path=None, confusion_matrix_report_path=None, class_distribution_report_path=None, out_prefix=None)

Write the advanced classification report to files.

Parameters:

• report_path – See ClassificationEvaluator.

• class_report_path – See ClassificationEvaluator.

• confusion_matrix_report_path – See ClassificationEvaluator.

• class_distribution_report_path – See ClassificationEvaluator.

• out_prefix (str) – The output prefix to expand the path (OPTIONAL).

Returns:

Nothing, the output is written to a file.

has_global_eval_info()

Check whether the report contains information about the global evaluation.

Returns:

True if the report contains information about the global evaluation, False otherwise.

has_class_eval_info()

Check whether the report contains information about the class-wise evaluation.

Returns:

True if the report contains information about the class-wise evaluation, False otherwise.

has_confusion_matrix()

Check whether the report contains the confusion matrix.

Returns:

True if the report contains the confusion matrix, False otherwise.

has_class_distribution_info()

Check whether the report contains information about the class distribution.

Returns:

True if the report contains information about the class distribution, False otherwise.