Feature: Added script for generating and saving a local leaderboard #2015
+151
−0
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.
Description
Added a script to create and save a leaderboard locally for a given benchmark as discussed in #2011.
The script retrieves results, parses them to a Pandas DF, prints them, and (optionally) saves them to a CSV. It uses the same functionality used for generating the live leaderboard. This makes it much easier to generate results locally and check aggregate scores before submitting them to MTEB.
Usage
The script can be used as follows:
python scripts/make_leaderboard --benchmark "MTEB(eng)" --save-path "leaderboard_results"
Optionally, a custom results repo can be used (default is https://github.com/embeddings-benchmark/results), and specific models can be requested, for example:
python scripts/make_leaderboard --benchmark "MTEB(eng)" --results_repo "https://github.com/Pringled/mteb-results" --models "potion-base-8M" --save-path "results"
Code Quality
make lint
to maintain consistent style.