Report execution and generation functions

Report generation helper module.

eurybia.report.generation.dict_to_text_blocks(text_dict: dict, level: int = 1) → panel.layout.base.Column[source]

This function recursively explores the dict and returns a Panel Column containing other groups and text blocks fed with the dict

Parameters

  • text_dict (dict) – This dict must contain string as keys, and dicts or strings as values

  • level (int = 1) – Recursion level, starting at 1 to allow for direct string manipulation

Returns

Column of blocks

Return type

pn.Column

eurybia.report.generation.execute_report(smartdrift: SmartDrift, explainer: SmartExplainer, output_file: str, project_info_file: str | None = None, config_report: dict | None = None, modalities_analysis: bool = False) → None[source]

Creates the report

Parameters

  • smartdrift (eurybia.core.smartdrift.SmartDrift object) – Compiled SmartDrift class

  • explainer (shapash.explainer.smart_explainer.SmartExplainer object) – Compiled shapash explainer.

  • project_info_file (str) – Path to the file used to display some information about the project in the report.

  • config_report (dict, optional) – Report configuration options.

  • output_file (str) – Path to the HTML file to write