add_new_model/README.md

How to add a new model to the Leaderboard

Here we are going to explain how to add a new model to the Leaderboard. The next steps must be followed:

1. Git clone this repository and cd add_new_model.
2. Perform evaluation of the new model using MTEB library. That will give you a folder as result. Example: sentence-t5-large is the folder name when evaluating sentence-transformers/sentence-t5-large.
3. Once evaluated, move that folder to this folder, so it will be inside add_new_model folder.
4. Execute the file MTEB_metadata_to_yaml.py. That will create a file named mteb_medadata.yaml that contains the metadata regarding your evaluation.
5. Execute the file add_new_model.py. That file will add your model to the Leaderboard.
6. Add, commit and git push the changes without uploading the results and the mteb_metadata.yaml.
7. It is recommended to launch the app by running python3 app.py from parent folder, and confirm that there are no errors in the leaderboard and we are uploading it as we wanted.