Repository navigation
docs(bench): add an 'Adding a benchmark case' guide - #51
Closed
wufangyong973 wants to merge 1 commit into
Closed
wufangyong973 wants to merge 1 commit into
wufangyong973 wants to merge 1 commit into
Conversation
Signed-off-by: wfy18 <wfy18056200731@163.com>
|
@wufangyong973 is attempting to deploy a commit to the vignesh's projects Team on Vercel. A member of the Team first needs to authorize it. |
Owner
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #39.
bench/README.mdexplained what the benchmark does but not how to add acase, even though the project's standing rule is to measure retrieval
changes before merging and to keep a change only if the numbers support
it.
Adds an "Adding a benchmark case" section covering:
bench/datasets/repo-memory.json),with concrete examples of a memory entry and a query entry, plus the
recency-order and no-write-path-inference constraints that keep the
numbers honest;
npm run bench(with--verboseto see every miss) and whichof the two reported tables is the retrieval-quality number;
npm run bench:checkworks (fails on drift, does not write) andwhen to update the committed snapshot in
bench/results/.Docs-only, 92 lines added to one file.