[DOC] Massive update of the model's webpage - #774
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR implements a massive refactor of the model webpage documentation, transforming a single static page into a comprehensive, multi-page model documentation system with enhanced visualization and organization.
Key changes:
- Replaces static matplotlib visualization with interactive Plotly charts
- Reorganizes models documentation into multiple themed pages (categorization, table, visualization)
- Adds comprehensive bibliography with BibTeX support and model categorization system
Reviewed Changes
Copilot reviewed 18 out of 27 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Adds new documentation dependencies (sphinx-autodoc-typehints, sphinx-autobuild, sphinxcontrib-bibtex, plotly) |
| docs/prepare_summary_tables.py | Complete rewrite to generate interactive Plotly visualizations and enhanced HTML table formatting |
| docs/models_summary.rst | Deleted - replaced by new multi-page structure |
| docs/models/ | New directory structure with 4 dedicated pages for models documentation |
| docs/references.bib | New comprehensive bibliography with 230+ academic references |
| braindecode/models/summary.csv | Adds "Categorization" column to classify models by architectural type |
| docs/conf.py | Configures new Sphinx extensions and icons for the enhanced documentation |
Comments suppressed due to low confidence (2)
docs/prepare_summary_tables.py:2
- The import
mathis removed but never used in the diff. This appears to be dead code removal, which is good for maintainability.
from argparse import ArgumentParser
docs/prepare_summary_tables.py:5
- [nitpick] The matplotlib import is removed but the code now uses Plotly. Consider adding a comment explaining this architectural change for future maintainers.
import pandas as pd
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #774 +/- ##
==========================================
- Coverage 87.74% 87.20% -0.55%
==========================================
Files 94 94
Lines 7712 7712
==========================================
- Hits 6767 6725 -42
- Misses 945 987 +42 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.