Commit dd77e3f
docs: sweep em/en dashes in README and LLM_PROVIDERS, add reranker-eval note (#172)
* docs: sweep em/en dashes in README and LLM_PROVIDERS, add reranker-eval note
- README.md: replace two en-dashes in the env-var table with `--` so the public-doc
em-dash gate passes; add a brief evaluation note for the cross-encoder reranker
knob (now reachable via MemoryEngine.create(rerank_model=...)) and document the
measured ~15ms per-query cost on the bundled retrieval gates
- docs/LLM_PROVIDERS.md: replace one em-dash in the Windows note with `--`
These are the only doc changes shipped in this round; the rest of the work is in
PR1 (core + MCP + integration).
* fix(docs): replace unverified reranker benchmark with reproduction pointer
The previous paragraph quoted model-specific MRR@5 / hit@5 / ~15 ms numbers
for the optional cross-encoder reranker without identifying the model,
revision, hardware, exact command, or evidence artifact. Per AGENTS.md
L177-L178 ("Prove 'better' with a number. No retrieval/quality claim ships
without an eval."), such numbers must not ship until the evidence is
registered.
The README now contains a short note that reranker benchmarks are
intentionally unpublished and points operators at the local reproduction
commands (`python -m eval.ablation`, `python -m eval.reinforcement`).
Co-authored-by: CommandCodeBot <noreply@commandcode.ai>
* fix(docs): drop the last em-dash so the public-docs gate is green
PR #172 introduced a single em-dash on README.md:751 inside the new
reranker-eval blockquote. The repo's no-em-dashes-in-public-docs policy
(tests/test_benchmark_evidence.py::test_public_facing_docs_do_not_use_em_dashes)
blocks on every Python matrix plus the core floor and coverage gate jobs.
Replace U+2014 with --, mirroring the convention used elsewhere in the
same blockquote.
* docs: correct ablation benchmark description
---------
Co-authored-by: CommandCodeBot <noreply@commandcode.ai>1 parent a74edeb commit dd77e3f
2 files changed
Lines changed: 18 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
721 | 721 | | |
722 | 722 | | |
723 | 723 | | |
724 | | - | |
725 | | - | |
| 724 | + | |
| 725 | + | |
726 | 726 | | |
727 | 727 | | |
728 | 728 | | |
| |||
747 | 747 | | |
748 | 748 | | |
749 | 749 | | |
| 750 | + | |
| 751 | + | |
| 752 | + | |
| 753 | + | |
| 754 | + | |
| 755 | + | |
750 | 756 | | |
751 | 757 | | |
752 | 758 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
223 | 223 | | |
224 | 224 | | |
225 | 225 | | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
226 | 233 | | |
227 | 234 | | |
228 | 235 | | |
| |||
244 | 251 | | |
245 | 252 | | |
246 | 253 | | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
247 | 257 | | |
248 | 258 | | |
249 | 259 | | |
| |||
0 commit comments