Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (32 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

40 lines (32 loc) · 1.01 KB

Contributing

Local development

python -m pip install maturin
python -m pip install -e .[dev]
python -m maturin develop --release

Verification

cargo test --release
pytest -q
cargo check --no-default-features --features openblas-static
cargo bench --bench core_bench

Benchmark workflow

python scripts/benchmark_suite.py \
  --output-dir .artifacts/benchmark-suite \
  --baseline-python .artifacts/clostera-baseline/.artifacts/venv-baseline313/bin/python \
  --original-python "$(which python)" \
  --enhanced-python "$(which python)" \
  --blas-threads 1 \
  --omp-threads 1 \
  --rayon-threads 24 \
  --rotation-batch-mib 32

Release workflow

  1. Update benchmark artifacts if the public performance story changed.
  2. Ensure README.md and benchmarks/results/*.json agree with the current implementation.
  3. Tag the release as vX.Y.Z.
  4. Push the tag to trigger .github/workflows/release.yml.
  5. Verify the uploaded GitHub release artifacts and the published PyPI files.