Skip to content

Enhance model summary page with structured layout, tags, and dropdown filters - #718

Merged
PierreGtch merged 5 commits into
braindecode:masterfrom
Ganasekhar-gif:improve-model-summary-doc
Apr 11, 2025
Merged

Enhance model summary page with structured layout, tags, and dropdown filters#718
PierreGtch merged 5 commits into
braindecode:masterfrom
Ganasekhar-gif:improve-model-summary-doc

Conversation

@Ganasekhar-gif

Copy link
Copy Markdown
Contributor

This pull request enhances the models_summary.rst page by introducing a more structured layout and improving interactivity for users. The key improvements include:

✅ Dropdown filters for:
Model Paradigm
Model Type
Required Hyperparameters

Preview of Improved UI with Dropdown Filters and Clear Button:
Screenshot 2025-04-09 075249

✅ Clear button to reset all dropdowns and restore full table view
✅ Improved tag visualization using consistent styling with CSS
✅ More user-friendly layout with a focus on accessibility and clarity
✅ Fixed an issue where the Paradigm filter did not return results due to regex mismatch

Enhances user experience through intuitive navigation of model information
Promotes interactivity and accessibility, helping users filter models based on their needs
Makes the documentation more structured, engaging, and informative, especially for new contributors or researchers

Supports Braindecode’s goal to maintain high-quality, user-friendly documentation
Improves discoverability of models for various EEG paradigms and use-cases

closes #717

@codecov

codecov Bot commented Apr 9, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.31%. Comparing base (78f93fb) to head (1f5e9cb).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #718   +/-   ##
=======================================
  Coverage   87.31%   87.31%           
=======================================
  Files          78       78           
  Lines        7235     7235           
=======================================
  Hits         6317     6317           
  Misses        918      918           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@PierreGtch

Copy link
Copy Markdown
Collaborator

Hi @Ganasekhar-gif,

Thanks a lot for this PR! I'm not familiar with JS, so it is of great help :)

The filters seem to work well.
Just one remark, in the "Paradigm" dropdown menu, some tags seem to have been aggregated (for example Motor Imagery ERP SSVEP, see screenshot).
Is it intentional?
image

@Ganasekhar-gif

Copy link
Copy Markdown
Contributor Author

Hi @PierreGtch ,

Thank you for your feedback!
You're absolutely right — the aggregation of tags like "Motor Imagery ERP SSVEP" was not intentional. It was due to a parsing oversight in the dropdown filtering logic.

Thanks a lot for pointing that out — it really helped me catch and resolve the issue. I've now updated the code to properly split and display tags as individual entries. Please feel free to have another look and let me know if anything else needs adjustment!

@PierreGtch PierreGtch left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Awesome, thank you @Ganasekhar-gif

@PierreGtch
PierreGtch merged commit dbf1647 into braindecode:master Apr 11, 2025
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.

Models table: filter by tags

2 participants