Skip to content

Commit ab8805c

Browse files
authored
Fix: typos in adding a model (embeddings-benchmark#1722)
1 parent 25f4f61 commit ab8805c

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/adding_a_model.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ These will save the results in a folder called `results/{model_name}/{model_revi
3030

3131
2. **Push Results to the Leaderboard**
3232

33-
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.
33+
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.
3434

3535

36-
3. (Optional) **Add the results using to the model card:**
36+
3. (Optional) **Add results to the model card:**
3737

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

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

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

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

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

7171
###### Instantiating the Model with Prompts
7272

73-
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.
73+
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.

0 commit comments

Comments
 (0)