Add `text-embeddings-inference` tag & snippet

README.md

@@ -7,6 +7,7 @@ tags:
 - feature-extraction
 - sentence-similarity
 - transformers
+- text-embeddings-inference
 datasets:
 - flax-sentence-embeddings/stackexchange_xml
 - ms_marco
@@ -41,23 +42,23 @@ from sentence_transformers import SentenceTransformer, util
 query = "How many people live in London?"
 docs = ["Around 9 Million people live in London", "London is known for its financial district"]
 
-#Load the model
+# Load the model
 model = SentenceTransformer('sentence-transformers/multi-qa-mpnet-base-dot-v1')
 
-#Encode query and documents
+# Encode query and documents
 query_emb = model.encode(query)
 doc_emb = model.encode(docs)
 
-#Compute dot score between query and all document embeddings
+# Compute dot score between query and all document embeddings
 scores = util.dot_score(query_emb, doc_emb)[0].cpu().tolist()
 
-#Combine docs & scores
+# Combine docs & scores
 doc_score_pairs = list(zip(docs, scores))
 
-#Sort by decreasing score
+# Sort by decreasing score
 doc_score_pairs = sorted(doc_score_pairs, key=lambda x: x[1], reverse=True)
 
-#Output passages & scores
+# Output passages & scores
 for doc, score in doc_score_pairs:
     print(score, doc)
 ```
@@ -70,11 +71,11 @@ Without [sentence-transformers](https://www.SBERT.net), you can use the model li
 from transformers import AutoTokenizer, AutoModel
 import torch
 
-#CLS Pooling - Take output from first token
+# CLS Pooling - Take output from first token
 def cls_pooling(model_output):
     return model_output.last_hidden_state[:,0]
 
-#Encode text
+# Encode text
 def encode(texts):
     # Tokenize sentences
     encoded_input = tokenizer(texts, padding=True, truncation=True, return_tensors='pt')
@@ -97,24 +98,58 @@ docs = ["Around 9 Million people live in London", "London is known for its finan
 tokenizer = AutoTokenizer.from_pretrained("sentence-transformers/multi-qa-mpnet-base-dot-v1")
 model = AutoModel.from_pretrained("sentence-transformers/multi-qa-mpnet-base-dot-v1")
 
-#Encode query and docs
+# Encode query and docs
 query_emb = encode(query)
 doc_emb = encode(docs)
 
-#Compute dot score between query and all document embeddings
+# Compute dot score between query and all document embeddings
 scores = torch.mm(query_emb, doc_emb.transpose(0, 1))[0].cpu().tolist()
 
-#Combine docs & scores
+# Combine docs & scores
 doc_score_pairs = list(zip(docs, scores))
 
-#Sort by decreasing score
+# Sort by decreasing score
 doc_score_pairs = sorted(doc_score_pairs, key=lambda x: x[1], reverse=True)
 
-#Output passages & scores
+# Output passages & scores
 for doc, score in doc_score_pairs:
     print(score, doc)
 ```
 
+## Usage (Text Embeddings Inference (TEI))
+
+[Text Embeddings Inference (TEI)](https://github.com/huggingface/text-embeddings-inference) is a blazing fast inference solution for text embedding models.
+
+- CPU:
+```bash
+docker run -p 8080:80 -v hf_cache:/data --pull always ghcr.io/huggingface/text-embeddings-inference:cpu-latest \
+  --model-id sentence-transformers/multi-qa-mpnet-base-dot-v1 \
+  --pooling cls \
+  --dtype float16
+```
+
+- NVIDIA GPU:
+```bash
+docker run --gpus all -p 8080:80 -v hf_cache:/data --pull always ghcr.io/huggingface/text-embeddings-inference:cuda-latest \
+  --model-id sentence-transformers/multi-qa-mpnet-base-dot-v1 \
+  --pooling cls \
+  --dtype float16
+```
+
+Send a request to `/v1/embeddings` to generate embeddings via the [OpenAI Embeddings API](https://platform.openai.com/docs/api-reference/embeddings/create):
+```bash
+curl http://localhost:8080/v1/embeddings \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "sentence-transformers/multi-qa-mpnet-base-dot-v1",
+    "input": "How many people live in London?"
+  }'
+```
+
+Or check the [Text Embeddings Inference API specification](https://huggingface.github.io/text-embeddings-inference/) instead.
+
+----
+
 ## Technical Details
 
 In the following some technical details how this model must be used:
@@ -128,25 +163,22 @@ In the following some technical details how this model must be used:
 
 ----
 
-
 ## Background
 
 The project aims to train sentence embedding models on very large sentence level datasets using a self-supervised 
 contrastive learning objective. We use a contrastive learning objective: given a sentence from the pair, the model should predict which out of a set of randomly sampled other sentences, was actually paired with it in our dataset.
 
-We developped this model during the 
+We developed this model during the 
 [Community week using JAX/Flax for NLP & CV](https://discuss.huggingface.co/t/open-to-the-community-community-week-using-jax-flax-for-nlp-cv/7104), 
-organized by Hugging Face. We developped this model as part of the project:
-[Train the Best Sentence Embedding Model Ever with 1B Training Pairs](https://discuss.huggingface.co/t/train-the-best-sentence-embedding-model-ever-with-1b-training-pairs/7354). We benefited from efficient hardware infrastructure to run the project: 7 TPUs v3-8, as well as intervention from Googles Flax, JAX, and Cloud team member about efficient deep learning frameworks.
+organized by Hugging Face. We developed this model as part of the project:
+[Train the Best Sentence Embedding Model Ever with 1B Training Pairs](https://discuss.huggingface.co/t/train-the-best-sentence-embedding-model-ever-with-1b-training-pairs/7354). We benefited from efficient hardware infrastructure to run the project: 7 TPUs v3-8, as well as intervention from Google's Flax, JAX, and Cloud team members about efficient deep learning frameworks.
 
 ## Intended uses
 
-Our model is intented to be used for semantic search: It encodes queries / questions and text paragraphs in a dense vector space. It finds relevant documents for the given passages.
+Our model is intended to be used for semantic search: It encodes queries / questions and text paragraphs in a dense vector space. It finds relevant documents for the given passages.
 
 Note that there is a limit of 512 word pieces: Text longer than that will be truncated. Further note that the model was just trained on input text up to 250 word pieces. It might not work well for longer text. 
 
-
-
 ## Training procedure
 
 The full training script is accessible in this current repository: `train_script.py`.
@@ -162,9 +194,6 @@ We sampled each dataset given a weighted probability which configuration is deta
 
 The model was trained with [MultipleNegativesRankingLoss](https://www.sbert.net/docs/package_reference/losses.html#multiplenegativesrankingloss) using CLS-pooling, dot-product as similarity function, and a scale of 1.
 
-
-
-
 | Dataset                    | Number of training tuples  |
 |--------------------------------------------------------|:--------------------------:|
 | [WikiAnswers](https://github.com/afader/oqa#wikianswers-corpus) Duplicate question pairs from WikiAnswers |  77,427,422 |