add sentence-transformers support

1_Pooling/config.json

@@ -0,0 +1,7 @@
+{
+    "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
+}

README.md

@@ -45,7 +45,7 @@ batch_dict = tokenizer(input_texts, max_length=512, padding=True, truncation=Tru
 outputs = model(**batch_dict)
 embeddings = average_pool(outputs.last_hidden_state, batch_dict['attention_mask'])
 
-# (Optionally) normalize embeddings
+# normalize embeddings
 embeddings = F.normalize(embeddings, p=2, dim=1)
 scores = (embeddings[:2] @ embeddings[2:].T) * 100
 print(scores.tolist())
@@ -60,6 +60,44 @@ Please refer to our paper at [https://arxiv.org/pdf/2212.03533.pdf](https://arxi
 Check out [unilm/e5](https://github.com/microsoft/unilm/tree/master/e5) to reproduce evaluation results 
 on the [BEIR](https://arxiv.org/abs/2104.08663) and [MTEB benchmark](https://arxiv.org/abs/2210.07316).
 
+## Support for Sentence Transformers
+
+Below is an example for usage with sentence_transformers.
+```python
+from sentence_transformers import SentenceTransformer
+model = SentenceTransformer('intfloat/e5-large-unsupervised')
+input_texts = [
+    'query: how much protein should a female eat',
+    'query: summit define',
+    "passage: 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.",
+    "passage: 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."
+]
+embeddings = model.encode(input_texts, normalize_embeddings=True)
+```
+
+Package requirements
+
+`pip install sentence_transformers~=2.2.2`
+
+Contributors: [michaelfeil](https://huggingface.co/michaelfeil)
+
+## FAQ
+
+**1. Do I need to add the prefix "query: " and "passage: " to input texts?**
+
+Yes, this is how the model is trained, otherwise you will see a performance degradation.
+
+Here are some rules of thumb:
+- Use "query: " and "passage: " correspondingly for asymmetric tasks such as passage retrieval in open QA, ad-hoc information retrieval.
+
+- Use "query: " prefix for symmetric tasks such as semantic similarity, paraphrase retrieval.
+
+- Use "query: " prefix if you want to use embeddings as features, such as linear probing classification, clustering.
+
+**2. Why are my reproduced results slightly different from reported in the model card?**
+
+Different versions of `transformers` and `pytorch` could cause negligible but non-zero performance differences.
+
 ## Citation
 
 If you find our paper or models helpful, please consider cite as follows:
@@ -75,4 +113,4 @@ If you find our paper or models helpful, please consider cite as follows:
 
 ## Limitations
 
-This model only works for English texts. Long texts will be truncated to at most 512 tokens.
+This model only works for English texts. Long texts will be truncated to at most 512 tokens.

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": 512,
+    "do_lower_case": false
+}