Skip to content

Fix typos #1722

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.

Sign up for GitHub

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
Samoed merged 1 commit into from
Jan 8, 2025
Merged

Fix typos #1722

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/adding_a_model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ These will save the results in a folder called `results/{model_name}/{model_revi

2. **Push Results to the Leaderboard**

To add results to the public leaderboard you can push your results to the [results repository](https://github.com/embeddings-benchmark/results) afterwards they will appear on the leaderboard after a day.
To add results to the public leaderboard you can push your results to the [results repository](https://github.com/embeddings-benchmark/results) via a PR. Once merged they will appear on the leaderboard after a day.


3. (Optional) **Add the results using to the model card:**
3. (Optional) **Add results to the model card:**

`mteb` implements a cli for adding results to the model card:

Expand All @@ -49,7 +49,7 @@ If the readme already exists:
mteb create_meta --results_folder results/{model_name}/{model_revision} --output_path model_card.md --from_existing your_existing_readme.md
```

Note that if you can run the model on many tasks, this can lead to an excessively large readme frontmatter.
Note that running the model on many tasks may lead to a huge readme front matter.

4. **Wait for a refresh the leaderboard:**

Expand All @@ -70,4 +70,4 @@ The leaderboard [automatically refreshes daily](https://github.com/embeddings-be

###### Instantiating the Model with Prompts

If you are unable to directly add the prompts in the model configuration, you can instantiate the model using the `sentence_transformers_loader` and pass `prompts` as an argument. For more details, see the `mteb/models/bge_models.py` file.
If you are unable to directly add the prompts in the model configuration, you can instantiate the model using the `sentence_transformers_loader` and pass `prompts` as an argument. For more details, see the `mteb/models/bge_models.py` file.
Loading