Skip to content

Commit dd77e3f

Browse files
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

File tree

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -721,8 +721,8 @@ file. It never searches the working directory for `.env`, and explicit process v
721721
| `ENGRAPHIS_ALLOW_AUTOMATIC_CRITICAL_RETENTION` | `false` | Opt in only when an LLM supervisor may automatically assign the long-lived `critical` class; explicit user-selected critical retention is unaffected |
722722
| `ENGRAPHIS_WHISPER_MODEL` | Not set | Enables local faster-whisper audio/video transcription |
723723
| `ENGRAPHIS_POSTGRES_DSN` | Not set | CLI-only PostgreSQL source; used for the connection and never stored |
724-
| `ENGRAPHIS_POSTGRES_CONNECT_TIMEOUT` | `10` | PostgreSQL introspection connection timeout in seconds (bounded to 1120) |
725-
| `ENGRAPHIS_POSTGRES_STATEMENT_TIMEOUT_MS` | `30000` | Per-introspection PostgreSQL statement timeout in milliseconds (bounded to 1300000) |
724+
| `ENGRAPHIS_POSTGRES_CONNECT_TIMEOUT` | `10` | PostgreSQL introspection connection timeout in seconds (bounded to 1--120) |
725+
| `ENGRAPHIS_POSTGRES_STATEMENT_TIMEOUT_MS` | `30000` | Per-introspection PostgreSQL statement timeout in milliseconds (bounded to 1--300000) |
726726
| `ENGRAPHIS_GRAPH_TOKEN` | Not set | Bearer token for `engraphis-graph-server`; required off-loopback |
727727
| `ENGRAPHIS_GRAPH_HOST` / `ENGRAPHIS_GRAPH_PORT` | `127.0.0.1` / `8720` | Read-only graph/recall server bind address |
728728
| `ENGRAPHIS_LLM_PROVIDER` | `openai` | `openai \| anthropic \| google \| openrouter \| custom` |
@@ -747,6 +747,12 @@ See `.env.example` for the full variable inventory. Supply those values through
747747
environment or the trusted config file above; copying it to an arbitrary `./.env` does not make
748748
Engraphis load it.
749749

750+
> **Ablation fixture:** `python -m eval.ablation` is an offline deterministic check that prints
751+
> `recall@5` comparisons for vector-only and hybrid retrieval, multi-hop graph arms, and
752+
> retrieval policies, plus ordinary-recall age and semantic-confidence checks. It does not
753+
> produce MRR, hit@5, or ms/query results. Use `python -m eval.reinforcement` for retention
754+
> trajectories, and register evidence before quoting any benchmark results.
755+
750756
---
751757

752758
## Project structure

docs/LLM_PROVIDERS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,13 @@ server, replacing the path with the one from initialization:
223223
cmd mcp add --scope local --env ENGRAPHIS_DB_PATH=/absolute/path/to/engraphis.db engraphis -- engraphis-mcp
224224
```
225225

226+
Windows: `cmd` may resolve to `cmd.exe` (the built-in Windows command interpreter)
227+
instead of the Command Code CLI. If `cmd mcp list` opens a Windows command-prompt window or
228+
prints `'mcp' is not recognized`, the wrong `cmd` was found on `PATH`. Run `where cmd` and
229+
ensure the Command Code CLI's install directory appears before `C:\Windows\System32`;
230+
otherwise invoke the CLI by its absolute path (e.g.
231+
`C:\Users\you\AppData\Roaming\Python\Scripts\cmd.exe`).
232+
226233
All Command Code options precede the server name, and `--` separates the name from the stdio
227234
command. `engraphis-mcp` runs locally over stdio; normal local use needs no HTTP endpoint or
228235
Engraphis API key.
@@ -244,6 +251,9 @@ cmd mcp list
244251
cmd mcp get engraphis
245252
```
246253

254+
(If these commands open a Windows command prompt instead of listing MCP servers, follow the
255+
Windows note above -- `cmd` resolved to `cmd.exe`.)
256+
247257
Start a normal Command Code session with `cmd`, open `/mcp`, and confirm that `engraphis` is
248258
connected and exposes tools. Then ask Command Code: "Call `engraphis_stats` and show me the
249259
result." A response with memory counts confirms the end-to-end connection.

0 commit comments

Comments
 (0)