alvarobartt HF Staff commited on
Commit
a96370d
·
verified ·
1 Parent(s): 12e86a3

Add `text-embeddings-inference` tag & snippet

Browse files

## Description

- Add `text-embeddings-inference` tag to improve discoverability
- Adds a sample snippet on how to run Text Embeddings Inference (TEI) via Docker

⚠️ **This PR has been generated automatically, so please review it before merging.**

Files changed (1) hide show
  1. README.md +27 -0
README.md CHANGED
@@ -7,6 +7,7 @@ tags:
7
  - feature-extraction
8
  - sentence-similarity
9
  - transformers
 
10
  datasets:
11
  - s2orc
12
  - flax-sentence-embeddings/stackexchange_xml
@@ -92,6 +93,32 @@ print("Sentence embeddings:")
92
  print(sentence_embeddings)
93
  ```
94
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
95
  ------
96
 
97
  ## Background
 
7
  - feature-extraction
8
  - sentence-similarity
9
  - transformers
10
+ - text-embeddings-inference
11
  datasets:
12
  - s2orc
13
  - flax-sentence-embeddings/stackexchange_xml
 
93
  print(sentence_embeddings)
94
  ```
95
 
96
+ ## Usage (Text Embeddings Inference (TEI))
97
+
98
+ [Text Embeddings Inference (TEI)](https://github.com/huggingface/text-embeddings-inference) is a blazing fast inference solution for text embedings models.
99
+
100
+ - CPU:
101
+ ```bash
102
+ 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-v2 --pooling mean --dtype float16
103
+ ```
104
+
105
+ - NVIDIA GPU:
106
+ ```bash
107
+ 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-v2 --pooling mean --dtype float16
108
+ ```
109
+
110
+ Send a request to the `/v1/embeddings` to generate embeddings via the [OpenAI Embeddings API](https://platform.openai.com/docs/api-reference/embeddings/create):
111
+ ```bash
112
+ curl http://localhost:8080/v1/embeddings \
113
+ -H 'Content-Type: application/json' \
114
+ -d '{
115
+ "model": "sentence-transformers/all-mpnet-base-v2",
116
+ "input": ["This is an example sentence", "Each sentence is converted"]
117
+ }'
118
+ ```
119
+
120
+ Or check the [Text Embeddings Inference API specification](https://huggingface.github.io/text-embeddings-inference/) instead.
121
+
122
  ------
123
 
124
  ## Background