|
1 | 1 | # Release Notes |
2 | 2 |
|
3 | 3 |
|
| 4 | +## Version 0.1.2 |
| 5 | + |
| 6 | +### Major Changes |
| 7 | + |
| 8 | +#### Import Path Migration |
| 9 | +- **Updated dependency from `brainpy` to `brainpy.state`**: Migrated all imports to use the more specific `brainpy.state` module |
| 10 | + - Updated `braintrace/nn/_readout.py`: Changed neuron model imports from `brainpy` to `brainpy.state` |
| 11 | + - Updated all documentation notebooks (12 files): Concepts, RNN/SNN online learning, batching, state management, and graph visualization tutorials |
| 12 | + - Updated example scripts (4 files): COBA EI RSNN, SNN evaluation, feedforward conv SNN, and SNN models |
| 13 | + - Updated `requirements.txt` and `pyproject.toml` to specify `brainpy-state` as dependency |
| 14 | + - Total: 19 files changed with improved module structure and consistency |
| 15 | + |
| 16 | +#### New Algorithms |
| 17 | +- **Added PP-Prop (Pseudo-Prospective Propagation) algorithm**: New eligibility trace algorithm in VJP-based methods |
| 18 | + - Added `pp_prop` to `braintrace/_etrace_vjp/esd_rtrl.py` |
| 19 | + - Updated `docs/apis/algorithms.rst` to include PP-Prop in algorithm documentation |
| 20 | + |
| 21 | +#### Python 3.14 Support |
| 22 | +- **Added Python 3.14 compatibility**: Updated project metadata to officially support Python 3.14 |
| 23 | + - Updated `pyproject.toml` classifiers to include Python 3.14 |
| 24 | + |
| 25 | +#### Bug Fixes |
| 26 | +- **Fixed version info tuple creation**: Corrected the version info structure in `braintrace/__init__.py` |
| 27 | + - Ensures proper version tuple formatting for compatibility checks |
| 28 | + |
| 29 | +#### CI/CD Improvements |
| 30 | +- **Updated GitHub Actions workflow**: Bumped `actions/upload-artifact` from v5 to v6 |
| 31 | + - Modernized CI/CD pipeline with latest GitHub Actions versions |
| 32 | + - Improved artifact upload reliability and performance |
| 33 | + |
| 34 | +#### Documentation Updates |
| 35 | +- **Updated documentation links**: Refreshed links in concept documentation for better navigation |
| 36 | + - Updated `docs/quickstart/concepts-en.ipynb` (116 lines modified) |
| 37 | + - Updated `docs/quickstart/concepts-zh.ipynb` (104 lines modified) |
| 38 | + |
| 39 | +### Breaking Changes |
| 40 | + |
| 41 | +**Dependency Change:** |
| 42 | +1. **Dependency name change**: The project now requires `brainpy-state` instead of `brainpy` |
| 43 | + - Update your `requirements.txt` or installation commands accordingly |
| 44 | + |
| 45 | +```bash |
| 46 | +# Old (0.1.1) |
| 47 | +pip install brainpy |
| 48 | + |
| 49 | +# New (0.1.2) |
| 50 | +pip install brainpy-state |
| 51 | +``` |
| 52 | + |
| 53 | +2. **Import path update**: Update neuron model imports to use `brainpy.state` |
| 54 | + |
| 55 | +```python |
| 56 | +# New (0.1.2) |
| 57 | +from brainpy.state import IF, LIF, ALIF |
| 58 | +``` |
| 59 | + |
| 60 | +### Migration Guide |
| 61 | + |
| 62 | +#### Update Dependencies |
| 63 | +Replace `brainpy` with `brainpy-state` in your project dependencies: |
| 64 | + |
| 65 | +```bash |
| 66 | +pip uninstall brainpy |
| 67 | +pip install brainpy-state |
| 68 | +``` |
| 69 | + |
| 70 | +#### Update Import Statements |
| 71 | +If you have custom code importing neuron models, update to use `brainpy.state`: |
| 72 | + |
| 73 | +```python |
| 74 | +# Find and replace in your codebase |
| 75 | +# from brainpy import → from brainpy.state import |
| 76 | +``` |
| 77 | + |
| 78 | +### Version |
| 79 | +- Bumped version from `0.1.1` to `0.1.2` |
| 80 | + |
| 81 | + |
| 82 | + |
| 83 | + |
4 | 84 | ## Version 0.1.1 |
5 | 85 |
|
6 | 86 | ### Major Changes |
|
0 commit comments