diff --git a/PR_SUMMARY.md b/PR_SUMMARY.md new file mode 100644 index 000000000..80e27f75d --- /dev/null +++ b/PR_SUMMARY.md @@ -0,0 +1,103 @@ +# PR #832: Draft PR for Version Increase to v1.4.0 + +## Overview +This PR prepares the braindecode repository for the v1.4.0 release scheduled for **November 22, 2025** (in 2 weeks). + +## Changes Made + +### 1. Version Update +- **File**: `braindecode/version.py` +- **Change**: Updated version from `1.3.0` to `1.4.0` + +### 2. Documentation Updates +- **File**: `docs/whats_new.rst` +- **Change**: Added new section for v1.4.0 development, moved v1.3 to released versions section + +### 3. Release Planning Document +- **File**: `RELEASE_NOTES_v1.4.0.md` (new) +- **Content**: Comprehensive analysis of: + - All open Pull Requests with merge readiness assessment + - All open Issues with priority ratings + - Recommended timeline for release + - Categorized PR/Issue lists by priority + +## Key Findings + +### Ready-to-Merge PRs (HIGH PRIORITY) +These PRs appear ready and should be prioritized for v1.4.0: + +1. **PR #820** - HuggingFace Hub Integration + - Status: 26 tests passing + - Impact: Major feature addition + - Author: @Kkuntal990 + +2. **PR #818** - SIENA and CHB_MIT Datasets + - Status: Ready + - Impact: New datasets + - Author: @bruAristimunha (maintainer) + +3. **PR #815** - LUNA Model Integration + - Status: Ready + - Impact: New model + - Author: @bruAristimunha (maintainer) + +### Medium Priority PRs +These may need additional review but could be included: +- PR #743: SimpleConv model (older, may need rebase) +- PR #687: set_description bug fix +- PR #614: RecordingSampler fix +- PR #612: SleepPhysionet tmax fix + +### Critical Issues to Track +- Issue #828: Epilepsy Benchmarks coordination +- Issue #827: WindowsDataset deprecation planning +- Issue #793: HuggingFace mixin improvements + +## Recommended Actions + +### Immediate (Now - Nov 15) +1. Review and merge PR #820 (HuggingFace Hub) if CI passes +2. Merge PR #818 (datasets) and PR #815 (LUNA model) +3. Review medium-priority PRs for inclusion + +### Mid-term (Nov 15-19) +1. Run comprehensive testing +2. Address any bugs found +3. Update changelog/what's new with actual changes + +### Final (Nov 19-21) +1. Final documentation review +2. Verify all tests pass +3. Prepare release notes + +### Release (Nov 22) +1. Create release tag v1.4.0 +2. Publish to PyPI +3. Update documentation + +## Files to Review + +Please review the following files in this PR: +- `RELEASE_NOTES_v1.4.0.md` - Complete analysis +- `braindecode/version.py` - Version bump +- `docs/whats_new.rst` - Documentation structure + +## Next Steps + +This is a **DRAFT PR** to facilitate discussion. Please: +1. Review the priority assessment in `RELEASE_NOTES_v1.4.0.md` +2. Confirm which PRs should be included +3. Update the what's new section with actual changes as PRs are merged +4. Coordinate with PR authors for any needed updates + +## Questions for Maintainers + +1. Is the November 22 release date still realistic? +2. Are there any other PRs/issues that should be prioritized? +3. Should we include all three high-priority PRs or focus on a subset? +4. Are there any breaking changes we need to document? + +--- +**Created by:** Copilot Coding Agent +**Date:** November 9, 2025 +**For Release:** v1.4.0 (scheduled November 22, 2025) diff --git a/RELEASE_NOTES_v1.4.0.md b/RELEASE_NOTES_v1.4.0.md new file mode 100644 index 000000000..139f2746d --- /dev/null +++ b/RELEASE_NOTES_v1.4.0.md @@ -0,0 +1,332 @@ +# Release Notes for v1.4.0 (Target: November 22, 2025) + +## Summary +This document lists all Pull Requests and Issues with potential to be merged for the upcoming v1.4.0 release. + +--- + +## High Priority Pull Requests (Ready for Merge) + +### PR #820 - Add Hugging Face Hub integration with Zarr format for dataset sharing +**Status:** Open (non-draft) +**Author:** @Kkuntal990 +**Created:** 2025-11-05 +**Last Updated:** 2025-11-08 + +**Summary:** +- Adds HuggingFace Hub integration to braindecode +- Enables easy sharing, versioning, and collaboration on EEG datasets +- Uses optimized Zarr format for dataset storage +- Supports three dataset types: WindowsDataset, EEGWindowsDataset, RawDataset +- **26 tests passing** ✅ +- Live demo datasets available on HuggingFace Hub + +**Merge Potential:** **HIGH** - Feature complete with passing tests and documentation + +--- + +### PR #818 - Add SIENA and CHB_MIT datasets +**Status:** Open (non-draft) +**Author:** @bruAristimunha (Maintainer) +**Created:** 2025-11-04 +**Last Updated:** 2025-11-05 + +**Summary:** +- Adds SIENA dataset support +- Adds CHB_MIT dataset support +- Updates relevant documentation + +**Merge Potential:** **HIGH** - Authored by maintainer, important dataset additions + +--- + +### PR #815 - LUNA model integration and utilities +**Status:** Open (non-draft) +**Author:** @bruAristimunha (Maintainer) +**Created:** 2025-11-04 +**Last Updated:** 2025-11-06 + +**Summary:** +- Integrates LUNA model into framework +- Updates related utilities +- Improves channel location extraction functionality +- Various code fixes and enhancements + +**Merge Potential:** **HIGH** - Model addition by maintainer + +--- + +## Medium Priority Pull Requests + +### PR #743 - Add SimpleConv model (DilatedConv from Meta Brain&AI Team) +**Status:** Open (non-draft) +**Author:** @bruAristimunha (Maintainer) +**Created:** 2025-04-29 +**Last Updated:** 2025-10-25 + +**Summary:** +- Introduces SimpleConv model to enhance MEG model capabilities +- Code cleanup and improved naming conventions + +**Merge Potential:** **MEDIUM** - Older PR, may need rebase and review + +--- + +### PR #687 - Check if self._description is None before set_description +**Status:** Open (non-draft) +**Author:** @Visvaria +**Created:** 2025-01-02 +**Last Updated:** 2025-10-25 + +**Summary:** +- Fixes bug where WindowsDataset created by _create_description has NoneType self._description +- Prevents errors when using set_description method + +**Merge Potential:** **MEDIUM** - Bug fix, needs review and testing + +--- + +### PR #614 - Add "recording" to keys in RecordingSampler; docs fix +**Status:** Open (non-draft) +**Author:** @OverLordGoldDragon +**Created:** 2024-05-17 +**Last Updated:** 2025-10-25 + +**Summary:** +- Fixes RecordingSampler treating recordings as contiguous +- Documentation improvements +- Typo fixes + +**Merge Potential:** **MEDIUM** - Important fix but older PR + +--- + +### PR #612 - Fix tmax in SleepPhysionet +**Status:** Open (non-draft) +**Author:** @OverLordGoldDragon +**Created:** 2024-05-17 +**Last Updated:** 2025-10-25 + +**Summary:** +- Fixes tmax calculation to be inclusive of time starts +- Removes redundant int conversion + +**Merge Potential:** **MEDIUM** - Bug fix for dataset + +--- + +### PR #580 - Create transfer learning tutorial +**Status:** Open (non-draft) +**Author:** @javadbayazi +**Created:** 2024-03-26 +**Last Updated:** 2025-10-25 + +**Summary:** +- Adds transfer learning tutorial/example + +**Merge Potential:** **LOW-MEDIUM** - Documentation improvement, older PR + +--- + +## Critical Open Issues to Address + +### Issue #828 - Epilepsy Benchmarks + Braindecode +**Priority:** HIGH +**Created:** 2025-11-07 +**Author:** @bruAristimunha (Maintainer) + +**Summary:** +- Collaboration with EPFL team to port winning models from competition +- Student assignment for model adaptation needed +- Has associated Google Sheets for tracking + +**Action Required:** Coordinate with students, track progress + +--- + +### Issue #827 - Completely deprecate the Windows Dataset +**Priority:** HIGH +**Created:** 2025-11-06 +**Author:** @bruAristimunha (Maintainer) + +**Summary:** +- Need to complete deprecation cycle for WindowsDataset +- Use only EEGWindowsDataset going forward +- Some functions still lacking equivalence + +**Action Required:** Assess impact, plan deprecation + +--- + +### Issue #823 - Temporal generalization Tutorial +**Priority:** MEDIUM +**Created:** 2025-11-05 +**Author:** @bruAristimunha (Maintainer) + +**Summary:** +- Create tutorial for generalized time slice windows +- Demonstrate temporal decoding with braindecode + +**Action Required:** Could be included in v1.4.0 if tutorial created quickly + +--- + +### Issue #816 - Example at chance level +**Priority:** MEDIUM +**Created:** 2025-11-04 +**Author:** @arnodelorme + +**Summary:** +- Example returns results at chance level (25%) +- Need to investigate and fix + +**Action Required:** Investigate root cause + +--- + +### Issue #809 - Improving the existent eegprep parameters +**Priority:** MEDIUM +**Created:** 2025-11-01 +**Author:** @bruAristimunha (Maintainer) + +**Summary:** +- Classes shouldn't accept base class arguments not meant for users +- Need to add trivial constructors back + +**Action Required:** Code cleanup + +--- + +### Issue #807 - Dataset mixin +**Priority:** LOW-MEDIUM +**Created:** 2025-11-01 +**Author:** @bruAristimunha (Maintainer) + +**Summary:** +- Need more details + +**Action Required:** Get requirements clarification + +--- + +### Issue #804 - Feature needed: distinguish RAW vs EPOCH format in Windows dataset +**Priority:** MEDIUM +**Created:** 2025-10-31 +**Author:** @bruAristimunha (Maintainer) + +**Summary:** +- Need indication whether raw object is used as epoch +- Important for proper dataset handling + +**Action Required:** Design and implement solution + +--- + +### Issue #803 - Make models SincShallowNet, DeepSleepNet/AttnSleep compatible with Hugging Face +**Priority:** MEDIUM +**Created:** 2025-10-31 +**Author:** @bruAristimunha (Maintainer) + +**Summary:** +- Improve HuggingFace compatibility for specific models + +**Action Required:** Model updates needed + +--- + +### Issue #800 - Save all model arguments when pushing to Hugging Face +**Priority:** MEDIUM +**Created:** 2025-10-29 +**Author:** @PierreGtch + +**Summary:** +- For optimal reproducibility, save all model arguments +- Not just signal params + +**Action Required:** Update HuggingFace integration + +--- + +### Issue #798 - Improve the model card +**Priority:** LOW +**Created:** 2025-10-29 +**Author:** @bruAristimunha (Maintainer) + +**Summary:** +- Future enhancement for model cards + +**Action Required:** Documentation improvement + +--- + +### Issue #793 - Improve our mixin to give Hugging Face hub capabilities +**Priority:** HIGH +**Created:** 2025-10-28 +**Author:** @bruAristimunha (Maintainer) + +**Summary:** +- Enhance EEGMixin with HuggingFace capabilities +- Related to PR #531 +- 9 comments showing active discussion + +**Action Required:** May be addressed by PR #820 + +--- + +## Recommendations for v1.4.0 Release + +### Must Have (Block Release) +1. **PR #820** - Hugging Face Hub integration (if tests pass in CI) +2. **PR #818** - SIENA and CHB_MIT datasets +3. **PR #815** - LUNA model integration + +### Should Have (Include if Ready) +1. **PR #743** - SimpleConv model (needs rebase/review) +2. **PR #687** - Fix set_description bug +3. **PR #614** - RecordingSampler fix +4. **PR #612** - SleepPhysionet tmax fix + +### Nice to Have (Future Release) +1. **PR #580** - Transfer learning tutorial +2. Various documentation improvements + +### Critical Issues to Track +1. **Issue #828** - Epilepsy Benchmarks coordination +2. **Issue #827** - WindowsDataset deprecation plan +3. **Issue #793** - HuggingFace mixin improvements + +--- + +## Version Update Plan + +Current version: **1.3.0** +Target version: **1.4.0** +Release date: **November 22, 2025** + +### Changes to Make: +1. Update `braindecode/version.py` from `1.3.0` to `1.4.0` +2. Create/update changelog +3. Update documentation version references if needed + +--- + +## Timeline + +- **Now - Nov 15:** Review and merge high-priority PRs +- **Nov 15-19:** Testing and bug fixes +- **Nov 19-21:** Final review and documentation +- **Nov 22:** Release v1.4.0 + +--- + +## Notes +- Total open PRs: 9 +- Total open issues: 72 +- PRs with high merge potential: 3-6 +- Critical issues to track: 4-5 + +This release focuses on: +- Dataset sharing capabilities (HuggingFace Hub) +- New datasets (SIENA, CHB_MIT) +- New models (LUNA, potentially SimpleConv) +- Bug fixes and improvements diff --git a/braindecode/version.py b/braindecode/version.py index 67bc602ab..3e8d9f946 100644 --- a/braindecode/version.py +++ b/braindecode/version.py @@ -1 +1 @@ -__version__ = "1.3.0" +__version__ = "1.4.0" diff --git a/docs/whats_new.rst b/docs/whats_new.rst index 1020025e9..dd3c86e70 100644 --- a/docs/whats_new.rst +++ b/docs/whats_new.rst @@ -17,7 +17,21 @@ What's new .. _current: -Current 1.3 (dev) +Current 1.4 (dev) +---------------------- + +Enhancements +~~~~~~~~~~~~ +- To be announced for v1.4.0 release (November 22, 2025) + +API changes +~~~~~~~~~~~ + +Bugs +~~~~ + + +Version 1.3 ---------------------- Enhancements