Skip to content

Feature/report - #750

Merged
guillaume-vignal merged 78 commits into
MAIF:developfrom
guerinclement:feature/report
Sep 4, 2026
Merged

Feature/report#750
guillaume-vignal merged 78 commits into
MAIF:developfrom
guerinclement:feature/report

Conversation

@guerinclement

@guerinclement guerinclement commented Aug 26, 2026

Copy link
Copy Markdown
Collaborator

Description

Refactors the report generation system by replacing the legacy implementation with a new modular smart_report architecture, and updates related documentation, assets, tutorials, and tests.

Added upon #708

  • added export_report_yml() function that copy a starting report configuration to the desired directory
  • added two default report : regression and classification
  • move some utils functions
  • added the possibility to return a list of elements in a block method: those elements are stacked. If an element is a tuple, its elements are sided in the same row.
  • delegated the whole panel viewable encapsulation to the block decorator as much as possible
  • updated the tutorial notebook
  • added two example scripts for regression and classification
  • added the top_interaction_plot
  • modified the block_text function so it can accept as content a dict of key elements to be displayed as a list, the key being bolded
  • removed the need for project_information.yml, those information now need to be directly included into the report config file. Default behavior : no project information.
  • fix Encoding error on Windows when generating report #699 and close fix(report): write HTML export as utf-8 #705

Main changes

Modular report engine introduced

  • Added a new smart_report implementation organized by responsibilities (core orchestration, rendering blocks, layout assembly, validation, and static assets).
  • Implemented a block-based configuration flow to make report composition more flexible and maintainable.
  • Improved separation of concerns between orchestration logic and rendering logic.

Legacy report implementation removed

  • Removed old legacy report files and templates that were tied to the previous architecture.
  • Cleaned up obsolete code paths and tests related to the deleted implementation.

Report UI and generated output improvements

  • Updated report front-end assets (CSS and JS) for better readability and responsiveness.
  • Refreshed visuals (including branding elements such as logo/color styling) for a more consistent report output.

Documentation, tutorials, and examples updated

  • Updated documentation pages and README content to describe the new report workflow.
  • Added or updated images and examples to reflect the new report generation behavior.
  • Updated tutorial and configuration examples to use the new report structure.

Test suite and integration updates

  • Added and updated tests for the new report architecture and panel behavior.
  • Removed outdated tests tied to legacy report behavior.
  • Included related cleanup and minor fixes across nearby modules impacted by the refactor.

@guillaume-vignal
guillaume-vignal merged commit 143ea9f into MAIF:develop Sep 4, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Encoding error on Windows when generating report

3 participants