Add `text-embeddings-inference` tag & snippet (#3)

- Add `text-embeddings-inference` tag & snippet (7dbeedb9dc39d001dc7d9a59ebc274b24f4ce72a)
- move Usage, embeddings models -> embedding models (e64d277e11c669c330425e2a03fb24568f633dbb)


Co-authored-by: Alvaro Bartolome <[email protected]>

README.md

@@ -6,6 +6,7 @@ tags:
 - feature-extraction
 - sentence-similarity
 - transformers
+- text-embeddings-inference
 pipeline_tag: sentence-similarity
 ---
 
@@ -44,9 +45,9 @@ from transformers import AutoTokenizer, AutoModel
 import torch
 
 
-#Mean Pooling - Take attention mask into account for correct averaging
+# Mean Pooling - Take attention mask into account for correct averaging
 def mean_pooling(model_output, attention_mask):
-    token_embeddings = model_output[0] #First element of model_output contains all token embeddings
+    token_embeddings = model_output[0] # First element of model_output contains all token embeddings
     input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
     return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9)
 
@@ -65,14 +66,38 @@ encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tenso
 with torch.no_grad():
     model_output = model(**encoded_input)
 
-# Perform pooling. In this case, max pooling.
+# Perform pooling. In this case, mean pooling.
 sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])
 
 print("Sentence embeddings:")
 print(sentence_embeddings)
 ```
 
+## 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/stsb-mpnet-base-v2 --pooling mean --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/stsb-mpnet-base-v2 --pooling mean --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/stsb-mpnet-base-v2",
+    "input": ["This is an example sentence", "Each sentence is converted"]
+  }'
+```
+
+Or check the [Text Embeddings Inference API specification](https://huggingface.github.io/text-embeddings-inference/) instead.
 
 ## Full Model Architecture
 ```
@@ -97,4 +122,4 @@ If you find this model helpful, feel free to cite our publication [Sentence-BERT
     publisher = "Association for Computational Linguistics",
     url = "http://arxiv.org/abs/1908.10084",
 }
-```
+```