Skip to content

Implement ROADMAP Phase 5: code hygiene, bump to v0.5.0 #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gvonness-apolitical merged 3 commits into from
Mar 14, 2026
Merged

Implement ROADMAP Phase 5: code hygiene, bump to v0.5.0 #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7dfacfe
Implement ROADMAP.md Phase 5: code hygiene
gvonness-apolitical Mar 14, 2026
7b8ed2a
Bump to v0.5.0, remove completed ROADMAP, update docs
gvonness-apolitical Mar 14, 2026
0388484
Remove completed CLEANUP_PLAN.md
gvonness-apolitical Mar 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.5.0] - 2026-03-14

### Added

- **GPU cast safety audit**: SAFETY comments on all `as u32` casts in GPU paths (`mod.rs`, `cuda_backend.rs`, `wgpu_backend.rs`, `stde_gpu.rs`). Added `debug_assert!` guards on user-provided direction/batch counts in `stde_gpu.rs`.
- **`#[must_use]` annotations**: 19 pure functions now carry `#[must_use]` (support module helpers, GPU codegen, solver wrappers, `Laurent::zero`/`one`).
- **`#![warn(missing_docs)]`**: enabled crate-wide. All public items — 35 `OpCode` variants, ~190 elemental methods across `Dual`, `DualVec`, `Taylor`, `TaylorDyn`, `Laurent`, struct fields, and trait methods — now have doc comments.

### Changed

- **Test decomposition**: split `tests/stde.rs` (1630 lines, 76 tests) into 5 focused files: `stde_core`, `stde_stats`, `stde_pipeline`, `stde_higher_order`, `stde_dense`. All 76 tests preserved.
- Removed `ROADMAP.md` — all phases (0–5) complete.

## [0.4.1] - 2026-03-14

### Fixed
Expand Down Expand Up @@ -184,7 +197,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Forward-vs-reverse cross-validation on Rosenbrock, Beale, Ackley, Booth, and more
- Criterion benchmarks for forward overhead and reverse gradient

[Unreleased]: https://github.com/Entrolution/echidna/compare/v0.4.1...HEAD
[Unreleased]: https://github.com/Entrolution/echidna/compare/v0.5.0...HEAD
[0.5.0]: https://github.com/Entrolution/echidna/compare/v0.4.1...v0.5.0
[0.4.1]: https://github.com/Entrolution/echidna/compare/v0.4.0...v0.4.1
[0.4.0]: https://github.com/Entrolution/echidna/compare/v0.3.0...v0.4.0
[0.3.0]: https://github.com/Entrolution/echidna/compare/v0.2.0...v0.3.0
Expand Down
199 changes: 0 additions & 199 deletions CLEANUP_PLAN.md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ members = [".", "echidna-optim"]

[package]
name = "echidna"
version = "0.4.1"
version = "0.5.0"
edition = "2021"
rust-version = "1.93"
description = "A high-performance automatic differentiation library for Rust"
Expand Down
Loading
Loading