Skip to content

[DOC] Massive update of the model's webpage - #774

Merged
bruAristimunha merged 24 commits into
masterfrom
thesis-model-table
Aug 22, 2025
Merged

[DOC] Massive update of the model's webpage #774
bruAristimunha merged 24 commits into
masterfrom
thesis-model-table

Conversation

@bruAristimunha

Copy link
Copy Markdown
Collaborator

No description provided.

@bruAristimunha
bruAristimunha requested a review from Copilot August 22, 2025 17:13

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 math is 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.

Comment thread docs/prepare_summary_tables.py
Comment thread docs/models/models_table.rst Outdated
Comment thread docs/models/models_table.rst Outdated
Comment thread braindecode/models/summary.csv
Comment thread .pre-commit-config.yaml
@bruAristimunha bruAristimunha changed the title Massive update of the model's webpage [DOC] Massive update of the model's webpage Aug 22, 2025
bruAristimunha and others added 5 commits August 22, 2025 19:17
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@codecov

codecov Bot commented Aug 22, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.20%. Comparing base (bde6cf7) to head (a77ed46).
⚠️ Report is 1 commits behind head on master.

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bruAristimunha
bruAristimunha merged commit d9e3200 into master Aug 22, 2025
15 of 17 checks passed
@bruAristimunha
bruAristimunha deleted the thesis-model-table branch August 22, 2025 18:02
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.

2 participants