docs: add "What is ordinal retrieval" framing to README#245
Conversation
Add a top-level conceptual frame above "## Benchmark at a glance" so the README reads define-the-idea -> prove-it. It previously jumped straight from "what the crate is" to the benchmark without ever stating the idea; this states what ordinal retrieval is (the index operates on order/sign quotients of embedding coordinates rather than metric magnitudes; training-free compression, quotient-aware candidate generation, asymmetric rerank) right before the benchmark evidence. The "matches dense qrel quality at much smaller storage" line restates the existing in-repo BEIR result (the hero claim immediately below it), not a new or paper number. Signed-off-by: Nelson Spence <nelson@projectnavi.ai>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
PR Summary by QodoDocs: add "What is ordinal retrieval" framing near top of README Description
High-Level Assessment
Files changed (1)
|
Code Review by Qodo🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)
Great, no issues found!Qodo reviewed your code and found no material issues that require reviewⓘ You are approaching your monthly quota for Qodo. Upgrade your plan |
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to include a new section explaining the concept of ordinal retrieval. The review feedback suggests minor improvements to this section, specifically adding a question mark to the new heading for grammatical completeness and replacing 'order/sign' with 'ordinal and sign' to maintain consistency with the rest of the document.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
gemini review nit (PR #245): the heading is phrased as a question, so the trailing ? is grammatically correct. Signed-off-by: Nelson Spence <nelson@projectnavi.ai>
What
Adds a
## What is ordinal retrievalsection near the top of the README, above## Benchmark at a glance.The README previously jumped straight from what the crate is to the benchmark without ever stating the underlying idea. This supplies that frame, so the top now reads tagline → what the crate is → what the idea is → proof.
Content
Notes
Test plan