pdstools.explanations.Reports

Classes

Reports

Module Contents

class Reports(explanations: pdstools.explanations.Explanations.Explanations)

Bases: pdstools.utils.namespaces.LazyNamespace

Parameters:

explanations (pdstools.explanations.Explanations.Explanations)

dependencies = ['yaml']
dependency_group = 'explanations'
explanations
report_foldername = 'reports'
report_folderpath
report_output_dir
aggregate_folder
params_file
generate(report_filename: str = 'explanations_report.zip', top_n: int = _DEFAULT.TOP_N.value, top_k: int = _DEFAULT.TOP_K.value, zip_output: bool = False, verbose: bool = False)

Generate the explanations report.

Args:
report_filename (str):

Name of the output report file.

top_n (int):

Number of top explanations to include.

top_k (int):

Number of top features to include in explanations.

zip_output (bool):

Whether to zip the output report. The filename will be used as the zip file name.

verbose (bool):

Whether to print verbose output during report generation.

Parameters:
_validate_report_dir()
_copy_report_resources()
_set_params(top_n: int = _DEFAULT.TOP_N.value, top_k: int = _DEFAULT.TOP_K.value, verbose: bool = False)
Parameters: