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

- Add `text-embeddings-inference` tag & snippet (d21f62f2ced8493148c5417b392bb39cb698d1e1)
- Update README.md (683fd8e6b35c64bd99cbd5f8d845f6098d98087d)
- embeddings models -> embedding models (0b27657c66732a78fc7a3960e54794adca3cfe1d)


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

README.md

@@ -7,6 +7,7 @@ tags:
 - feature-extraction
 - sentence-similarity
 - transformers
+- text-embeddings-inference
 pipeline_tag: sentence-similarity
 new_version: sentence-transformers/all-mpnet-base-v2
 ---
@@ -71,6 +72,33 @@ 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/all-mpnet-base-v1 --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/all-mpnet-base-v1 --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 \
+  -X POST \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "sentence-transformers/all-mpnet-base-v1",
+    "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.
+
 ------
 
 ## Background
@@ -79,19 +107,18 @@ The project aims to train sentence embedding models on very large sentence level
 contrastive learning objective. We used the pretrained [`microsoft/mpnet-base`](https://huggingface.co/microsoft/mpnet-base) model and fine-tuned in on a 
 1B sentence pairs dataset. 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 as a sentence and short paragraph encoder. Given an input text, it ouptuts a vector which captures 
+Our model is intended to be used as a sentence and short paragraph encoder. Given an input text, it outputs a vector which captures 
 the semantic information. The sentence vector may be used for information retrieval, clustering or sentence similarity tasks.
 
 By default, input text longer than 128 word pieces is truncated.
 
-
 ## Training procedure
 
 ### Pre-training 
@@ -103,9 +130,9 @@ We use the pretrained [`microsoft/mpnet-base`](https://huggingface.co/microsoft/
 We fine-tune the model using a contrastive objective. Formally, we compute the cosine similarity from each possible sentence pairs from the batch.
 We then apply the cross entropy loss by comparing with true pairs.
 
-#### Hyper parameters
+#### Hyperparameters
 
-We trained ou model on a TPU v3-8. We train the model during 920k steps using a batch size of 512 (64 per TPU core).
+We trained our model on a TPU v3-8. We train the model during 920k steps using a batch size of 512 (64 per TPU core).
 We use a learning rate warm up of 500. The sequence length was limited to 128 tokens. We used the AdamW optimizer with
 a 2e-5 learning rate. The full training script is accessible in this current repository: `train_script.py`.
 
@@ -136,7 +163,7 @@ We sampled each dataset given a weighted probability which configuration is deta
 | [Eli5](https://huggingface.co/datasets/eli5) | [paper](https://doi.org/10.18653/v1/p19-1346) | 325,475 |
 | [Flickr 30k](https://shannon.cs.illinois.edu/DenotationGraph/) | [paper](https://transacl.org/ojs/index.php/tacl/article/view/229/33) | 317,695 |
 | [Stack Exchange](https://huggingface.co/datasets/flax-sentence-embeddings/stackexchange_xml) Duplicate questions (titles) | | 304,525 |
-| AllNLI ([SNLI](https://nlp.stanford.edu/projects/snli/) and [MultiNLI](https://cims.nyu.edu/~sbowman/multinli/) | [paper SNLI](https://doi.org/10.18653/v1/d15-1075), [paper MultiNLI](https://doi.org/10.18653/v1/n18-1101) | 277,230 | 
+| AllNLI ([SNLI](https://nlp.stanford.edu/projects/snli/) and [MultiNLI](https://cims.nyu.edu/~sbowman/multinli/)) | [paper SNLI](https://doi.org/10.18653/v1/d15-1075), [paper MultiNLI](https://doi.org/10.18653/v1/n18-1101) | 277,230 | 
 | [Stack Exchange](https://huggingface.co/datasets/flax-sentence-embeddings/stackexchange_xml) Duplicate questions (bodies) | | 250,519 |
 | [Stack Exchange](https://huggingface.co/datasets/flax-sentence-embeddings/stackexchange_xml) Duplicate questions (titles+bodies) | | 250,460 |
 | [Sentence Compression](https://github.com/google-research-datasets/sentence-compression) | [paper](https://www.aclweb.org/anthology/D13-1155/) | 180,000 |