Skip to content

docs: Update adding_a_dataset.md #2947

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
KennethEnevoldsen merged 2 commits into from
Jul 25, 2025
Merged

docs: Update adding_a_dataset.md #2947

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4863ed
docs: Update adding_a_dataset.md
KennethEnevoldsen Jul 24, 2025
8233e31
Update docs/adding_a_dataset.md
KennethEnevoldsen Jul 24, 2025
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
12 changes: 6 additions & 6 deletions docs/adding_a_dataset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,13 +242,13 @@ Before you commit, here is a checklist you should complete before submitting:

An easy way to test it is using:
```python
from mteb import MTEB, get_model
import mteb
# sample model:
model = mteb.get_model("sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2")

# Define the sentence-transformers model name
model_name = "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2"

model = get_model(model_name)
evaluation = MTEB(tasks=[YourNewTask()])
task = mteb.get_task("{name of your task}")
evaluation = mteb.MTEB(tasks=[task])
evaluation.run(model)
```

- [ ] I have run the following models on the task (adding the results to the pr). These can be run using the `mteb run -m {model_name} -t {task_name}` command.
Expand Down