Skip to content

Commit aff359e

Browse files
Update README and CHANGELOG.
1 parent 885b2ac commit aff359e

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Added
11+
- **Network Export**: JSON export capability for all network types (FeedForwardNetwork, RecurrentNetwork, CTRNN, IZNN)
12+
- New `neat.export` module with `export_network_json()` function
13+
- Framework-agnostic JSON format designed for conversion to ONNX, TensorFlow, PyTorch, etc.
14+
- Comprehensive format documentation in `docs/network-json-format.md`
15+
- Built-in function detection (activation/aggregation) vs. custom functions
16+
- Metadata support (fitness, generation, genome_id, custom fields)
17+
- Example demonstrating export workflow in `examples/export/export_example.py`
18+
- Full test suite in `tests/test_export.py`
19+
- No additional dependencies required (uses only Python standard library)
20+
1021
## [1.0.0] - 2025-01-09
1122

1223
### Added

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,33 @@ a good place to start) and then try creating your own experiment.
2020

2121
The documentation is available on [Read The Docs](http://neat-python.readthedocs.io).
2222

23+
## Network Export ##
24+
25+
neat-python supports exporting trained networks to a JSON format that is framework-agnostic and human-readable. This allows you to:
26+
27+
- Convert networks to other formats (ONNX, TensorFlow, PyTorch, etc.) using third-party tools
28+
- Inspect and debug network structure
29+
- Share networks across platforms and languages
30+
- Archive trained networks independently of neat-python
31+
32+
Example:
33+
```python
34+
import neat
35+
from neat.export import export_network_json
36+
37+
# After training...
38+
winner_net = neat.nn.FeedForwardNetwork.create(winner, config)
39+
40+
# Export to JSON
41+
export_network_json(
42+
winner_net,
43+
filepath='my_network.json',
44+
metadata={'fitness': winner.fitness, 'generation': 42}
45+
)
46+
```
47+
48+
See [`docs/network-json-format.md`](docs/network-json-format.md) for complete format documentation and guidance for creating converters to other frameworks.
49+
2350
## Citing ##
2451

2552
Here are APA and Bibtex entries you can use to cite this project in a publication. The listed authors are the originators

0 commit comments

Comments
 (0)