Integrate with Sentence Transformers (+ third parties like LangChain/Haystack/LlamaIndex, etc.) (#1)

- Integrate with Sentence Transformers (508b240524f06e133dc4312b9b14646fe09d2caf)

1_Pooling/config.json

@@ -0,0 +1,10 @@
+{
+  "word_embedding_dimension": 3584,
+  "pooling_mode_cls_token": false,
+  "pooling_mode_mean_tokens": false,
+  "pooling_mode_max_tokens": false,
+  "pooling_mode_mean_sqrt_len_tokens": false,
+  "pooling_mode_weightedmean_tokens": false,
+  "pooling_mode_lasttoken": true,
+  "include_prompt": true
+}

README.md

@@ -2,6 +2,7 @@
 tags:
 - feature-extraction
 - sentence-similarity
+- sentence-transformers
 - transformers
 - mteb
 license: gemma
@@ -8835,6 +8836,38 @@ print(similarity)
 By default, FlagLLMModel will use all available GPUs when encoding. Please set `os.environ["CUDA_VISIBLE_DEVICES"]` to select specific GPUs.
 You also can set `os.environ["CUDA_VISIBLE_DEVICES"]=""` to make all GPUs unavailable.
 
+### Using Sentence Transformers
+
+```python
+from sentence_transformers import SentenceTransformer
+import torch
+
+# Load the model, optionally in float16 precision for faster inference
+model = SentenceTransformer("BAAI/bge-multilingual-gemma2", model_kwargs={"torch_dtype": torch.float16})
+
+# Prepare a prompt given an instruction
+instruction = 'Given a web search query, retrieve relevant passages that answer the query.'
+prompt = f'<instruct>{instruction}\n<query>'
+# Prepare queries and documents
+queries = [
+    'how much protein should a female eat',
+    'summit define',
+]
+documents = [
+    "As a general guideline, the CDC's average requirement of protein for women ages 19 to 70 is 46 grams per day. But, as you can see from this chart, you'll need to increase that if you're expecting or training for a marathon. Check out the chart below to see how much protein you should be eating each day.",
+    "Definition of summit for English Language Learners. : 1  the highest point of a mountain : the top of a mountain. : 2  the highest level. : 3  a meeting or series of meetings between the leaders of two or more governments."
+]
+
+# Compute the query and document embeddings
+query_embeddings = model.encode(queries, prompt=prompt)
+document_embeddings = model.encode(documents)
+
+# Compute the cosine similarity between the query and document embeddings
+similarities = model.similarity(query_embeddings, document_embeddings)
+print(similarities)
+# tensor([[ 0.5591,  0.0164],
+#         [-0.0026,  0.4993]], dtype=torch.float16)
+```
 
 ### Using HuggingFace Transformers
 ```python

config_sentence_transformers.json

@@ -0,0 +1,12 @@
+{
+  "__version__": {
+    "sentence_transformers": "3.0.1",
+    "transformers": "4.42.3",
+    "pytorch": "2.3.1+cu121"
+  },
+  "prompts": {
+    "web_search_query": "<instruct>Given a web search query, retrieve relevant passages that answer the query.\n<query>"
+  },
+  "default_prompt_name": null,
+  "similarity_fn_name": "cosine"
+}

modules.json

@@ -0,0 +1,14 @@
+[
+  {
+    "idx": 0,
+    "name": "0",
+    "path": "",
+    "type": "sentence_transformers.models.Transformer"
+  },
+  {
+    "idx": 1,
+    "name": "1",
+    "path": "1_Pooling",
+    "type": "sentence_transformers.models.Pooling"
+  }
+]

sentence_bert_config.json

@@ -0,0 +1,4 @@
+{
+  "max_seq_length": 8192,
+  "do_lower_case": false
+}