Skip to content

Commit b080613

Browse files
docs: README with measured benchmarks, reference table, Φ-kernel frontier plot, pinned Python deps
1 parent aa2d34c commit b080613

6 files changed

Lines changed: 4887 additions & 12 deletions

File tree

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/target
22
/Cargo.lock
33
/*.csv
4-
/phi_frontier.*
54
__pycache__/
65
*.pyc
76
/.venv/

README.md

Lines changed: 198 additions & 0 deletions
Large diffs are not rendered by default.

bench/python/requirements.txt

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
1-
# The Python comparison tools. Pin the *resolved* versions here after the
2-
# benchmark venv install — placeholders below until the Crucible run fills them.
3-
# Set up with: python3 -m venv ~/jackal-bench-venv
4-
# ~/jackal-bench-venv/bin/pip install py_vollib py_vollib_vectorized QuantLib matplotlib
5-
# ~/jackal-bench-venv/bin/pip freeze | grep -iE 'py.vollib|QuantLib|numpy|scipy|pandas|numba|matplotlib' > bench/python/requirements.txt
1+
# The Python comparison tools — resolved versions, pinned from the benchmark
2+
# venv on the Crucible run (AMD Ryzen 9 9950X box), 2026-05-12. Reproduce with:
3+
# python3 -m venv .venv
4+
# .venv/bin/pip install -r bench/python/requirements.txt
5+
# taskset -c 0 .venv/bin/python bench/python/bench.py data.csv
6+
# (data.csv is written by `cargo run --release --bin bench -- --csv data.csv`.)
67
#
7-
# (py_vollib pulls py_lets_be_rational, which is Jäckel's LetsBeRational.cpp —
8-
# the reference implementation jackal's accuracy is reported against.)
9-
py_vollib
10-
py_vollib_vectorized
11-
QuantLib
12-
matplotlib
8+
# py_vollib pulls py_lets_be_rational, which is Jäckel's LetsBeRational.cpp —
9+
# the reference implementation jackal's accuracy is reported against.
10+
py_vollib==1.0.7
11+
py_lets_be_rational==1.0.1
12+
py-vollib-vectorized==0.1.1
13+
QuantLib==1.42.1
14+
numpy==1.26.4
15+
scipy==1.17.1
16+
pandas==2.3.3
17+
numba==0.65.1
18+
llvmlite==0.47.0
19+
matplotlib==3.10.9

phi_frontier.png

110 KB
Loading

0 commit comments

Comments
 (0)