fix: Added docs for mteb.evaluate
#2831
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
- renamed `mteb.run_tasks` to `mteb.evaluate`. Reverting this is fairly easy but I think the rename makes a lot of sense - Added docs to most places - some aren't changed yet as they haven't been tested (#2830) - I didn't change the datasheet to avoid confusion with uploaded datasets partly fixes: #2793
…into docs-for-run-tasks
|
Renaming is fine, but for when we revisit this months down the road, would you mind noting why renaming is needed? Also what is left to do in #2793? |
The new name was primarily chosen because ChatGPT and Claude kept suggesting It also makes the order of the tasks and models clearer, I think. Evaluate model on task. Where, and run_task doesn't provide the same intuition.
I found a few cases where |
isaac-chung
approved these changes
Jun 22, 2025
Co-authored-by: Isaac Chung <chungisaac1217@gmail.com>
Co-authored-by: Isaac Chung <chungisaac1217@gmail.com>
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.
mteb.run_taskstomteb.evaluate. Reverting this is fairly easy but I think the rename makes a lot of sensemteb.run_tasksis fully MTEB compatible #2830)partly fixes: #2793
If you add a model or a dataset, please add the corresponding checklist: