-
Notifications
You must be signed in to change notification settings - Fork 445
fix: Add docs and .load_results to ResultsCache #2833
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
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
- [x] Added tests - [x] Added utility interfaces for examining the cache - [x] Added load_results - [x] Updated docs to use ResultsCache instead We could also update the leaderboard to use ResultCache, but I don't want to do that in this PR. When that is done I would probably depracate `mteb.load_results` or convert it to a shorthand function for ```py ResultCache().load_result(**kwargs) ``` Deprecating leads to less breaking changes. Minor: - removed `results/` from .gitignore
Seems like there are some test failures. I can do a full review tomorrow. |
Samoed
approved these changes
Jul 9, 2025
isaac-chung
approved these changes
Jul 9, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Mostly just cosmetic and doc/example related comments and some suggestions.
Co-authored-by: Isaac Chung <[email protected]>
Samoed
approved these changes
Jul 14, 2025
...s__all-MiniLM-L6-v2-dummy/8b3219a92973c328a8e22fadcfa821b5dc75636a/BornholmBitextMining.json
Outdated
Show resolved
Hide resolved
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.
We could also update the leaderboard to use ResultCache, but I don't want to do that in this PR. When that is done I would probably depracate
mteb.load_results
or convert it to a shorthand function forDeprecating leads to less breaking changes.
Minor:
results/
from .gitignore