Skip to content

Commit eaebcdb

Browse files
committed
docs: Update README with performance metrics and API examples
1 parent b513528 commit eaebcdb

File tree

1 file changed

+35
-38
lines changed

1 file changed

+35
-38
lines changed

README.md

Lines changed: 35 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,12 @@ For GPU-accelerated vision features:
9191
docker-compose -f docker-compose.gpu.yml up -d
9292
```
9393

94-
Or configure LM Studio:
95-
1. Download [LM Studio](https://lmstudio.ai/)
96-
2. Load model: `llava-1.6-mistral-7b` Q6_K
97-
3. Start server on port 1234
94+
## ⚙️ Models
95+
| Component | Default | Source | Approx Size |
96+
|-----------|---------|--------|-------------|
97+
| Text/Vision (LLaVA) | llava-1.6-mistral-7b Q6_K | LM Studio | ~5–7 GB |
98+
| Text Embeddings | nomic-embed-text | Hugging Face | ~300 MB |
99+
| CLIP | ViT-L/14 | Hugging Face | ~1 GB |
98100

99101
## 📊 **Architecture**
100102

@@ -146,14 +148,14 @@ GOOGLE_REDIRECT_URI=http://127.0.0.1:8000/api/v1/gdrive/callback
146148

147149
Tested on RTX 4090:
148150

149-
| Operation | Performance |
150-
|-----------|------------|
151-
| Text Embedding | ~100ms/document |
152-
| Image Embedding | ~300ms/image |
153-
| Vision Analysis | 2-5s/image |
154-
| Vector Search | <50ms |
155-
| Hybrid Search | <100ms |
156-
| Document Processing | 200 docs/minute |
151+
| Operation | Performance | Conditions |
152+
|-----------|-------------|-----------|
153+
| Text Embedding | ~100ms/doc | batch=16 |
154+
| Image Embedding | ~300ms/image | 4090, fp16 |
155+
| Vision Analysis | 25s/image | 1024px |
156+
| Vector Search | <50ms | top_k=10 |
157+
| Hybrid Search | <100ms | rerank enabled |
158+
| Doc Processing | 200 docs/min | avg 1 KB chunks |
157159

158160
## 🔄 **API Endpoints**
159161

@@ -181,39 +183,37 @@ Tested on RTX 4090:
181183
- `POST /llava/analyze` - Vision analysis
182184
- `POST /llava/extract-text` - OCR
183185

184-
## 🎯 **Use Cases**
186+
## 🧪 API Examples
185187

186-
- **Personal Knowledge Base**: Store and search all your notes, documents, and ideas
187-
- **Research Assistant**: Analyze papers, extract insights, build connections
188-
- **Document Management**: OCR, categorization, and intelligent search
189-
- **Learning System**: Track learning progress, discover patterns
190-
- **Creative Projects**: Manage inspiration, references, and iterations
191-
- **Code Documentation**: Understand codebases with multimodal analysis
192-
193-
## 🛠️ **Development**
194-
195-
### Running Tests
188+
Create a memory:
196189
```bash
197-
pytest tests/ -v
190+
curl -X POST http://localhost:8000/api/v1/memories \
191+
-H "Content-Type: application/json" \
192+
-d '{"type":"text","content":"Graph neural nets paper notes","tags":["gnn","research"]}'
198193
```
199194

200-
### Code Quality
195+
Semantic search:
201196
```bash
202-
# Format code
203-
black app/ tests/
204-
205-
# Lint
206-
ruff check app/
207-
208-
# Type checking
209-
mypy app/
197+
curl -X POST http://localhost:8000/api/v1/search \
198+
-H "Content-Type: application/json" \
199+
-d '{"query":"recent notes about vision transformers","limit":5}'
210200
```
211201

212-
### Docker Development
202+
Image similarity:
213203
```bash
214-
docker-compose up --build
204+
curl -X POST http://localhost:8000/api/v1/search/image \
205+
-F file=@example.jpg
215206
```
216207

208+
## 🎯 **Use Cases**
209+
210+
- **Personal Knowledge Base**: Store and search all your notes, documents, and ideas
211+
- **Research Assistant**: Analyze papers, extract insights, build connections
212+
- **Document Management**: OCR, categorization, and intelligent search
213+
- **Learning System**: Track learning progress, discover patterns
214+
- **Creative Projects**: Manage inspiration, references, and iterations
215+
- **Code Documentation**: Understand codebases with multimodal analysis
216+
217217
## 📚 **Documentation**
218218

219219
- [API Documentation](http://localhost:8000/docs)
@@ -225,9 +225,6 @@ docker-compose up --build
225225

226226
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
227227

228-
## 📄 **License**
229-
230-
MIT License - see [LICENSE](LICENSE) file.
231228

232229
## 🙏 **Acknowledgments**
233230

0 commit comments

Comments
 (0)