| Name | mteb JSON |
| Version |
1.36.26
JSON |
| download |
| home_page | None |
| Summary | Massive Text Embedding Benchmark |
| upload_time | 2025-03-18 21:38:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.9 |
| license | Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
|
| keywords |
deep learning
text embeddings
benchmark
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center">Massive Text Embedding Benchmark</h1>
<p align="center">
<a href="https://github.com/embeddings-benchmark/mteb/releases">
<img alt="GitHub release" src="https://img.shields.io/github/release/embeddings-benchmark/mteb.svg">
</a>
<a href="https://arxiv.org/abs/2210.07316">
<img alt="GitHub release" src="https://img.shields.io/badge/arXiv-2305.14251-b31b1b.svg">
</a>
<a href="https://github.com/embeddings-benchmark/mteb/blob/master/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/embeddings-benchmark/mteb.svg?color=green">
</a>
<a href="https://pepy.tech/project/mteb">
<img alt="Downloads" src="https://static.pepy.tech/personalized-badge/mteb?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads">
</a>
</p>
<h4 align="center">
<p>
<a href="#installation">Installation</a> |
<a href="#usage-documentation">Usage</a> |
<a href="https://huggingface.co/spaces/mteb/leaderboard">Leaderboard</a> |
<a href="#documentation">Documentation</a> |
<a href="#citing">Citing</a>
<p>
</h4>
<h3 align="center">
<a href="https://huggingface.co/spaces/mteb/leaderboard"><img style="float: middle; padding: 10px 10px 10px 10px;" width="60" height="55" src="./docs/images/hf_logo.png" /></a>
</h3>
## Installation
```bash
pip install mteb
```
## Example Usage
* Using a Python script:
```python
import mteb
from sentence_transformers import SentenceTransformer
# Define the sentence-transformers model name
model_name = "average_word_embeddings_komninos"
model = mteb.get_model(model_name) # if the model is not implemented in MTEB it will be eq. to SentenceTransformer(model_name)
tasks = mteb.get_tasks(tasks=["Banking77Classification"])
evaluation = mteb.MTEB(tasks=tasks)
results = evaluation.run(model, output_folder=f"results/{model_name}")
```
<details>
<summary> Running SentenceTransformer model with prompts </summary>
Prompts can be passed to the SentenceTransformer model using the `prompts` parameter. The following code shows how to use prompts with SentenceTransformer:
```python
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("average_word_embeddings_komninos", prompts={"query": "Query:", "passage": "Passage:"})
evaluation = mteb.MTEB(tasks=tasks)
```
In prompts the key can be:
1. Prompt types (`passage`, `query`) - they will be used in reranking and retrieval tasks
2. Task type - these prompts will be used in all tasks of the given type
1. `BitextMining`
2. `Classification`
3. `MultilabelClassification`
4. `Clustering`
5. `PairClassification`
6. `Reranking`
7. `Retrieval`
8. `STS`
9. `Summarization`
10. `InstructionRetrieval`
3. Pair of task type and prompt type like `Retrival-query` - these prompts will be used in all classification tasks
4. Task name - these prompts will be used in the specific task
5. Pair of task name and prompt type like `NFCorpus-query` - these prompts will be used in the specific task
</details>
* Using CLI
```bash
mteb available_tasks
mteb run -m sentence-transformers/all-MiniLM-L6-v2 \
-t Banking77Classification \
--verbosity 3
# if nothing is specified default to saving the results in the results/{model_name} folder
```
* Using multiple GPUs in parallel can be done by just having a custom encode function that distributes the inputs to multiple GPUs like e.g. [here](https://github.com/microsoft/unilm/blob/b60c741f746877293bb85eed6806736fc8fa0ffd/e5/mteb_eval.py#L60) or [here](https://github.com/ContextualAI/gritlm/blob/09d8630f0c95ac6a456354bcb6f964d7b9b6a609/gritlm/gritlm.py#L75).
## Usage Documentation
Click on each section below to see the details.
<br />
<details>
<summary> Task selection </summary>
### Task selection
Tasks can be selected by providing the list of datasets, but also
* by their task (e.g. "Clustering" or "Classification")
```python
tasks = mteb.get_tasks(task_types=["Clustering", "Retrieval"]) # Only select clustering and retrieval tasks
```
* by their categories e.g. "s2s" (sentence to sentence) or "p2p" (paragraph to paragraph)
```python
tasks = mteb.get_tasks(categories=["s2s", "p2p"]) # Only select sentence2sentence and paragraph2paragraph datasets
```
* by their languages
```python
tasks = mteb.get_tasks(languages=["eng", "deu"]) # Only select datasets which contain "eng" or "deu" (iso 639-3 codes)
```
You can also specify which languages to load for multilingual/cross-lingual tasks like below:
```python
import mteb
tasks = [
mteb.get_task("AmazonReviewsClassification", languages = ["eng", "fra"]),
mteb.get_task("BUCCBitextMining", languages = ["deu"]), # all subsets containing "deu"
]
# or you can select specific huggingface subsets like this:
from mteb.tasks import AmazonReviewsClassification, BUCCBitextMining
evaluation = mteb.MTEB(tasks=[
AmazonReviewsClassification(hf_subsets=["en", "fr"]) # Only load "en" and "fr" subsets of Amazon Reviews
BUCCBitextMining(hf_subsets=["de-en"]), # Only load "de-en" subset of BUCC
])
# for an example of a HF subset see "Subset" in the dataset viewer at: https://huggingface.co/datasets/mteb/bucc-bitext-mining
```
* by their modalities
```python
tasks = mteb.get_tasks(modalities=["text", "image"]) # Only select tasks with text or image modalities
```
You can also specify exclusive modality filtering to only get tasks with exactly the requested modalities (default behavior with exclusive_modality_filter=False):
```python
# Get tasks with text modality, this will also include tasks having both text and image modalities
tasks = mteb.get_tasks(modalities=["text"], exclusive_modality_filter=False)
# Get tasks that have ONLY text modality (no image or other modalities)
tasks = mteb.get_tasks(modalities=["text"], exclusive_modality_filter=True)
```
</details>
<details>
<summary> Running a benchmark </summary>
### Running a Benchmark
`mteb` comes with a set of predefined benchmarks. These can be fetched using `get_benchmark` and run in a similar fashion to other sets of tasks.
For instance to select the 56 English datasets that form the "Overall MTEB English leaderboard":
```python
import mteb
benchmark = mteb.get_benchmark("MTEB(eng, v1)")
evaluation = mteb.MTEB(tasks=benchmark)
```
The benchmark specified not only a list of tasks, but also what splits and language to run on. To get an overview of all available benchmarks simply run:
```python
import mteb
benchmarks = mteb.get_benchmarks()
```
Generally we use the naming scheme for benchmarks `MTEB(*)`, where the "*" denotes the target of the benchmark. In the case of a language, we use the three-letter language code. For large groups of languages, we use the group notation, e.g., `MTEB(Scandinavian, v1)` for Scandinavian languages. External benchmarks implemented in MTEB like `CoIR` use their original name. When using a benchmark from MTEB please cite `mteb` along with the citations of the benchmark which you can access using:
```python
benchmark.citation
```
</details>
<details>
<summary> Passing in `encode` arguments </summary>
### Passing in `encode` arguments
To pass in arguments to the model's `encode` function, you can use the encode keyword arguments (`encode_kwargs`):
```python
evaluation.run(model, encode_kwargs={"batch_size": 32})
```
</details>
<details>
<summary> Selecting evaluation split </summary>
### Selecting evaluation split
You can evaluate only on `test` splits of all tasks by doing the following:
```python
evaluation.run(model, eval_splits=["test"])
```
Note that the public leaderboard uses the test splits for all datasets except MSMARCO, where the "dev" split is used.
</details>
<details>
<summary> Selecting evaluation subset </summary>
### Selecting evaluation subset
You can evaluate only on selected subsets. For example, if you want to evaluate only the `subset_name_to_run` subset of all tasks, do the following:
```python
evaluation.run(model, eval_subsets=["subset_name_to_run"])
```
Monolingual tasks have `default` subset, other tasks have subsets that are specific to the dataset.
</details>
<details>
<summary> Using a custom model </summary>
### Using a custom model
Models should implement the following interface, implementing an `encode` function taking as inputs a list of sentences, and returning a list of embeddings (embeddings can be `np.array`, `torch.tensor`, etc.). For inspiration, you can look at the [mteb/mtebscripts repo](https://github.com/embeddings-benchmark/mtebscripts) used for running diverse models via SLURM scripts for the paper.
```python
import mteb
from mteb.encoder_interface import PromptType
import numpy as np
class CustomModel:
def encode(
self,
sentences: list[str],
task_name: str,
prompt_type: PromptType | None = None,
**kwargs,
) -> np.ndarray:
"""Encodes the given sentences using the encoder.
Args:
sentences: The sentences to encode.
task_name: The name of the task.
prompt_type: The prompt type to use.
**kwargs: Additional arguments to pass to the encoder.
Returns:
The encoded sentences.
"""
pass
model = CustomModel()
tasks = mteb.get_tasks(tasks=["Banking77Classification"])
evaluation = mteb.MTEB(tasks=tasks)
evaluation.run(model)
```
</details>
<details>
<summary> Evaluating on a custom dataset </summary>
### Evaluating on a custom dataset
To evaluate on a custom task, you can run the following code on your custom task. See [how to add a new task](docs/adding_a_dataset.md), for how to create a new task in MTEB.
```python
from mteb import MTEB
from mteb.abstasks.AbsTaskReranking import AbsTaskReranking
from sentence_transformers import SentenceTransformer
class MyCustomTask(AbsTaskReranking):
...
model = SentenceTransformer("average_word_embeddings_komninos")
evaluation = MTEB(tasks=[MyCustomTask()])
evaluation.run(model)
```
</details>
<details>
<summary> Using a cross encoder for reranking</summary>
### Using a cross encoder for reranking
To use a cross encoder for reranking, you can directly use a CrossEncoder from SentenceTransformers. The following code shows a two-stage run with the second stage reading results saved from the first stage.
```python
from mteb import MTEB
import mteb
from sentence_transformers import CrossEncoder, SentenceTransformer
cross_encoder = CrossEncoder("cross-encoder/ms-marco-TinyBERT-L-2-v2")
dual_encoder = SentenceTransformer("all-MiniLM-L6-v2")
tasks = mteb.get_tasks(tasks=["NFCorpus"], languages=["eng"])
subset = "default" # subset name used in the NFCorpus dataset
eval_splits = ["test"]
evaluation = MTEB(tasks=tasks)
evaluation.run(
dual_encoder,
eval_splits=eval_splits,
save_predictions=True,
output_folder="results/stage1",
)
evaluation.run(
cross_encoder,
eval_splits=eval_splits,
top_k=5,
save_predictions=True,
output_folder="results/stage2",
previous_results=f"results/stage1/NFCorpus_{subset}_predictions.json",
)
```
</details>
<details>
<summary> Late Interaction (ColBERT) </summary>
### Using Late Interaction models for retrieval
```python
from mteb import MTEB
import mteb
colbert = mteb.get_model("colbert-ir/colbertv2.0")
tasks = mteb.get_tasks(tasks=["NFCorpus"], languages=["eng"])
eval_splits = ["test"]
evaluation = MTEB(tasks=tasks)
evaluation.run(
colbert,
eval_splits=eval_splits,
corpus_chunk_size=500,
)
```
This implementation employs the MaxSim operation to compute the similarity between sentences. While MaxSim provides high-quality results, it processes a larger number of embeddings, potentially leading to increased resource usage. To manage resource consumption, consider lowering the `corpus_chunk_size` parameter.
</details>
<details>
<summary> Saving retrieval task predictions </summary>
### Saving retrieval task predictions
To save the predictions from a retrieval task, add the `--save_predictions` flag in the CLI or set `save_predictions=True` in the run method. The filename will be in the "{task_name}_{subset}_predictions.json" format.
Python:
```python
from mteb import MTEB
import mteb
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("all-MiniLM-L6-v2")
tasks = mteb.get_tasks(tasks=["NFCorpus"], languages=["eng"])
evaluation = MTEB(tasks=tasks)
evaluation.run(
model,
eval_splits=["test"],
save_predictions=True,
output_folder="results",
)
```
CLI:
```bash
mteb run -t NFCorpus -m all-MiniLM-L6-v2 --output_folder results --save_predictions
```
</details>
<details>
<summary> Fetching result from the results repository </summary>
### Fetching results from the results repository
Multiple models have already been run on tasks available within MTEB. These results are available results [repository](https://github.com/embeddings-benchmark/results).
To make the results more easily accessible, we have designed custom functionality for retrieving from the repository. For instance, if you are selecting the best model for your French and English retrieval task on legal documents you could fetch the relevant tasks and create a dataframe of the results using the following code:
```python
import mteb
from mteb.task_selection import results_to_dataframe
tasks = mteb.get_tasks(
task_types=["Retrieval"], languages=["eng", "fra"], domains=["Legal"]
)
model_names = [
"GritLM/GritLM-7B",
"intfloat/multilingual-e5-small",
"intfloat/multilingual-e5-base",
"intfloat/multilingual-e5-large",
]
models = [mteb.get_model_meta(name) for name in model_names]
results = mteb.load_results(models=models, tasks=tasks)
df = results_to_dataframe(results)
```
</details>
<details>
<summary> Annotate Contamination in the training data of a model </summary>
### Annotate Contamination
have your found contamination in the training data of a model? Please let us know, either by opening an issue or ideally by submitting a PR
annotatig the training datasets of the model:
```py
model_w_contamination = ModelMeta(
name = "model-with-contamination"
...
training_datasets: {"ArguAna": # name of dataset within MTEB
["test"]} # the splits that have been trained on
...
)
```
</details>
<details>
<summary> Running the leaderboard locally </summary>
### Running the Leaderboard
It is possible to completely deploy the leaderboard locally or self-host it. This can e.g. be relevant for companies that might want to
integrate build their own benchmarks or integrate custom tasks into existing benchmarks.
Running the leaderboard is quite easy. Simply run:
```py
python -m mteb.leaderboard.app
```
The leaderboard requires gradio install, which can be installed using `pip install mteb[gradio]` and requires python >3.10.
</details>
<details>
<summary> Caching Embeddings To Re-Use Them </summary>
### Caching Embeddings To Re-Use Them
There are times you may want to cache the embeddings so you can re-use them. This may be true if you have multiple query sets for the same corpus (e.g. Wikipedia) or are doing some optimization over the queries (e.g. prompting, other experiments). You can setup a cache by using a simple wrapper, which will save the cache per task in the `cache_embeddings/{task_name}` folder:
```python
# define your task and model above as normal
...
# wrap the model with the cache wrapper
from mteb.models.cache_wrapper import CachedEmbeddingWrapper
model_with_cached_emb = CachedEmbeddingWrapper(model, cache_path='path_to_cache_dir')
# run as normal
evaluation.run(model, ...)
```
</details>
<br />
## Documentation
| Documentation | |
|--------------------------------|-------------------------------------------------------------------------------------|
| 📋 [Tasks] | Overview of available tasks |
| 📐 [Benchmarks] | Overview of available benchmarks |
| 📈 [Leaderboard] | The interactive leaderboard of the benchmark |
| 🤖 [Adding a model] | Information related to how to submit a model to MTEB and to the leaderboard |
| 👩🔬 [Reproducible workflows] | Information related to how to reproduce and create reproducible workflows with MTEB |
| 👩💻 [Adding a dataset] | How to add a new task/dataset to MTEB |
| 👩💻 [Adding a benchmark] | How to add a new benchmark to MTEB and to the leaderboard |
| 🤝 [Contributing] | How to contribute to MTEB and set it up for development |
| 🌐 [MMTEB] | An open-source effort to extend MTEB to cover a broad set of languages |
| 🖼️ [MIEB] | Extension of MTEB to image embeddings |
[Tasks]: docs/tasks.md
[Benchmarks]: docs/benchmarks.md
[Contributing]: CONTRIBUTING.md
[Adding a model]: docs/adding_a_model.md
[Adding a dataset]: docs/adding_a_dataset.md
[Adding a benchmark]: docs/adding_a_benchmark.md
[Leaderboard]: https://huggingface.co/spaces/mteb/leaderboard
[MMTEB]: docs/mmteb/readme.md
[MIEB]: docs/mieb.md
[Reproducible workflows]: docs/reproducible_workflow.md
## Citing
MTEB was introduced in "[MTEB: Massive Text Embedding Benchmark](https://arxiv.org/abs/2210.07316)", feel free to cite:
```bibtex
@article{muennighoff2022mteb,
doi = {10.48550/ARXIV.2210.07316},
url = {https://arxiv.org/abs/2210.07316},
author = {Muennighoff, Niklas and Tazi, Nouamane and Magne, Lo{\"\i}c and Reimers, Nils},
title = {MTEB: Massive Text Embedding Benchmark},
publisher = {arXiv},
journal={arXiv preprint arXiv:2210.07316},
year = {2022}
}
```
You may also want to read and cite the amazing work that has extended MTEB & integrated new datasets:
- Shitao Xiao, Zheng Liu, Peitian Zhang, Niklas Muennighoff. "[C-Pack: Packaged Resources To Advance General Chinese Embedding](https://arxiv.org/abs/2309.07597)" arXiv 2023
- Michael Günther, Jackmin Ong, Isabelle Mohr, Alaeddine Abdessalem, Tanguy Abel, Mohammad Kalim Akram, Susana Guzman, Georgios Mastrapas, Saba Sturua, Bo Wang, Maximilian Werk, Nan Wang, Han Xiao. "[Jina Embeddings 2: 8192-Token General-Purpose Text Embeddings for Long Documents](https://arxiv.org/abs/2310.19923)" arXiv 2023
- Silvan Wehrli, Bert Arnrich, Christopher Irrgang. "[German Text Embedding Clustering Benchmark](https://arxiv.org/abs/2401.02709)" arXiv 2024
- Orion Weller, Benjamin Chang, Sean MacAvaney, Kyle Lo, Arman Cohan, Benjamin Van Durme, Dawn Lawrie, Luca Soldaini. "[FollowIR: Evaluating and Teaching Information Retrieval Models to Follow Instructions](https://arxiv.org/abs/2403.15246)" arXiv 2024
- Dawei Zhu, Liang Wang, Nan Yang, Yifan Song, Wenhao Wu, Furu Wei, Sujian Li. "[LongEmbed: Extending Embedding Models for Long Context Retrieval](https://arxiv.org/abs/2404.12096)" arXiv 2024
- Kenneth Enevoldsen, Márton Kardos, Niklas Muennighoff, Kristoffer Laigaard Nielbo. "[The Scandinavian Embedding Benchmarks: Comprehensive Assessment of Multilingual and Monolingual Text Embedding](https://arxiv.org/abs/2406.02396)" arXiv 2024
- Ali Shiraee Kasmaee, Mohammad Khodadad, Mohammad Arshi Saloot, Nick Sherck, Stephen Dokas, Hamidreza Mahyar, Soheila Samiee. "[ChemTEB: Chemical Text Embedding Benchmark, an Overview of Embedding Models Performance & Efficiency on a Specific Domain](https://arxiv.org/abs/2412.00532)" arXiv 2024
For works that have used MTEB for benchmarking, you can find them on the [leaderboard](https://huggingface.co/spaces/mteb/leaderboard).
Raw data
{
"_id": null,
"home_page": null,
"name": "mteb",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "deep learning, text embeddings, benchmark",
"author": null,
"author_email": "MTEB Contributors <niklas@huggingface.co>, nouamane@huggingface.co, info@nils-reimers.de",
"download_url": "https://files.pythonhosted.org/packages/1c/c1/ae91df72bffc31e950301101a8bbefff9237925abbf2bbded2423cb4ad39/mteb-1.36.26.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">Massive Text Embedding Benchmark</h1>\n\n<p align=\"center\">\n <a href=\"https://github.com/embeddings-benchmark/mteb/releases\">\n <img alt=\"GitHub release\" src=\"https://img.shields.io/github/release/embeddings-benchmark/mteb.svg\">\n </a>\n <a href=\"https://arxiv.org/abs/2210.07316\">\n <img alt=\"GitHub release\" src=\"https://img.shields.io/badge/arXiv-2305.14251-b31b1b.svg\">\n </a>\n <a href=\"https://github.com/embeddings-benchmark/mteb/blob/master/LICENSE\">\n <img alt=\"License\" src=\"https://img.shields.io/github/license/embeddings-benchmark/mteb.svg?color=green\">\n </a>\n <a href=\"https://pepy.tech/project/mteb\">\n <img alt=\"Downloads\" src=\"https://static.pepy.tech/personalized-badge/mteb?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads\">\n </a>\n</p>\n\n<h4 align=\"center\">\n <p>\n <a href=\"#installation\">Installation</a> |\n <a href=\"#usage-documentation\">Usage</a> |\n <a href=\"https://huggingface.co/spaces/mteb/leaderboard\">Leaderboard</a> |\n <a href=\"#documentation\">Documentation</a> |\n <a href=\"#citing\">Citing</a>\n <p>\n</h4>\n\n<h3 align=\"center\">\n <a href=\"https://huggingface.co/spaces/mteb/leaderboard\"><img style=\"float: middle; padding: 10px 10px 10px 10px;\" width=\"60\" height=\"55\" src=\"./docs/images/hf_logo.png\" /></a>\n</h3>\n\n\n## Installation\n\n```bash\npip install mteb\n```\n\n## Example Usage\n\n* Using a Python script:\n\n```python\nimport mteb\nfrom sentence_transformers import SentenceTransformer\n\n# Define the sentence-transformers model name\nmodel_name = \"average_word_embeddings_komninos\"\n\nmodel = mteb.get_model(model_name) # if the model is not implemented in MTEB it will be eq. to SentenceTransformer(model_name)\ntasks = mteb.get_tasks(tasks=[\"Banking77Classification\"])\nevaluation = mteb.MTEB(tasks=tasks)\nresults = evaluation.run(model, output_folder=f\"results/{model_name}\")\n```\n\n<details>\n <summary> Running SentenceTransformer model with prompts </summary>\n\nPrompts can be passed to the SentenceTransformer model using the `prompts` parameter. The following code shows how to use prompts with SentenceTransformer:\n\n```python\nfrom sentence_transformers import SentenceTransformer\n\n\nmodel = SentenceTransformer(\"average_word_embeddings_komninos\", prompts={\"query\": \"Query:\", \"passage\": \"Passage:\"})\nevaluation = mteb.MTEB(tasks=tasks)\n```\n\nIn prompts the key can be:\n1. Prompt types (`passage`, `query`) - they will be used in reranking and retrieval tasks\n2. Task type - these prompts will be used in all tasks of the given type\n 1. `BitextMining`\n 2. `Classification`\n 3. `MultilabelClassification`\n 4. `Clustering`\n 5. `PairClassification`\n 6. `Reranking`\n 7. `Retrieval`\n 8. `STS`\n 9. `Summarization`\n 10. `InstructionRetrieval`\n3. Pair of task type and prompt type like `Retrival-query` - these prompts will be used in all classification tasks\n4. Task name - these prompts will be used in the specific task\n5. Pair of task name and prompt type like `NFCorpus-query` - these prompts will be used in the specific task\n</details>\n\n* Using CLI\n\n```bash\nmteb available_tasks\n\nmteb run -m sentence-transformers/all-MiniLM-L6-v2 \\\n -t Banking77Classification \\\n --verbosity 3\n\n# if nothing is specified default to saving the results in the results/{model_name} folder\n```\n\n* Using multiple GPUs in parallel can be done by just having a custom encode function that distributes the inputs to multiple GPUs like e.g. [here](https://github.com/microsoft/unilm/blob/b60c741f746877293bb85eed6806736fc8fa0ffd/e5/mteb_eval.py#L60) or [here](https://github.com/ContextualAI/gritlm/blob/09d8630f0c95ac6a456354bcb6f964d7b9b6a609/gritlm/gritlm.py#L75).\n\n\n\n## Usage Documentation\nClick on each section below to see the details.\n\n<br />\n\n<details>\n <summary> Task selection </summary>\n\n### Task selection\n\nTasks can be selected by providing the list of datasets, but also\n\n* by their task (e.g. \"Clustering\" or \"Classification\")\n\n```python\ntasks = mteb.get_tasks(task_types=[\"Clustering\", \"Retrieval\"]) # Only select clustering and retrieval tasks\n```\n\n* by their categories e.g. \"s2s\" (sentence to sentence) or \"p2p\" (paragraph to paragraph)\n\n```python\ntasks = mteb.get_tasks(categories=[\"s2s\", \"p2p\"]) # Only select sentence2sentence and paragraph2paragraph datasets\n```\n\n* by their languages\n\n```python\ntasks = mteb.get_tasks(languages=[\"eng\", \"deu\"]) # Only select datasets which contain \"eng\" or \"deu\" (iso 639-3 codes)\n```\n\nYou can also specify which languages to load for multilingual/cross-lingual tasks like below:\n\n```python\nimport mteb\n\ntasks = [\n mteb.get_task(\"AmazonReviewsClassification\", languages = [\"eng\", \"fra\"]),\n mteb.get_task(\"BUCCBitextMining\", languages = [\"deu\"]), # all subsets containing \"deu\"\n]\n\n# or you can select specific huggingface subsets like this:\nfrom mteb.tasks import AmazonReviewsClassification, BUCCBitextMining\n\nevaluation = mteb.MTEB(tasks=[\n AmazonReviewsClassification(hf_subsets=[\"en\", \"fr\"]) # Only load \"en\" and \"fr\" subsets of Amazon Reviews\n BUCCBitextMining(hf_subsets=[\"de-en\"]), # Only load \"de-en\" subset of BUCC\n])\n# for an example of a HF subset see \"Subset\" in the dataset viewer at: https://huggingface.co/datasets/mteb/bucc-bitext-mining\n```\n\n* by their modalities\n\n```python\ntasks = mteb.get_tasks(modalities=[\"text\", \"image\"]) # Only select tasks with text or image modalities\n```\n\n You can also specify exclusive modality filtering to only get tasks with exactly the requested modalities (default behavior with exclusive_modality_filter=False):\n```python\n# Get tasks with text modality, this will also include tasks having both text and image modalities\ntasks = mteb.get_tasks(modalities=[\"text\"], exclusive_modality_filter=False)\n\n# Get tasks that have ONLY text modality (no image or other modalities)\ntasks = mteb.get_tasks(modalities=[\"text\"], exclusive_modality_filter=True)\n```\n\n</details>\n\n<details>\n <summary> Running a benchmark </summary>\n\n### Running a Benchmark\n\n`mteb` comes with a set of predefined benchmarks. These can be fetched using `get_benchmark` and run in a similar fashion to other sets of tasks.\nFor instance to select the 56 English datasets that form the \"Overall MTEB English leaderboard\":\n\n```python\nimport mteb\nbenchmark = mteb.get_benchmark(\"MTEB(eng, v1)\")\nevaluation = mteb.MTEB(tasks=benchmark)\n```\n\nThe benchmark specified not only a list of tasks, but also what splits and language to run on. To get an overview of all available benchmarks simply run:\n\n```python\nimport mteb\nbenchmarks = mteb.get_benchmarks()\n```\n\nGenerally we use the naming scheme for benchmarks `MTEB(*)`, where the \"*\" denotes the target of the benchmark. In the case of a language, we use the three-letter language code. For large groups of languages, we use the group notation, e.g., `MTEB(Scandinavian, v1)` for Scandinavian languages. External benchmarks implemented in MTEB like `CoIR` use their original name. When using a benchmark from MTEB please cite `mteb` along with the citations of the benchmark which you can access using:\n\n```python\nbenchmark.citation\n```\n\n</details>\n\n<details>\n <summary> Passing in `encode` arguments </summary>\n\n\n### Passing in `encode` arguments\n\nTo pass in arguments to the model's `encode` function, you can use the encode keyword arguments (`encode_kwargs`):\n\n```python\nevaluation.run(model, encode_kwargs={\"batch_size\": 32})\n```\n</details>\n\n\n<details>\n <summary> Selecting evaluation split </summary>\n\n### Selecting evaluation split\nYou can evaluate only on `test` splits of all tasks by doing the following:\n\n```python\nevaluation.run(model, eval_splits=[\"test\"])\n```\n\nNote that the public leaderboard uses the test splits for all datasets except MSMARCO, where the \"dev\" split is used.\n\n</details>\n\n\n<details>\n <summary> Selecting evaluation subset </summary>\n\n### Selecting evaluation subset\nYou can evaluate only on selected subsets. For example, if you want to evaluate only the `subset_name_to_run` subset of all tasks, do the following:\n\n```python\nevaluation.run(model, eval_subsets=[\"subset_name_to_run\"])\n```\n\nMonolingual tasks have `default` subset, other tasks have subsets that are specific to the dataset.\n\n</details>\n\n<details>\n <summary> Using a custom model </summary>\n\n\n### Using a custom model\n\nModels should implement the following interface, implementing an `encode` function taking as inputs a list of sentences, and returning a list of embeddings (embeddings can be `np.array`, `torch.tensor`, etc.). For inspiration, you can look at the [mteb/mtebscripts repo](https://github.com/embeddings-benchmark/mtebscripts) used for running diverse models via SLURM scripts for the paper.\n\n```python\nimport mteb\nfrom mteb.encoder_interface import PromptType\nimport numpy as np\n\n\nclass CustomModel:\n def encode(\n self,\n sentences: list[str],\n task_name: str,\n prompt_type: PromptType | None = None,\n **kwargs,\n ) -> np.ndarray:\n \"\"\"Encodes the given sentences using the encoder.\n\n Args:\n sentences: The sentences to encode.\n task_name: The name of the task.\n prompt_type: The prompt type to use.\n **kwargs: Additional arguments to pass to the encoder.\n\n Returns:\n The encoded sentences.\n \"\"\"\n pass\n\nmodel = CustomModel()\ntasks = mteb.get_tasks(tasks=[\"Banking77Classification\"])\nevaluation = mteb.MTEB(tasks=tasks)\nevaluation.run(model)\n```\n\n</details>\n\n<details>\n <summary> Evaluating on a custom dataset </summary>\n\n\n### Evaluating on a custom dataset\n\nTo evaluate on a custom task, you can run the following code on your custom task. See [how to add a new task](docs/adding_a_dataset.md), for how to create a new task in MTEB.\n\n```python\nfrom mteb import MTEB\nfrom mteb.abstasks.AbsTaskReranking import AbsTaskReranking\nfrom sentence_transformers import SentenceTransformer\n\n\nclass MyCustomTask(AbsTaskReranking):\n ...\n\nmodel = SentenceTransformer(\"average_word_embeddings_komninos\")\nevaluation = MTEB(tasks=[MyCustomTask()])\nevaluation.run(model)\n```\n\n</details>\n\n<details>\n <summary> Using a cross encoder for reranking</summary>\n\n\n### Using a cross encoder for reranking\n\nTo use a cross encoder for reranking, you can directly use a CrossEncoder from SentenceTransformers. The following code shows a two-stage run with the second stage reading results saved from the first stage.\n\n```python\nfrom mteb import MTEB\nimport mteb\nfrom sentence_transformers import CrossEncoder, SentenceTransformer\n\ncross_encoder = CrossEncoder(\"cross-encoder/ms-marco-TinyBERT-L-2-v2\")\ndual_encoder = SentenceTransformer(\"all-MiniLM-L6-v2\")\n\ntasks = mteb.get_tasks(tasks=[\"NFCorpus\"], languages=[\"eng\"])\n\nsubset = \"default\" # subset name used in the NFCorpus dataset\neval_splits = [\"test\"]\n\nevaluation = MTEB(tasks=tasks)\nevaluation.run(\n dual_encoder,\n eval_splits=eval_splits,\n save_predictions=True,\n output_folder=\"results/stage1\",\n)\nevaluation.run(\n cross_encoder,\n eval_splits=eval_splits,\n top_k=5,\n save_predictions=True,\n output_folder=\"results/stage2\",\n previous_results=f\"results/stage1/NFCorpus_{subset}_predictions.json\",\n)\n```\n\n</details>\n\n<details>\n <summary> Late Interaction (ColBERT) </summary>\n\n### Using Late Interaction models for retrieval\n\n```python\nfrom mteb import MTEB\nimport mteb\n\n\ncolbert = mteb.get_model(\"colbert-ir/colbertv2.0\")\ntasks = mteb.get_tasks(tasks=[\"NFCorpus\"], languages=[\"eng\"])\n\neval_splits = [\"test\"]\n\nevaluation = MTEB(tasks=tasks)\n\nevaluation.run(\n colbert,\n eval_splits=eval_splits,\n corpus_chunk_size=500,\n)\n```\nThis implementation employs the MaxSim operation to compute the similarity between sentences. While MaxSim provides high-quality results, it processes a larger number of embeddings, potentially leading to increased resource usage. To manage resource consumption, consider lowering the `corpus_chunk_size` parameter.\n\n\n</details>\n\n<details>\n <summary> Saving retrieval task predictions </summary>\n\n### Saving retrieval task predictions\n\nTo save the predictions from a retrieval task, add the `--save_predictions` flag in the CLI or set `save_predictions=True` in the run method. The filename will be in the \"{task_name}_{subset}_predictions.json\" format.\n\nPython:\n```python\nfrom mteb import MTEB\nimport mteb\nfrom sentence_transformers import SentenceTransformer\n\nmodel = SentenceTransformer(\"all-MiniLM-L6-v2\")\n\ntasks = mteb.get_tasks(tasks=[\"NFCorpus\"], languages=[\"eng\"])\n\nevaluation = MTEB(tasks=tasks)\nevaluation.run(\n model,\n eval_splits=[\"test\"],\n save_predictions=True,\n output_folder=\"results\",\n)\n```\n\nCLI:\n```bash\nmteb run -t NFCorpus -m all-MiniLM-L6-v2 --output_folder results --save_predictions\n```\n\n</details>\n\n<details>\n <summary> Fetching result from the results repository </summary>\n\n### Fetching results from the results repository\n\nMultiple models have already been run on tasks available within MTEB. These results are available results [repository](https://github.com/embeddings-benchmark/results).\n\nTo make the results more easily accessible, we have designed custom functionality for retrieving from the repository. For instance, if you are selecting the best model for your French and English retrieval task on legal documents you could fetch the relevant tasks and create a dataframe of the results using the following code:\n\n```python\nimport mteb\nfrom mteb.task_selection import results_to_dataframe\n\ntasks = mteb.get_tasks(\n task_types=[\"Retrieval\"], languages=[\"eng\", \"fra\"], domains=[\"Legal\"]\n)\n\nmodel_names = [\n \"GritLM/GritLM-7B\",\n \"intfloat/multilingual-e5-small\",\n \"intfloat/multilingual-e5-base\",\n \"intfloat/multilingual-e5-large\",\n]\nmodels = [mteb.get_model_meta(name) for name in model_names]\n\nresults = mteb.load_results(models=models, tasks=tasks)\n\ndf = results_to_dataframe(results)\n```\n\n</details>\n\n\n<details>\n <summary> Annotate Contamination in the training data of a model </summary>\n\n### Annotate Contamination\n\nhave your found contamination in the training data of a model? Please let us know, either by opening an issue or ideally by submitting a PR\nannotatig the training datasets of the model:\n\n```py\nmodel_w_contamination = ModelMeta(\n name = \"model-with-contamination\"\n ...\n training_datasets: {\"ArguAna\": # name of dataset within MTEB\n [\"test\"]} # the splits that have been trained on\n ...\n)\n```\n\n\n</details>\n\n<details>\n <summary> Running the leaderboard locally </summary>\n\n\n### Running the Leaderboard\n\nIt is possible to completely deploy the leaderboard locally or self-host it. This can e.g. be relevant for companies that might want to\nintegrate build their own benchmarks or integrate custom tasks into existing benchmarks.\n\nRunning the leaderboard is quite easy. Simply run:\n```py\npython -m mteb.leaderboard.app\n```\n\nThe leaderboard requires gradio install, which can be installed using `pip install mteb[gradio]` and requires python >3.10.\n\n</details>\n\n<details>\n <summary> Caching Embeddings To Re-Use Them </summary>\n\n\n### Caching Embeddings To Re-Use Them\n\nThere are times you may want to cache the embeddings so you can re-use them. This may be true if you have multiple query sets for the same corpus (e.g. Wikipedia) or are doing some optimization over the queries (e.g. prompting, other experiments). You can setup a cache by using a simple wrapper, which will save the cache per task in the `cache_embeddings/{task_name}` folder:\n\n```python\n# define your task and model above as normal\n...\n# wrap the model with the cache wrapper\nfrom mteb.models.cache_wrapper import CachedEmbeddingWrapper\nmodel_with_cached_emb = CachedEmbeddingWrapper(model, cache_path='path_to_cache_dir')\n# run as normal\nevaluation.run(model, ...)\n```\n\n</details>\n\n<br />\n\n\n\n## Documentation\n\n| Documentation | |\n|--------------------------------|-------------------------------------------------------------------------------------|\n| \ud83d\udccb [Tasks] | Overview of available tasks |\n| \ud83d\udcd0 [Benchmarks] | Overview of available benchmarks |\n| \ud83d\udcc8 [Leaderboard] | The interactive leaderboard of the benchmark |\n| \ud83e\udd16 [Adding a model] | Information related to how to submit a model to MTEB and to the leaderboard |\n| \ud83d\udc69\u200d\ud83d\udd2c [Reproducible workflows] | Information related to how to reproduce and create reproducible workflows with MTEB |\n| \ud83d\udc69\u200d\ud83d\udcbb [Adding a dataset] | How to add a new task/dataset to MTEB |\n| \ud83d\udc69\u200d\ud83d\udcbb [Adding a benchmark] | How to add a new benchmark to MTEB and to the leaderboard |\n| \ud83e\udd1d [Contributing] | How to contribute to MTEB and set it up for development |\n| \ud83c\udf10 [MMTEB] | An open-source effort to extend MTEB to cover a broad set of languages |\n| \ud83d\uddbc\ufe0f [MIEB] | Extension of MTEB to image embeddings |\n\n[Tasks]: docs/tasks.md\n[Benchmarks]: docs/benchmarks.md\n[Contributing]: CONTRIBUTING.md\n[Adding a model]: docs/adding_a_model.md\n[Adding a dataset]: docs/adding_a_dataset.md\n[Adding a benchmark]: docs/adding_a_benchmark.md\n[Leaderboard]: https://huggingface.co/spaces/mteb/leaderboard\n[MMTEB]: docs/mmteb/readme.md\n[MIEB]: docs/mieb.md\n[Reproducible workflows]: docs/reproducible_workflow.md\n\n## Citing\n\nMTEB was introduced in \"[MTEB: Massive Text Embedding Benchmark](https://arxiv.org/abs/2210.07316)\", feel free to cite:\n\n```bibtex\n@article{muennighoff2022mteb,\n doi = {10.48550/ARXIV.2210.07316},\n url = {https://arxiv.org/abs/2210.07316},\n author = {Muennighoff, Niklas and Tazi, Nouamane and Magne, Lo{\\\"\\i}c and Reimers, Nils},\n title = {MTEB: Massive Text Embedding Benchmark},\n publisher = {arXiv},\n journal={arXiv preprint arXiv:2210.07316},\n year = {2022}\n}\n```\n\nYou may also want to read and cite the amazing work that has extended MTEB & integrated new datasets:\n- Shitao Xiao, Zheng Liu, Peitian Zhang, Niklas Muennighoff. \"[C-Pack: Packaged Resources To Advance General Chinese Embedding](https://arxiv.org/abs/2309.07597)\" arXiv 2023\n- Michael G\u00fcnther, Jackmin Ong, Isabelle Mohr, Alaeddine Abdessalem, Tanguy Abel, Mohammad Kalim Akram, Susana Guzman, Georgios Mastrapas, Saba Sturua, Bo Wang, Maximilian Werk, Nan Wang, Han Xiao. \"[Jina Embeddings 2: 8192-Token General-Purpose Text Embeddings for Long Documents](https://arxiv.org/abs/2310.19923)\" arXiv 2023\n- Silvan Wehrli, Bert Arnrich, Christopher Irrgang. \"[German Text Embedding Clustering Benchmark](https://arxiv.org/abs/2401.02709)\" arXiv 2024\n- Orion Weller, Benjamin Chang, Sean MacAvaney, Kyle Lo, Arman Cohan, Benjamin Van Durme, Dawn Lawrie, Luca Soldaini. \"[FollowIR: Evaluating and Teaching Information Retrieval Models to Follow Instructions](https://arxiv.org/abs/2403.15246)\" arXiv 2024\n- Dawei Zhu, Liang Wang, Nan Yang, Yifan Song, Wenhao Wu, Furu Wei, Sujian Li. \"[LongEmbed: Extending Embedding Models for Long Context Retrieval](https://arxiv.org/abs/2404.12096)\" arXiv 2024\n- Kenneth Enevoldsen, M\u00e1rton Kardos, Niklas Muennighoff, Kristoffer Laigaard Nielbo. \"[The Scandinavian Embedding Benchmarks: Comprehensive Assessment of Multilingual and Monolingual Text Embedding](https://arxiv.org/abs/2406.02396)\" arXiv 2024\n- Ali Shiraee Kasmaee, Mohammad Khodadad, Mohammad Arshi Saloot, Nick Sherck, Stephen Dokas, Hamidreza Mahyar, Soheila Samiee. \"[ChemTEB: Chemical Text Embedding Benchmark, an Overview of Embedding Models Performance & Efficiency on a Specific Domain](https://arxiv.org/abs/2412.00532)\" arXiv 2024\n\nFor works that have used MTEB for benchmarking, you can find them on the [leaderboard](https://huggingface.co/spaces/mteb/leaderboard).\n",
"bugtrack_url": null,
"license": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n \n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n \n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n \n Copyright [yyyy] [name of copyright owner]\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n ",
"summary": "Massive Text Embedding Benchmark",
"version": "1.36.26",
"project_urls": {
"Huggingface Organization": "https://huggingface.co/mteb",
"Source Code": "https://github.com/embeddings-benchmark/mteb",
"homepage": "https://github.com/embeddings-benchmark/mteb"
},
"split_keywords": [
"deep learning",
" text embeddings",
" benchmark"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2a8896805a48e9bd55bac0a837307a4032564a54d91a30b1b3b4f18fcb1441d3",
"md5": "c224d23818b6e7916c19a3c6baac7693",
"sha256": "0c49fd150a5539572f3cc99ae6aab3b6c476cb2a46940eeb552c84181b604222"
},
"downloads": -1,
"filename": "mteb-1.36.26-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c224d23818b6e7916c19a3c6baac7693",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 2028446,
"upload_time": "2025-03-18T21:38:22",
"upload_time_iso_8601": "2025-03-18T21:38:22.707876Z",
"url": "https://files.pythonhosted.org/packages/2a/88/96805a48e9bd55bac0a837307a4032564a54d91a30b1b3b4f18fcb1441d3/mteb-1.36.26-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1cc1ae91df72bffc31e950301101a8bbefff9237925abbf2bbded2423cb4ad39",
"md5": "803cafb28056c0dfdfd61ae9f3eccd08",
"sha256": "7fdbf899279f9a4964b1c49ba9f96f3f4af001d5fdede72364293d2c0e62d17d"
},
"downloads": -1,
"filename": "mteb-1.36.26.tar.gz",
"has_sig": false,
"md5_digest": "803cafb28056c0dfdfd61ae9f3eccd08",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 1267501,
"upload_time": "2025-03-18T21:38:25",
"upload_time_iso_8601": "2025-03-18T21:38:25.431879Z",
"url": "https://files.pythonhosted.org/packages/1c/c1/ae91df72bffc31e950301101a8bbefff9237925abbf2bbded2423cb4ad39/mteb-1.36.26.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-18 21:38:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "embeddings-benchmark",
"github_project": "mteb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mteb"
}
