Skip to content

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 7 commits into from
Jul 22, 2025

Conversation

KennethEnevoldsen
Copy link
Contributor

  • Added tests
  • Added utility interfaces for examining the cache
  •  Added load_results
  • 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

ResultCache().load_result(**kwargs)

Deprecating leads to less breaking changes.

Minor:

  • removed results/ from .gitignore

- [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
@KennethEnevoldsen KennethEnevoldsen requested a review from Copilot July 8, 2025 13:21
Copilot

This comment was marked as resolved.

@isaac-chung
Copy link
Collaborator

Seems like there are some test failures. I can do a full review tomorrow.

Copy link
Collaborator

@isaac-chung isaac-chung left a 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.

@KennethEnevoldsen KennethEnevoldsen merged commit a2ba40c into v2.0.0 Jul 22, 2025
8 checks passed
@KennethEnevoldsen KennethEnevoldsen deleted the fix-load-results-for-cache branch July 22, 2025 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants