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 = defaults.top_n, top_k: int = defaults.top_k, zip_output: bool = False, **filter_kwargs)¶

Generate the explanations report.

Parameters:

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.
**filter_kwargs –
Optional filtering and display controls. Valid keys:
- sort_by (str): Column to rank/select top predictors. Default: "contribution_abs".
- display_by (str): Column to use for the report axis values. Default: "contribution".

Notes

Progress and diagnostic information is logged at DEBUG level. Enable debug logging to see detailed report generation steps.