Skip to content

Commit 36d2971

Browse files
committed
Bump version to 0.1.6 and update changelog with new features, improvements, breaking changes, and bug fixes
1 parent 2336904 commit 36d2971

File tree

2 files changed

+51
-5
lines changed

2 files changed

+51
-5
lines changed

braintools/__init__.py

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
# ==============================================================================
1515

1616

17-
__version__ = "0.1.5"
17+
__version__ = "0.1.6"
1818
__version_info__ = tuple(map(int, __version__.split(".")))
1919

2020
from . import conn
@@ -34,10 +34,17 @@
3434
from ._spike_operation import __all__ as operation_all
3535

3636
__all__ = [
37-
'conn', 'input', 'init',
38-
'file', 'metric', 'visualize',
39-
'optim', 'tree', 'quad',
40-
'surrogate', 'param',
37+
'conn',
38+
'input',
39+
'init',
40+
'file',
41+
'metric',
42+
'visualize',
43+
'optim',
44+
'tree',
45+
'quad',
46+
'surrogate',
47+
'param',
4148
] + encoder_all + operation_all
4249

4350
del encoder_all, operation_all

changelog.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,45 @@
11
# Release Notes
22

33

4+
## Version 0.1.6
5+
6+
### New Features
7+
8+
#### Parameter Management Expansion (`braintools.param`)
9+
- **Hierarchical data container**: Added `Data` for composed state storage and cloning.
10+
- **Parameter wrappers**: Added `Param` and `Const` with built-in transforms and optional regularization.
11+
- **State containers**: Added `ArrayHidden` and `ArrayParam` with transform-aware `.data` access.
12+
- **Regularization priors**: Added `GaussianReg`, `L1Reg`, and `L2Reg` with optional trainable hyperparameters.
13+
- **Utilities**: Added `get_param()` and `get_size()` helpers for parameter/state handling.
14+
15+
#### Transforms
16+
- **New `ReluT` transform** for lower-bounded parameters.
17+
- **Expanded transform suite** now includes `PositiveT`, `NegativeT`, `ScaledSigmoidT`, `PowerT`,
18+
`OrderedT`, `SimplexT`, and `UnitVectorT`.
19+
20+
### Improvements
21+
22+
#### API Consistency
23+
- **Transform naming cleanup**: Standardized transform class names with the `*T` suffix
24+
(e.g., `SigmoidT`, `SoftplusT`, `AffineT`, `ChainT`, `MaskedT`, `ClipT`).
25+
26+
#### Documentation
27+
- **Expanded param API docs**: Added sections for data containers, state containers, regularization,
28+
utilities, and updated transform listings in `docs/apis/param.rst`.
29+
- **API index update**: Added `param` API page to `docs/index.rst`.
30+
31+
#### Tests
32+
- **New test coverage**: Added tests for data containers, modules, regularization, state, transforms,
33+
and utilities across the param module.
34+
35+
### Breaking Changes
36+
- **Transform API renames**: Transform classes now use the `*T` suffix (e.g., `Sigmoid` -> `SigmoidT`).
37+
- **Custom transform removed**: The `Custom` transform is no longer part of the public API.
38+
39+
### Bug Fixes
40+
- **Initializer RNG**: `TruncatedNormal` now defaults to `numpy.random` when no RNG is provided.
41+
42+
443
## Version 0.1.5
544

645
### New Features

0 commit comments

Comments
 (0)