gavindiaz/optimiz-rs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: enhance ReadTheDocs with visualization outputs and GitHub links

Browse Source
This commit is contained in:
Melvin Alvarez
2026-02-16 16:42:24 +01:00
parent 525015525b
commit 50a4313d5a
7 changed files with 64 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/benchmarks.md
+2 -2
View File
@@ -11,8 +11,8 @@ These results come from the Rust backends (release build) versus SciPy’s `diff
**How to reproduce**
- Run `examples/notebooks/05_performance_benchmarks.ipynb` (validated in CI) to regenerate figures and raw CSV metrics.
- Or from the repo root, run `make benchmark` for the Rust-side microbenchmarks (no Python overhead).
- Run [`examples/notebooks/05_performance_benchmarks.ipynb`](https://github.com/ThotDjehuty/optimiz-r/blob/main/examples/notebooks/05_performance_benchmarks.ipynb) (validated in CI) to regenerate figures and raw CSV metrics.
- Or from the [repo root](https://github.com/ThotDjehuty/optimiz-r), run `make benchmark` for the Rust-side microbenchmarks (no Python overhead).
- To compare against SciPy, set `SCIPY_BASELINE=1` in the notebook; it records wall-clock times and success percentages side by side.
**What the notebook plots**