From 06742dfc7f9dd03ba68f65fe85cfa247b68e53e1 Mon Sep 17 00:00:00 2001 From: ayush1298 Date: Sun, 11 May 2025 00:32:36 +0530 Subject: [PATCH] Correction in docs --- docs/adding_a_benchmark.md | 2 +- docs/adding_a_model.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/adding_a_benchmark.md b/docs/adding_a_benchmark.md index 7da178bbb3..1a444ee59f 100644 --- a/docs/adding_a_benchmark.md +++ b/docs/adding_a_benchmark.md @@ -3,5 +3,5 @@ The MTEB Leaderboard is available [here](https://huggingface.co/spaces/mteb/leaderboard) and we encourage additions of new benchmarks. To add a new benchmark: 1. Add your benchmark to [benchmark.py](../mteb/benchmarks/benchmarks.py) as a `Benchmark` object, and select the MTEB tasks that will be in the benchmark. If some of the tasks do not exist in MTEB, follow the "add a dataset" instructions to add them. -2. Open a PR at https://github.com/embedding-benchmark/results with results of models on your benchmark. +2. Open a PR at https://github.com/embeddings-benchmark/results with results of models on your benchmark. 3. When PRs are merged, your benchmark will be added to the leaderboard automatically after the next workflow trigger. diff --git a/docs/adding_a_model.md b/docs/adding_a_model.md index b9e39ce436..36b5718fda 100644 --- a/docs/adding_a_model.md +++ b/docs/adding_a_model.md @@ -139,6 +139,7 @@ If your are adding a model that requires additional dependencies, you can add th In the [voyage_models.py](../mteb/models/voyage_models.py) file, we have added the following code: ```python +from mteb.requires_package import requires_package requires_package(self, "voyageai", model_name, "pip install 'mteb[voyageai]'") ``` and also updated [pyproject.toml]((../pyproject.toml)) file with the following code: