Skip to content

Commit 5602678

Browse files
authored
Revise README for better structure and clarity
Updated README.md to enhance formatting and content clarity.
1 parent 524b18a commit 5602678

File tree

1 file changed

+16
-26
lines changed

1 file changed

+16
-26
lines changed

README.md

Lines changed: 16 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
# 🔥 Single Model Embedding & Reranking API
22

3-
<div align="center">
4-
<strong>Lightning-fast local embeddings & reranking for Apple Silicon (MLX-first, OpenAI & TEI compatible)</strong>
5-
<br/><br/>
6-
<a href="https://pypi.org/project/embed-rerank/"><img src="https://img.shields.io/pypi/v/embed-rerank?logo=pypi&logoColor=white" /></a>
7-
<a href="https://pypi.org/project/embed-rerank/"><img src="https://img.shields.io/pypi/dm/embed-rerank?logo=pypi&logoColor=---
3+
<p align="center">
4+
<a href="https://pypi.org/project/embed-rerank/">
5+
<img src="https://img.shields.io/pypi/v/embed-rerank?logo=pypi&logoColor=white" alt="PyPI Version" />
6+
</a>
7+
<a href="https://github.com/joonsoo-me/embed-rerank/blob/main/LICENSE"><img src="https://img.shields.io/github/license/joonsoo-me/embed-rerank?logo=opensource&logoColor=white" /></a>
8+
<a href="https://developer.apple.com/silicon/"><img src="https://img.shields.io/badge/Apple_Silicon-Ready-blue?logo=apple&logoColor=white" /></a>
9+
<a href="https://ml-explore.github.io/mlx/"><img src="https://img.shields.io/badge/MLX-Optimized-green?logo=apple&logoColor=white" /></a>
10+
<a href="https://fastapi.tiangolo.com/"><img src="https://img.shields.io/badge/FastAPI-009688?logo=fastapi&logoColor=white" /></a>
11+
</p>
12+
13+
Lightning-fast local embeddings & reranking for Apple Silicon (MLX-first). OpenAI, TEI, and Cohere compatible.
814

915
## 🔧 Troubleshooting
1016

@@ -62,15 +68,7 @@ Notes:
6268

6369
---
6470

65-
## 📄 License
6671

67-
MIT License - build amazing things with this code!" /></a>
68-
<a href="https://pypi.org/project/embed-rerank/"><img src="https://img.shields.io/pypi/pyversions/embed-rerank?logo=python&logoColor=white" /></a>
69-
<a href="https://github.com/joonsoo-me/embed-rerank/blob/main/LICENSE"><img src="https://img.shields.io/github/license/joonsoo-me/embed-rerank?logo=opensource&logoColor=white" /></a>
70-
<a href="https://developer.apple.com/silicon/"><img src="https://img.shields.io/badge/Apple_Silicon-Ready-blue?logo=apple&logoColor=white" /></a>
71-
<a href="https://ml-explore.github.io/mlx/"><img src="https://img.shields.io/badge/MLX-Optimized-green?logo=apple&logoColor=white" /></a>
72-
<a href="https://fastapi.tiangolo.com/"><img src="https://img.shields.io/badge/FastAPI-009688?logo=fastapi&logoColor=white" /></a>
73-
</div>
7472

7573
---
7674

@@ -275,13 +273,11 @@ response = client.embeddings.create(
275273
)
276274
# 🚀 10x faster than OpenAI, same code!
277275

278-
"""
279-
Base64 encoding support
280-
-----------------------
276+
```
281277

282-
For OpenAI-compatible calls, you can request base64-encoded embeddings by setting `encoding_format` to `"base64"`. This is useful when transporting vectors through systems that expect strings only.
278+
#### Base64 encoding (OpenAI-compatible)
283279

284-
Example (Python OpenAI SDK):
280+
You can request base64-encoded embeddings by setting `encoding_format="base64"`. This is useful when transporting vectors through systems that expect strings only.
285281

286282
```python
287283
response = client.embeddings.create(
@@ -298,8 +294,6 @@ arr = np.frombuffer(base64.b64decode(response.data[0].embedding), dtype=np.float
298294
Notes:
299295
- `encoding_format` defaults to `"float"` (list[float]).
300296
- `dimensions` is accepted and will truncate/pad to the requested size when supported.
301-
"""
302-
```
303297

304298
### TEI Compatible
305299

@@ -422,9 +416,6 @@ embed-rerank --test full --test-url http://localhost:9000
422416

423417
### 🔧 Advanced Testing (Source Code)
424418

425-
```bash
426-
### 🔧 Advanced Testing (Source Code)
427-
428419
For development and comprehensive testing with the source code:
429420

430421
```bash
@@ -483,7 +474,6 @@ embed-rerank --port 9000 &
483474
```
484475

485476
> **Windows Support**: Coming soon! Currently optimized for macOS/Linux.
486-
```
487477
488478
---
489479

@@ -520,7 +510,7 @@ embed-rerank --port 9000 &
520510

521511
---
522512

523-
## Quick Reference
513+
## 📝 Quick Reference
524514

525515
### Installation & Startup
526516
```bash
@@ -564,6 +554,6 @@ flake8 app/ tests/ --max-line-length=120 --extend-ignore=E203,W503 # Linting
564554

565555
---
566556

567-
## 📄 License
557+
## 📄 License
568558

569559
MIT License - build amazing things with this code!

0 commit comments

Comments
 (0)