Report execution and generation functions

Report generation helper module.

eurybia.report.generation.execute_report(smartdrift: eurybia.core.smartdrift.SmartDrift, explainer: shapash.explainer.smart_explainer.SmartExplainer, project_info_file: str, output_file: str, config_report: Optional[dict] = 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