mteb 2.1.4__py3-none-any.whl → 2.5.2__py3-none-any.whl

mteb/models/model_implementations/mme5_models.py

@@ -12,6 +12,7 @@ mme5_mllama = ModelMeta(
         "trust_remote_code": True,
     },
     name="intfloat/mmE5-mllama-11b-instruct",
+    model_type=["dense"],
     revision="cbb328b9bf9ff5362c852c3166931903226d46f1",
     release_date="2025-02-12",
     languages=["eng-Latn"],

mteb/models/model_implementations/moco_models.py

@@ -10,6 +10,13 @@ from mteb.models.abs_encoder import AbsEncoder
 from mteb.models.model_meta import ModelMeta, ScoringFunction
 from mteb.types import Array, BatchedInput, PromptType
 
+MOCOV3_CITATION = """@Article{chen2021mocov3,
+    author  = {Xinlei Chen* and Saining Xie* and Kaiming He},
+    title   = {An Empirical Study of Training Self-Supervised Vision Transformers},
+    journal = {arXiv preprint arXiv:2104.02057},
+    year    = {2021},
+}"""
+
 
 def mocov3_loader(model_name, **kwargs):
     requires_package(mocov3_loader, "timm", model_name, "pip install 'mteb[timm]'")
@@ -112,6 +119,7 @@ mocov3_training_datasets = set(
 mocov3_vit_base = ModelMeta(
     loader=mocov3_loader,  # type: ignore
     name="nyu-visionx/moco-v3-vit-b",
+    model_type=["dense"],
     languages=["eng-Latn"],
     revision="7d091cd70772c5c0ecf7f00b5f12ca609a99d69d",
     release_date="2024-06-03",
@@ -129,11 +137,13 @@ mocov3_vit_base = ModelMeta(
     similarity_fn_name=ScoringFunction.COSINE,
     use_instructions=False,
     training_datasets=mocov3_training_datasets,
+    citation=MOCOV3_CITATION,
 )
 
 mocov3_vit_large = ModelMeta(
     loader=mocov3_loader,  # type: ignore
     name="nyu-visionx/moco-v3-vit-l",
+    model_type=["dense"],
     languages=["eng-Latn"],
     revision="7bf75358d616f39b9716148bf4e3425f3bd35b47",
     release_date="2024-06-03",
@@ -151,4 +161,5 @@ mocov3_vit_large = ModelMeta(
     similarity_fn_name=ScoringFunction.COSINE,
     use_instructions=False,
     training_datasets=mocov3_training_datasets,
+    citation=MOCOV3_CITATION,
 )

mteb/models/model_implementations/mod_models.py

@@ -0,0 +1,191 @@
+from mteb.models.instruct_wrapper import InstructSentenceTransformerModel
+from mteb.models.model_meta import ModelMeta
+from mteb.models.models_protocols import PromptType
+
+
+def instruction_template(
+    instruction: str, prompt_type: PromptType | None = None
+) -> str:
+    if not instruction or prompt_type == PromptType.document:
+        return ""
+    if isinstance(instruction, dict):
+        if prompt_type is None:
+            instruction = next(iter(instruction.values()))  # TODO
+        else:
+            instruction = instruction[prompt_type]
+    return f"Instruct: {instruction}\nQuery:"
+
+
+multilingual_langs = [
+    "afr-Latn",
+    "ara-Arab",
+    "aze-Latn",
+    "bel-Cyrl",
+    "bul-Cyrl",
+    "ben-Beng",
+    "cat-Latn",
+    "ceb-Latn",
+    "ces-Latn",
+    "cym-Latn",
+    "dan-Latn",
+    "deu-Latn",
+    "ell-Grek",
+    "eng-Latn",
+    "spa-Latn",
+    "est-Latn",
+    "eus-Latn",
+    "fas-Arab",
+    "fin-Latn",
+    "fra-Latn",
+    "glg-Latn",
+    "guj-Gujr",
+    "heb-Hebr",
+    "hin-Deva",
+    "hrv-Latn",
+    "hat-Latn",
+    "hun-Latn",
+    "hye-Armn",
+    "ind-Latn",
+    "isl-Latn",
+    "ita-Latn",
+    "jpn-Jpan",
+    "jav-Latn",
+    "kat-Geor",
+    "kaz-Cyrl",
+    "khm-Khmr",
+    "kan-Knda",
+    "kor-Hang",
+    "kir-Cyrl",
+    "lao-Laoo",
+    "lit-Latn",
+    "lav-Latn",
+    "mkd-Cyrl",
+    "mal-Mlym",
+    "mon-Cyrl",
+    "mar-Deva",
+    "msa-Latn",
+    "mya-Mymr",
+    "nep-Deva",
+    "nld-Latn",
+    "nor-Latn",
+    "nob-Latn",
+    "nno-Latn",
+    "pan-Guru",
+    "pol-Latn",
+    "por-Latn",
+    "que-Latn",
+    "ron-Latn",
+    "rus-Cyrl",
+    "sin-Sinh",
+    "slk-Latn",
+    "slv-Latn",
+    "swa-Latn",
+    "tam-Taml",
+    "tel-Telu",
+    "tha-Thai",
+    "tgl-Latn",
+    "tur-Latn",
+    "ukr-Cyrl",
+    "urd-Arab",
+    "vie-Latn",
+    "yor-Latn",
+    "zho-Hans",
+]
+
+MOD_CITATION = """@misc{mod-embedding-2025,
+  title={MoD-Embedding: A Fine-tuned Multilingual Text Embedding Model},
+  author={MoD Team},
+  year={2025},
+  url={https://huggingface.co/bflhc/MoD-Embedding}
+}"""
+
+training_data = {
+    "T2Retrieval",
+    "DuRetrieval",
+    "MMarcoReranking",
+    "CMedQAv2-reranking",
+    "NQ",
+    "MSMARCO",
+    "HotpotQA",
+    "FEVER",
+    "MrTidyRetrieval",
+    "MIRACLRetrieval",
+    "CodeSearchNet",
+}
+
+# Predefined prompts for various RTEB tasks
+_PREDEFINED_PROMPTS = {
+    # ========== Open Datasets ==========
+    # Legal domain
+    "AILACasedocs": "Given a legal case scenario, retrieve the most relevant case documents",
+    "AILAStatutes": "Given a legal scenario, retrieve the most relevant statute documents",
+    "LegalQuAD": "Given a legal question, retrieve relevant legal documents that answer the question",
+    "LegalSummarization": "Given a query, retrieve relevant legal documents for summarization",
+    # Code domain
+    "AppsRetrieval": "Given a query about mobile applications, retrieve relevant app information",
+    "HumanEvalRetrieval": "Given a code problem description, retrieve relevant code examples",
+    "MBPPRetrieval": "Given a programming problem description, retrieve relevant code solutions",
+    "DS1000Retrieval": "Given a data science problem, retrieve relevant code snippets",
+    "FreshStackRetrieval": "Given a programming question, retrieve relevant Stack Overflow posts",
+    # Finance domain
+    "FinQARetrieval": "Given a financial question, retrieve relevant financial documents",
+    "FinanceBenchRetrieval": "Given a financial query, retrieve relevant financial information",
+    "HC3FinanceRetrieval": "Given a finance-related query, retrieve relevant documents",
+    # Medical domain
+    "CUREv1": "Given a medical query, retrieve relevant clinical documents",
+    "ChatDoctorRetrieval": "Given a medical question, retrieve relevant medical information",
+    # SQL domain
+    "WikiSQLRetrieval": "Given a natural language query, retrieve relevant SQL examples",
+    # Multilingual
+    "MIRACLRetrievalHardNegatives": "Given a question, retrieve Wikipedia passages that answer the question",
+    # ========== Private/Closed Datasets ==========
+    # Code domain (Private)
+    "Code1Retrieval": "Given a code problem description, retrieve relevant code examples",
+    "JapaneseCode1Retrieval": "Given a code problem description, retrieve relevant code examples",
+    # Finance domain (Private)
+    "EnglishFinance1Retrieval": "Given a financial query, retrieve relevant financial documents",
+    "EnglishFinance2Retrieval": "Given a financial query, retrieve relevant financial documents",
+    "EnglishFinance3Retrieval": "Given a financial query, retrieve relevant financial documents",
+    "EnglishFinance4Retrieval": "Given a financial query, retrieve relevant financial documents",
+    # Healthcare domain (Private)
+    "EnglishHealthcare1Retrieval": "Given a medical question, retrieve relevant medical information",
+    "GermanHealthcare1Retrieval": "Given a medical question, retrieve relevant medical information",
+    # Legal domain (Private)
+    "FrenchLegal1Retrieval": "Given a legal query, retrieve relevant legal documents",
+    "GermanLegal1Retrieval": "Given a legal query, retrieve relevant legal documents",
+    "JapaneseLegal1Retrieval": "Given a legal query, retrieve relevant legal documents",
+    # General/Multilingual (Private)
+    "French1Retrieval": "Given a query, retrieve relevant passages",
+    "German1Retrieval": "Given a query, retrieve relevant passages",
+}
+
+
+MoD_Embedding = ModelMeta(
+    loader=InstructSentenceTransformerModel,
+    loader_kwargs=dict(
+        instruction_template=instruction_template,
+        apply_instruction_to_passages=False,
+        prompts_dict=_PREDEFINED_PROMPTS,
+        max_seq_length=18480,
+        model_kwargs={"torch_dtype": "bfloat16"},
+    ),
+    name="bflhc/MoD-Embedding",
+    languages=multilingual_langs,
+    open_weights=True,
+    revision="acbb5b70fdab262226a6af2bc62001de8021b05c",
+    release_date="2025-12-14",
+    n_parameters=4021774336,
+    memory_usage_mb=7671,
+    embed_dim=2560,
+    max_tokens=32768,
+    license="apache-2.0",
+    reference="https://huggingface.co/bflhc/MoD-Embedding",
+    similarity_fn_name="cosine",
+    framework=["Sentence Transformers", "PyTorch"],
+    use_instructions=True,
+    public_training_code=None,
+    public_training_data=None,
+    training_datasets=training_data,
+    citation=MOD_CITATION,
+    adapted_from="Qwen/Qwen3-Embedding-4B",
+)

mteb/models/model_implementations/model2vec_models.py

@@ -161,6 +161,7 @@ class Model2VecModel(AbsEncoder):
 m2v_base_glove_subword = ModelMeta(
     loader=Model2VecModel,
     name="minishlab/M2V_base_glove_subword",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="5f4f5ca159b7321a8b39739bba0794fa0debddf4",
@@ -186,6 +187,7 @@ m2v_base_glove_subword = ModelMeta(
 m2v_base_glove = ModelMeta(
     loader=Model2VecModel,
     name="minishlab/M2V_base_glove",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="38ebd7f10f71e67fa8db898290f92b82e9cfff2b",
@@ -210,6 +212,7 @@ m2v_base_glove = ModelMeta(
 m2v_base_output = ModelMeta(
     loader=Model2VecModel,
     name="minishlab/M2V_base_output",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="02460ae401a22b09d2c6652e23371398329551e2",
@@ -234,6 +237,7 @@ m2v_base_output = ModelMeta(
 m2v_multilingual_output = ModelMeta(
     loader=Model2VecModel,
     name="minishlab/M2V_multilingual_output",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="2cf4ec4e1f51aeca6c55cf9b93097d00711a6305",
@@ -258,6 +262,7 @@ m2v_multilingual_output = ModelMeta(
 potion_base_2m = ModelMeta(
     loader=Model2VecModel,
     name="minishlab/potion-base-2M",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="86db093558fbced2072b929eb1690bce5272bd4b",
@@ -282,6 +287,7 @@ potion_base_2m = ModelMeta(
 potion_base_4m = ModelMeta(
     loader=Model2VecModel,
     name="minishlab/potion-base-4M",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="81b1802ada41afcd0987a37dc15e569c9fa76f04",
@@ -306,6 +312,7 @@ potion_base_4m = ModelMeta(
 potion_base_8m = ModelMeta(
     loader=Model2VecModel,
     name="minishlab/potion-base-8M",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="dcbec7aa2d52fc76754ac6291803feedd8c619ce",
@@ -330,6 +337,7 @@ potion_base_8m = ModelMeta(
 potion_multilingual_128m = ModelMeta(
     loader=Model2VecModel,
     name="minishlab/potion-multilingual-128M",
+    model_type=["dense"],
     languages=_POTION_MULTILINGUAL_128M_LANGUAGES,
     open_weights=True,
     revision="38ebd7f10f71e67fa8db898290f92b82e9cfff2a",
@@ -354,6 +362,7 @@ potion_multilingual_128m = ModelMeta(
 pubmed_bert_100k = ModelMeta(
     loader=Model2VecModel,
     name="NeuML/pubmedbert-base-embeddings-100K",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="bac5e3b12fb8c650e92a19c41b436732c4f16e9e",
@@ -377,6 +386,7 @@ pubmed_bert_100k = ModelMeta(
 pubmed_bert_500k = ModelMeta(
     loader=Model2VecModel,
     name="NeuML/pubmedbert-base-embeddings-500K",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="34ba71e35c393fdad7ed695113f653feb407b16b",
@@ -400,6 +410,7 @@ pubmed_bert_500k = ModelMeta(
 pubmed_bert_1m = ModelMeta(
     loader=Model2VecModel,
     name="NeuML/pubmedbert-base-embeddings-1M",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="2b7fed222594708da6d88bcda92ae9b434b7ddd1",
@@ -423,6 +434,7 @@ pubmed_bert_1m = ModelMeta(
 pubmed_bert_2m = ModelMeta(
     loader=Model2VecModel,
     name="NeuML/pubmedbert-base-embeddings-2M",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="1d7bbe04d6713e425161146bfdc71473cbed498a",
@@ -446,6 +458,7 @@ pubmed_bert_2m = ModelMeta(
 pubmed_bert_8m = ModelMeta(
     loader=Model2VecModel,
     name="NeuML/pubmedbert-base-embeddings-8M",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="387d350015e963744f4fafe56a574b7cd48646c9",

mteb/models/model_implementations/moka_models.py

@@ -91,6 +91,7 @@ m3e_dataset = {
 m3e_base = ModelMeta(
     loader=sentence_transformers_loader,
     name="moka-ai/m3e-base",
+    model_type=["dense"],
     languages=["zho-Hans", "eng-Latn"],
     open_weights=True,
     revision="764b537a0e50e5c7d64db883f2d2e051cbe3c64c",
@@ -116,6 +117,7 @@ m3e_base = ModelMeta(
 m3e_small = ModelMeta(
     loader=sentence_transformers_loader,
     name="moka-ai/m3e-small",
+    model_type=["dense"],
     languages=["zho-Hans", "eng-Latn"],
     open_weights=True,
     revision="44c696631b2a8c200220aaaad5f987f096e986df",
@@ -141,6 +143,7 @@ m3e_small = ModelMeta(
 m3e_large = ModelMeta(
     loader=sentence_transformers_loader,
     name="moka-ai/m3e-large",
+    model_type=["dense"],
     languages=["zho-Hans", "eng-Latn"],
     open_weights=True,
     revision="12900375086c37ba5d83d1e417b21dc7d1d1f388",

mteb/models/model_implementations/mxbai_models.py

@@ -21,6 +21,7 @@ mxbai_embed_large_v1 = ModelMeta(
         },
     ),
     name="mixedbread-ai/mxbai-embed-large-v1",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="990580e27d329c7408b3741ecff85876e128e203",
@@ -57,6 +58,7 @@ mxbai_embed_large_v1 = ModelMeta(
 mxbai_embed_2d_large_v1 = ModelMeta(
     loader=sentence_transformers_loader,
     name="mixedbread-ai/mxbai-embed-2d-large-v1",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="7e639ca8e344af398876ead3b19ec3c0b9068f49",
@@ -81,6 +83,7 @@ mxbai_embed_2d_large_v1 = ModelMeta(
 mxbai_embed_xsmall_v1 = ModelMeta(
     loader=sentence_transformers_loader,
     name="mixedbread-ai/mxbai-embed-xsmall-v1",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="2f741ec33328bb57e4704e1238fc59a4a5745705",
@@ -99,4 +102,10 @@ mxbai_embed_xsmall_v1 = ModelMeta(
     public_training_code=None,
     public_training_data=None,
     training_datasets=mixedbread_training_data,
+    citation="""@online{xsmall2024mxbai,
+  title={Every Byte Matters: Introducing mxbai-embed-xsmall-v1},
+  author={Sean Lee and Julius Lipp and Rui Huang and Darius Koenig},
+  year={2024},
+  url={https://www.mixedbread.ai/blog/mxbai-embed-xsmall-v1},
+}""",
 )

mteb/models/model_implementations/nbailab.py

@@ -0,0 +1,70 @@
+from mteb.models.model_meta import ModelMeta, ScoringFunction
+from mteb.models.sentence_transformer_wrapper import (
+    SentenceTransformerEncoderWrapper,
+)
+
+nb_sbert = ModelMeta(
+    loader=SentenceTransformerEncoderWrapper,  # type: ignore[arg-type]
+    name="NbAiLab/nb-sbert-base",
+    model_type=["dense"],
+    languages=["nno-Latn", "nob-Latn", "swe-Latn", "dan-Latn"],
+    open_weights=True,
+    revision="b95656350a076aeafd2d23763660f80655408cc6",
+    release_date="2022-11-23",
+    n_parameters=1_780_000_000,
+    memory_usage_mb=678,
+    embed_dim=4096,
+    license="apache-2.0",
+    max_tokens=75,
+    reference="https://huggingface.co/NbAiLab/nb-sbert-base",
+    similarity_fn_name=ScoringFunction.COSINE,
+    framework=["Sentence Transformers", "PyTorch"],
+    use_instructions=False,
+    public_training_code=None,
+    public_training_data="https://huggingface.co/datasets/NbAiLab/mnli-norwegian",
+    training_datasets=set(),
+)
+
+nb_bert_large = ModelMeta(
+    loader=SentenceTransformerEncoderWrapper,  # type: ignore[arg-type]
+    name="NbAiLab/nb-bert-large",
+    model_type=["dense"],
+    languages=["nno-Latn", "nob-Latn"],
+    open_weights=True,
+    revision="f9d0fc184adab4dc354d85e1854b7634540d7550",
+    release_date="2021-04-29",
+    n_parameters=355087360,
+    memory_usage_mb=1359,
+    embed_dim=1024,
+    license="cc-by-4.0",
+    max_tokens=512,
+    reference="https://huggingface.co/NbAiLab/nb-bert-large",
+    similarity_fn_name=ScoringFunction.COSINE,
+    framework=["Sentence Transformers", "PyTorch"],
+    use_instructions=False,
+    public_training_code=None,
+    public_training_data="https://huggingface.co/NbAiLab/nb-bert-large#training-data",
+    training_datasets=set(),
+)
+
+nb_bert_base = ModelMeta(
+    loader=SentenceTransformerEncoderWrapper,  # type: ignore[arg-type]
+    name="NbAiLab/nb-bert-base",
+    model_type=["dense"],
+    languages=["nno-Latn", "nob-Latn"],
+    open_weights=True,
+    revision="9417c3f62a3adc99f17ff92bff446f35d011f994",
+    release_date="2021-01-13",
+    n_parameters=177853440,
+    memory_usage_mb=681,
+    embed_dim=768,
+    license="cc-by-4.0",
+    max_tokens=512,
+    reference="https://huggingface.co/NbAiLab/nb-bert-base",
+    similarity_fn_name=ScoringFunction.COSINE,
+    framework=["Sentence Transformers", "PyTorch"],
+    use_instructions=False,
+    public_training_code=None,
+    public_training_data="https://huggingface.co/NbAiLab/nb-bert-base#training-data",
+    training_datasets=set(),
+)

mteb/models/model_implementations/no_instruct_sentence_models.py

@@ -97,6 +97,7 @@ class NoInstructModel(AbsEncoder):
 no_instruct_small_v0 = ModelMeta(
     loader=NoInstructModel,
     name="avsolatorio/NoInstruct-small-Embedding-v0",
+    model_type=["dense"],
     languages=["eng-Latn"],
     open_weights=True,
     revision="b38747000553d8268915c95a55fc87e707c9aadd",