Add Sentence Transformers support (#2)

- Increase model_max_length from 512 to 8192 (74d43807c92ef88423e6ab474db5b516eb70896d)
- Add return_dict to NomicBertModel; required for Sentence Transformers (cc70901626cf27a336a59983e1900bcb5834a364)
- Add Sentence Transformers support; add required files (bf6a73534d9d580c009ce67980a235dddc0ca49c)
- Update README + metadata (917a3bb4feca2915cec31d6e45d42d288b09a1ac)
- Merge branch 'main' of into integrations/sentence_transformers (89a809cbfa1e10d7c04a68c33caa6f044de3182a)

1_Pooling/config.json

@@ -1,10 +1,9 @@
 {
-    "word_embedding_dimension": 768,
-    "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
-  }
-  
+  "word_embedding_dimension": 768,
+  "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,10 +1,16 @@
 ---
+library_name: sentence-transformers
+pipeline_tag: sentence-similarity
+tags:
+  - feature-extraction
+  - sentence-similarity
+  - mteb
+  - transformers
+  - transformers.js
 license: apache-2.0
 language:
 - en
 inference: false
-tags:
-- mteb
 model-index:
 - name: epoch_0_model
   results:
@@ -2663,7 +2669,17 @@ Training data to train the models is released in its entirety. For more details,
 Note `nomic-embed-text` requires prefixes! We support the prefixes `[search_query, search_document, classification, clustering]`.
 For retrieval applications, you should prepend `search_document` for all your documents and `search_query` for your queries.
 
+### Sentence Transformers
+```python
+from sentence_transformers import SentenceTransformer
+
+model = SentenceTransformer("nomic-ai/nomic-embed-text-v1-unsupervised", trust_remote_code=True)
+sentences = ['search_query: What is TSNE?', 'search_query: Who is Laurens van der Maaten?']
+embeddings = model.encode(sentences)
+print(embeddings)
+```
 
+### Transformers
 ```python
 import torch
 import torch.nn.functional as F

config_sentence_transformers.json

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

modeling_hf_nomic_bert.py

@@ -1069,6 +1069,7 @@ class NomicBertModel(NomicBertPreTrainedModel):
         position_ids=None,
         token_type_ids=None,
         attention_mask=None,
+        return_dict=None,
     ):
         if token_type_ids is None:
             token_type_ids = torch.zeros_like(input_ids)
@@ -1080,7 +1081,7 @@ class NomicBertModel(NomicBertPreTrainedModel):
 
         attention_mask = self.get_extended_attention_mask(attention_mask, input_ids.shape)
         sequence_output = self.encoder(
-            hidden_states, attention_mask=attention_mask
+            hidden_states, attention_mask=attention_mask, return_dict=return_dict,
         )
 
         pooled_output = self.pooler(sequence_output) if self.pooler is not None else None

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"
+  }
+]

sentence_bert_config.json

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

tokenizer_config.json

@@ -46,7 +46,7 @@
   "cls_token": "[CLS]",
   "do_lower_case": true,
   "mask_token": "[MASK]",
-  "model_max_length": 512,
+  "model_max_length": 8192,
   "pad_token": "[PAD]",
   "sep_token": "[SEP]",
   "strip_accents": null,