Simplify usage; integrate Sentence Transformers (+ LlamaIndex/LangChain, etc.) (#1)

- Integrate Linq-Embed-Mistral with Sentence Transformers (e108f5efd5ecef01c5e7096883390705cfeec446)

1_Pooling/config.json

@@ -0,0 +1,10 @@
+{
+  "word_embedding_dimension": 4096,
+  "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:
 - mteb
 - transformers
+- sentence-transformers
 model-index:
 - name: Linq-Embed-Mistral
   results:
@@ -1792,9 +1793,39 @@ For more details, refer to [this blog post](https://getlinq.com/blog/linq-embed-
 
 ## How to use
 
-### Transformers
+Here is an example of how to encode queries and passages from the Mr.TyDi training dataset, both with Sentence Transformers or Transformers directly.
+
+### Sentence Transformers
+
+```python
+from sentence_transformers import SentenceTransformer
+
+# Load the model
+model = SentenceTransformer("Linq-AI-Research/Linq-Embed-Mistral")
 
-Here is an example of how to encode queries and passages from the Mr.TyDi training dataset.
+# Each query must come with a one-sentence instruction that describes the task
+task = 'Given a question, retrieve Wikipedia passages that answer the question'
+prompt = f"Instruct: {task}\nQuery: "
+queries = [
+    "최초의 원자력 발전소는 무엇인가?",
+    "Who invented Hangul?"
+]
+passages = [
+    "현재 사용되는 핵분열 방식을 이용한 전력생산은 1948년 9월 미국 테네시주 오크리지에 설치된 X-10 흑연원자로에서 전구의 불을 밝히는 데 사용되면서 시작되었다. 그리고 1954년 6월에 구소련의 오브닌스크에 건설된 흑연감속 비등경수 압력관형 원자로를 사용한 오브닌스크 원자력 발전소가 시험적으로 전력생산을 시작하였고, 최초의 상업용 원자력 엉더이로를 사용한 영국 셀라필드 원자력 단지에 위치한 콜더 홀(Calder Hall) 원자력 발전소로, 1956년 10월 17일 상업 운전을 시작하였다.",
+    "Hangul was personally created and promulgated by the fourth king of the Joseon dynasty, Sejong the Great.[1][2] Sejong's scholarly institute, the Hall of Worthies, is often credited with the work, and at least one of its scholars was heavily involved in its creation, but it appears to have also been a personal project of Sejong."
+]
+
+# Encode the queries and passages. We only use the prompt for the queries
+query_embeddings = model.encode(queries, prompt=prompt)
+passage_embeddings = model.encode(passages)
+
+# Compute the (cosine) similarity scores
+scores = model.similarity(query_embeddings, passage_embeddings) * 100
+print(scores.tolist())
+# [[73.72908782958984, 30.122787475585938], [29.15508460998535, 79.25375366210938]]
+```
+
+### Transformers
 
 ```python
 import torch

config_sentence_transformers.json

@@ -0,0 +1,10 @@
+{
+  "__version__": {
+    "sentence_transformers": "3.0.0",
+    "transformers": "4.41.2",
+    "pytorch": "2.3.0+cu121"
+  },
+  "prompts": {},
+  "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": 32768,
+  "do_lower_case": false
+}