AndrΓ© Oliveira
commited on
Commit
Β·
48613bb
1
Parent(s):
59e6760
docs: udpated README
Browse files
README.md
CHANGED
|
@@ -1,73 +1,14 @@
|
|
| 1 |
-
# Ragmint MCP HF Space
|
| 2 |
-
|
| 3 |
-
This project is a **Ragmint MCP + Gradio Dashboard** designed for Hugging Face Spaces.
|
| 4 |
-
It allows users to:
|
| 5 |
-
|
| 6 |
-
- Optimize RAG pipelines
|
| 7 |
-
- Run autotune for RAG parameters
|
| 8 |
-
- Generate QA datasets
|
| 9 |
-
- Monitor corpus stats and leaderboard
|
| 10 |
-
|
| 11 |
-
The MCP backend handles all computations, and the Gradio frontend communicates with it via async HTTP requests.
|
| 12 |
-
|
| 13 |
-
---
|
| 14 |
-
|
| 15 |
-
## Features
|
| 16 |
-
|
| 17 |
-
1. **Health Check** β Confirm the MCP backend is running.
|
| 18 |
-
2. **Optimize RAG** β Run RAG optimization using user-defined parameters.
|
| 19 |
-
3. **Autotune RAG** β Automatically tune chunk sizes, overlaps, and embedding models.
|
| 20 |
-
4. **Generate QA** β Generate validation QA sets dynamically using an LLM.
|
| 21 |
-
|
| 22 |
-
---
|
| 23 |
-
|
| 24 |
-
## Usage
|
| 25 |
-
|
| 26 |
-
### MCP Server (backend)
|
| 27 |
-
|
| 28 |
-
Install dependencies and start the MCP server:
|
| 29 |
-
|
| 30 |
-
```bash
|
| 31 |
-
pip install -r requirements.txt
|
| 32 |
-
python ragmint_mcp.py
|
| 33 |
-
```
|
| 34 |
-
|
| 35 |
-
The server runs on `http://127.0.0.1:8000`.
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
### Gradio Dashboard (frontend)
|
| 39 |
-
|
| 40 |
-
Install dependencies (if not already):
|
| 41 |
-
```
|
| 42 |
-
pip install -r requirements.txt
|
| 43 |
-
```
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
### Launch the Gradio frontend:
|
| 47 |
-
|
| 48 |
-
```
|
| 49 |
-
python app.py
|
| 50 |
-
```
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
The dashboard runs on `http://127.0.0.1:7860`.
|
| 54 |
-
|
| 55 |
---
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
|
| 59 |
-
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
βββ data/docs # Example documents and QA sets
|
| 65 |
-
```
|
| 66 |
---
|
| 67 |
-
## License
|
| 68 |
|
| 69 |
-
|
| 70 |
|
| 71 |
-
|
| 72 |
-
<sub>Built with β€οΈ by <a href="https://andyolivers.com">AndrΓ© Oliveira</a> | Apache 2.0 License</sub>
|
| 73 |
-
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: Ragmint MCP Server
|
| 3 |
+
emoji: π€
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: purple
|
| 6 |
+
sdk: gradio
|
| 7 |
+
sdk_version: "3.41.0"
|
| 8 |
+
app_file: app.py
|
| 9 |
+
pinned: false
|
|
|
|
|
|
|
| 10 |
---
|
|
|
|
| 11 |
|
| 12 |
+
# Ragmint MCP Server
|
| 13 |
|
| 14 |
+
Gradio-based MCP server for Ragmint.
|
|
|
|
|
|