Skip to content

Rework README around benchmark evidence#1

Merged
ponythewhite merged 33 commits intomainfrom
benchmark-readme-1.0.5
May 4, 2026
Merged

Rework README around benchmark evidence#1
ponythewhite merged 33 commits intomainfrom
benchmark-readme-1.0.5

Conversation

@ponythewhite
Copy link
Copy Markdown
Contributor

Summary

  • Rewrites README.md around auditable benchmark evidence, explicit API contract, auto selector behavior, hardware/runtime settings, dataset matrix, FAISS settings, timeout/pruning policy, and reproduction commands.
  • Adds raw real/ANN/synthetic benchmark JSON snapshots plus generated README summary CSVs.
  • Tightens two static auto selector guardrails so completed measured auto rows stay within the documented 2.5% quality window.
  • Bumps package version to 1.0.5 and removes standalone Markdown docs so only README.md and CONTRIBUTING.md remain.

Verification

  • python scripts/summarize_benchmark_evidence.py
  • python -m pytest -q
  • python -m py_compile scripts/summarize_benchmark_evidence.py
  • cargo check --no-default-features --features python
  • cargo test --no-default-features --features python
  • git diff --cached --check before commit

@ponythewhite ponythewhite merged commit fd4a19c into main May 4, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant