Skip to content

Commit a0bdbd6

Browse files
committed
Update changelog for version 3.0.1: document module renaming, code structure cleanup, and improvements to documentation and examples
1 parent 845a017 commit a0bdbd6

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed

changelog.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,85 @@
11
# Changelog
22

3+
## Version 3.0.1
4+
5+
**Release Date:** October 2025
6+
7+
This is a patch release focusing on documentation improvements and module structure cleanup following the 3.0.0 release.
8+
9+
### Major Changes
10+
11+
#### Module Renaming
12+
- **BREAKING CHANGE**: Renamed `brainpy.state_based` module to `brainpy.state`
13+
- All functionality previously in `brainpy.state_based` is now accessible via `brainpy.state`
14+
- Users should update imports from `brainpy.state_based` to `brainpy.state`
15+
- This change provides a cleaner, more intuitive API structure
16+
17+
#### Code Structure Cleanup
18+
- **Removed `brainpy.version2` module**: All BrainPy 2.x functionality has been consolidated
19+
- The `version2` namespace has been removed from the codebase
20+
- All version2 functionality is now directly accessible through the main `brainpy` module
21+
- Version-specific imports are no longer needed
22+
23+
### Documentation
24+
25+
#### Documentation Reorganization
26+
- Renamed `docs_version2` to `docs_classic` for BrainPy 2.x documentation
27+
- Renamed `docs_state_based` to `docs_state` for BrainPy 3.x documentation
28+
- Renamed `examples_version2` to `examples_classic` for consistency
29+
- Renamed `examples_state_based` to `examples_state` for clarity
30+
31+
#### Documentation Updates
32+
- Updated all documentation references to use `brainpy.state` instead of `brainpy.state_based` (#791, #790)
33+
- Updated API documentation structure for improved clarity
34+
- Simplified API reference pages by removing redundant content
35+
- Updated card links and descriptions for `brainpy.state` APIs
36+
- Improved quickstart tutorial (5min-tutorial.ipynb) with clearer examples
37+
- Updated core concepts documentation to reflect new module structure
38+
- Enhanced tutorials with corrected module references
39+
- Updated all example files to use new module structure
40+
41+
#### Examples Updates
42+
- Updated simulation examples (EI networks, COBA, CUBA models) to use new API
43+
- Updated training examples (surrogate gradient training, MNIST models) with correct imports
44+
- Updated gamma oscillation examples with proper module references
45+
46+
### Bug Fixes
47+
48+
#### Testing
49+
- Removed redundant test for abstract Neuron class that was causing conflicts (d06bb47f)
50+
51+
### Migration Guide
52+
53+
For users upgrading from BrainPy 3.0.0:
54+
55+
1. **Update module imports**: Replace `brainpy.state_based` with `brainpy.state`
56+
```python
57+
58+
# New code (BrainPy 3.0.1)
59+
from brainpy.state import LIF, Expon
60+
```
61+
62+
2. **Remove version2 references**: If you were using `brainpy.version2`, migrate to the main `brainpy` module
63+
```python
64+
# Old code (not recommended)
65+
import brainpy.version2 as bp
66+
67+
# New code
68+
import brainpy as bp
69+
```
70+
71+
3. **Update documentation references**: If you're linking to documentation, use the new paths:
72+
- Classic docs: `docs_classic/` (formerly `docs_version2/`)
73+
- State-based docs: `docs_state/` (formerly `docs_state_based/`)
74+
75+
### Notes
76+
- This release maintains full backward compatibility with BrainPy 3.0.0 except for the module naming changes
77+
- The `brainpy.state_based` to `brainpy.state` rename provides a cleaner API and better reflects the module's purpose
78+
- Documentation is now better organized with clear separation between classic (2.x) and state-based (3.x) APIs
79+
80+
81+
82+
383
## Version 3.0.0
484

585
**Release Date:** October 2025

docs_classic/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,5 +148,6 @@ Learn more
148148
advanced_tutorials.rst
149149
FAQ.rst
150150
api.rst
151+
changelog.md
151152
brainpy-changelog.md
152153
brainpylib-changelog.md

0 commit comments

Comments
 (0)