nir-rs 0.4.2

Pure-Rust implementation of the Neuromorphic Intermediate Representation (NIR) — the standard interchange format for spiking neural networks.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

# Changelog

All notable changes to this project are documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
for the **0.x** series as described under [Versioning](#versioning) below.

## [Unreleased]

### Documentation

- Cite the NIR Nature Communications paper (BibTeX + `CITATION.cff`) and credit
  Telluride 2023 acknowledgements from upstream neuromorphs/NIR.

## [0.4.2] - 2026-08-13

Docs-only patch so crates.io serves a consumer-facing README (0.4.1 is
immutable on the registry).

### Changed

- `package.rust-version` raised **1.85.1 → 1.97.1** to match the supported CI /
  `rust-toolchain.toml` pin (stop advertising an untested older floor).

### Documentation

- Rewrite README for public consumers: drop internal sibling-crate roadmap,
  Linear tracking, and CI-only Hub variable language; keep crates.io/docs.rs
  install path, GHCR pulls, and scope clear without org-private context.
- Align crate rustdoc non-goals and a few comments with the same public wording.
- Bump advertised install / Docker tags to **0.4.2**.
- Toolchain docs: single **1.97.1** pin (no separate MSRV floor story).

## [0.4.1] - 2026-08-12

First **crates.io** release of the 0.4 line (package name `nir-rs`).

### Added

- Multi-OS CI: default and HDF5 tests on Linux, macOS, and Windows (#27, #32).
- Package workflow: `cargo package` artifact checks + public-API semver gate vs
  git tag `v0.4.0` (#28, #33).
- Compatibility matrix and changelog policy (#31).
- Expanded real-world fixture corpus: Rockpool LIF + noBias braille variants,
  `MANIFEST.toml`, coverage checklist (#29).
- Property tests (`proptest`) for tensor/graph/wire invariants and HDF5
  write→read; optional `cargo-fuzz` harnesses under `fuzz/` (#30).
- Docker image + dual publish to **GHCR** (`ghcr.io/limen-neural/nir-rs`) and
  **Docker Hub** (`$DOCKER_USER/nir-rs`); PR verify / main+tag push (#26).

### Documentation

- README crates.io / docs.rs badges and dependency snippets (#26).
- README Docker (GHCR + Hub) install/run notes (#26).
- [TESTING.md](TESTING.md) for property tests and local fuzz invocation.

## [0.4.0] - 2026-08-06

First **git-tagged** library release (`tag = "v0.4.0"`). Superseded as the
crates.io baseline by **0.4.1**.

### Added

- Typed NIR graph model and wire-accurate node types.
- Opt-in HDF5 `.nir` read/write (`hdf5` feature, `hdf5-metno`).
- Opt-in `serde` feature for graph/debug export.
- Vendored real-world fixtures under `tests/fixtures/` for wire compatibility.
- Example `load_inspect_lif` (requires `hdf5`).

### Toolchain

- `package.rust-version = "1.85.1"` (cargo floor).
- Dev / CI pin **Rust 1.97.1**.

## Versioning

| Change class | Version impact (0.x) |
|--------------|----------------------|
| Bug fix, docs, CI, non-public refactors | Patch (`0.4.y`) |
| Additive public API | Prefer patch if compatible; minor if the surface is large |
| Breaking public API | **Minor** (`0.5.0`), never a silent patch |
| Org-only consumer wiring | Does not change crate semver |

Deliberate breaks must update `package.version`, changelog, and the package
workflow baseline (`baseline-rev` / crates.io version) once accepted. Do not
disable the semver job to force green CI.

## Compatibility

See [COMPATIBILITY.md](COMPATIBILITY.md) for the release ↔ upstream NIR matrix,
fidelity semantics, and feature availability.