Spaces:
Sleeping
Sleeping
github-actions[bot]
commited on
Commit
·
29e8fa4
1
Parent(s):
4596e5b
Sync from GitHub main @ a7a32ea0de0ba4700d1d77020666f50fee7a30f8
Browse files- .dockerignore +4 -1
- README.md +31 -8
.dockerignore
CHANGED
|
@@ -75,7 +75,10 @@ data/uploads/
|
|
| 75 |
# --------------------
|
| 76 |
# Spider dataset (exclude from image context)
|
| 77 |
# --------------------
|
| 78 |
-
data/spider
|
|
|
|
|
|
|
|
|
|
| 79 |
|
| 80 |
# --------------------
|
| 81 |
# Temporary files
|
|
|
|
| 75 |
# --------------------
|
| 76 |
# Spider dataset (exclude from image context)
|
| 77 |
# --------------------
|
| 78 |
+
data/spider/**
|
| 79 |
+
|
| 80 |
+
# But keep documentation
|
| 81 |
+
!data/spider/README.md
|
| 82 |
|
| 83 |
# --------------------
|
| 84 |
# Temporary files
|
README.md
CHANGED
|
@@ -72,38 +72,61 @@ A live interactive demo is available on Hugging Face Spaces:
|
|
| 72 |
|
| 73 |
## Quickstart (Local)
|
| 74 |
|
| 75 |
-
|
|
|
|
|
|
|
|
|
|
| 76 |
|
| 77 |
```bash
|
|
|
|
| 78 |
make install
|
| 79 |
```
|
| 80 |
|
| 81 |
-
### 2) Run
|
| 82 |
|
| 83 |
```bash
|
| 84 |
make demo-up
|
| 85 |
```
|
| 86 |
|
| 87 |
-
### 3) Smoke (Terminal 2)
|
| 88 |
|
| 89 |
```bash
|
| 90 |
make demo-smoke
|
| 91 |
```
|
| 92 |
|
| 93 |
-
### 4) Observability
|
|
|
|
|
|
|
| 94 |
|
| 95 |
```bash
|
| 96 |
-
make
|
| 97 |
```
|
| 98 |
|
| 99 |
-
|
| 100 |
|
| 101 |
```bash
|
| 102 |
make demo-metrics
|
| 103 |
```
|
| 104 |
|
| 105 |
-
|
| 106 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 107 |
|
| 108 |
---
|
| 109 |
|
|
|
|
| 72 |
|
| 73 |
## Quickstart (Local)
|
| 74 |
|
| 75 |
+
This repo is **demo-first**: `make demo-up` brings up the **real** Docker stack (API + Prometheus + Grafana).
|
| 76 |
+
For the full operational checklist (traffic warmer, metrics queries, UIs, eval), see **docs/runbook.md**.
|
| 77 |
+
|
| 78 |
+
### 1) Install (one-time)
|
| 79 |
|
| 80 |
```bash
|
| 81 |
+
make venv
|
| 82 |
make install
|
| 83 |
```
|
| 84 |
|
| 85 |
+
### 2) Run the demo stack (Terminal 1)
|
| 86 |
|
| 87 |
```bash
|
| 88 |
make demo-up
|
| 89 |
```
|
| 90 |
|
| 91 |
+
### 3) Smoke test (Terminal 2)
|
| 92 |
|
| 93 |
```bash
|
| 94 |
make demo-smoke
|
| 95 |
```
|
| 96 |
|
| 97 |
+
### 4) Observability (optional, but recommended for screenshots)
|
| 98 |
+
|
| 99 |
+
Generate steady traffic so dashboards don’t look dead:
|
| 100 |
|
| 101 |
```bash
|
| 102 |
+
make demo-traffic-up
|
| 103 |
```
|
| 104 |
|
| 105 |
+
Validate key Prometheus signals:
|
| 106 |
|
| 107 |
```bash
|
| 108 |
make demo-metrics
|
| 109 |
```
|
| 110 |
|
| 111 |
+
Open in browser:
|
| 112 |
+
|
| 113 |
+
- Grafana: http://127.0.0.1:3000 (admin / admin)
|
| 114 |
+
- Prometheus: http://127.0.0.1:9090
|
| 115 |
+
|
| 116 |
+
### 5) UI layers (optional)
|
| 117 |
+
|
| 118 |
+
Gradio demo UI:
|
| 119 |
+
|
| 120 |
+
```bash
|
| 121 |
+
make demo-up
|
| 122 |
+
# then run the UI entrypoint you prefer (see docs/ui.md)
|
| 123 |
+
```
|
| 124 |
+
|
| 125 |
+
Benchmark UI (Streamlit):
|
| 126 |
+
|
| 127 |
+
```bash
|
| 128 |
+
make bench-ui
|
| 129 |
+
```
|
| 130 |
|
| 131 |
---
|
| 132 |
|