Update README.md
Browse files
README.md
CHANGED
|
@@ -5,6 +5,36 @@ colorFrom: blue
|
|
| 5 |
colorTo: purple
|
| 6 |
sdk: docker
|
| 7 |
pinned: false
|
|
|
|
| 8 |
---
|
| 9 |
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 5 |
colorTo: purple
|
| 6 |
sdk: docker
|
| 7 |
pinned: false
|
| 8 |
+
license: mit
|
| 9 |
---
|
| 10 |
|
| 11 |
+
# Generate Embeddings API
|
| 12 |
+
|
| 13 |
+
## Overview
|
| 14 |
+
|
| 15 |
+
This API provides a simple interface to generate sentence embeddings using **Sentence Transformers** models. The service exposes endpoints where you can send sentences and receive their respective embeddings in a JSON response.
|
| 16 |
+
|
| 17 |
+
## 🚀 Features
|
| 18 |
+
|
| 19 |
+
- Generate sentence embeddings using two different pre-trained models:
|
| 20 |
+
- **all-MiniLM-L6-v2**
|
| 21 |
+
- **intfloat/e5-large-v2**
|
| 22 |
+
|
| 23 |
+
- JSON response with embeddings for each sentence.
|
| 24 |
+
|
| 25 |
+
- **FastAPI** backend with easy-to-use endpoints.
|
| 26 |
+
|
| 27 |
+
## 🔧 Requirements
|
| 28 |
+
|
| 29 |
+
- Python 3.7+
|
| 30 |
+
- FastAPI
|
| 31 |
+
- SentenceTransformers
|
| 32 |
+
- Uvicorn (for running the app)
|
| 33 |
+
|
| 34 |
+
### Install dependencies
|
| 35 |
+
|
| 36 |
+
To install all the required dependencies, run the following:
|
| 37 |
+
|
| 38 |
+
```bash
|
| 39 |
+
pip install -r requirements.txt
|
| 40 |
+
|