Add Sentence Transformers support (#2)

- Add Sentence Transformers support (2df654a1816d9d71137d5ef0979718fc8842ada2)

1_Pooling/config.json

@@ -0,0 +1,9 @@
+{
+  "word_embedding_dimension": 1024,
+  "pooling_mode_cls_token": false,
+  "pooling_mode_mean_tokens": true,
+  "pooling_mode_max_tokens": false,
+  "pooling_mode_mean_sqrt_len_tokens": false,
+  "pooling_mode_weightedmean_tokens": false,
+  "pooling_mode_lasttoken": false
+}

README.md

@@ -1,6 +1,8 @@
 ---
 tags:
 - mteb
+- sentence-transformers
+- transformers
 model-index:
 - name: multilingual-e5-large-instruct
   results:
@@ -5390,7 +5392,9 @@ This model has 24 layers and the embedding size is 1024.
 
 ## Usage
 
-Below is an example to encode queries and passages from the MS-MARCO passage ranking dataset.
+Below are examples to encode queries and passages from the MS-MARCO passage ranking dataset.
+
+### Transformers
 
 ```python
 import torch.nn.functional as F
@@ -5433,6 +5437,36 @@ embeddings = average_pool(outputs.last_hidden_state, batch_dict['attention_mask'
 embeddings = F.normalize(embeddings, p=2, dim=1)
 scores = (embeddings[:2] @ embeddings[2:].T) * 100
 print(scores.tolist())
+# => [[91.92852783203125, 67.580322265625], [70.3814468383789, 92.1330795288086]]
+```
+
+### Sentence Transformers
+
+```python
+from sentence_transformers import SentenceTransformer
+
+def get_detailed_instruct(task_description: str, query: str) -> str:
+    return f'Instruct: {task_description}\nQuery: {query}'
+
+# Each query must come with a one-sentence instruction that describes the task
+task = 'Given a web search query, retrieve relevant passages that answer the query'
+queries = [
+    get_detailed_instruct(task, 'how much protein should a female eat'),
+    get_detailed_instruct(task, '南瓜的家常做法')
+]
+# No need to add instruction for retrieval documents
+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.",
+    "1.清炒南瓜丝 原料:嫩南瓜半个 调料:葱、盐、白糖、鸡精 做法: 1、南瓜用刀薄薄的削去表面一层皮,用勺子刮去瓤 2、擦成细丝(没有擦菜板就用刀慢慢切成细丝) 3、锅烧热放油,入葱花煸出香味 4、入南瓜丝快速翻炒一分钟左右,放盐、一点白糖和鸡精调味出锅 2.香葱炒南瓜 原料:南瓜1只 调料:香葱、蒜末、橄榄油、盐 做法: 1、将南瓜去皮,切成片 2、油锅8成热后,将蒜末放入爆香 3、爆香后,将南瓜片放入,翻炒 4、在翻炒的同时,可以不时地往锅里加水,但不要太多 5、放入盐,炒匀 6、南瓜差不多软和绵了之后,就可以关火 7、撒入香葱,即可出锅"
+]
+input_texts = queries + documents
+
+model = SentenceTransformer('intfloat/multilingual-e5-large-instruct')
+
+embeddings = model.encode(input_texts, convert_to_tensor=True, normalize_embeddings=True)
+scores = (embeddings[:2] @ embeddings[2:].T) * 100
+print(scores.tolist())
+# [[91.92853546142578, 67.5802993774414], [70.38143157958984, 92.13307189941406]]
 ```
 
 ## Supported Languages

config_sentence_transformers.json

@@ -0,0 +1,7 @@
+{
+  "__version__": {
+    "sentence_transformers": "2.4.0.dev0",
+    "transformers": "4.37.0",
+    "pytorch": "2.1.0+cu121"
+  }
+}

modules.json

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