diff --git a/docs/adding_a_dataset.md b/docs/adding_a_dataset.md index 5e02d0b0d7..6df514c514 100644 --- a/docs/adding_a_dataset.md +++ b/docs/adding_a_dataset.md @@ -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.