KaLM-embedding-multilingual-mini

📑 Open-source Plan

• [x] Model Checkpoint
  • [x] KaLM-embedding-multilingual-mini-v1
  • [x] KaLM-embedding-multilingual-mini-instruct-v1
  • [x] KaLM-embedding-multilingual-mini-instruct-v1.5
  • [ ] KaLM-embedding-multilingual-max-v1
• [x] Training and Evaluation Code: HITsz-TMG/KaLM-Embedding
• [x] Technical Report: KaLM-Embedding: Superior Training Data Brings A Stronger Embedding Model
• [ ] Training Data

Evaluation

Requirements

Since we have used the Qwen2 model, we advise you to install transformers>=4.37.0, or you might encounter the following error:

KeyError: 'qwen2'

Usage

Using this model becomes easy when you have sentence-transformers installed:

pip install -U sentence-transformers

Then you can use the model like this:

from sentence_transformers import SentenceTransformer

sentences = ["This is an example sentence", "Each sentence is converted"]

model = SentenceTransformer('{MODEL_NAME_OR_PATH}')   # Do NOT set trust_remote_code
model.max_seq_length = 512

embeddings = model.encode(
    sentences,
    normalize_embeddings=True,
    batch_size=256,
    show_progress_bar=True
    )
print(embeddings)

We add instruction for classification and clustering. If you want to add instruction to the query (no instruction for the corpus), you can use the model like this:

from sentence_transformers import SentenceTransformer

sentences = ["This is an example sentence", "Each sentence is converted"]

model = SentenceTransformer('{MODEL_NAME_OR_PATH}')   # Do NOT set trust_remote_code
model.max_seq_length = 512

prompt = "Instruct: Classifying the category of french news. \n Query: "
embeddings = model.encode(
    sentences,
    prompt=prompt,
    normalize_embeddings=True,
    batch_size=256,
    show_progress_bar=True
    )
print(embeddings)

Contact

If you encounter any issue, feel free to contact us via the email: yanshek.woo@gmail.com