Skip to content

Commit 488eb71

Browse files
docs: add README metrics table
1 parent 4d43d26 commit 488eb71

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,50 @@ Decoupling state instantiation from model execution delivers clear improvements
5959
| **Throughput Density** | ~1,400 requests/sec | ~12,000 requests/sec via Triton/ONNX | **+757% High-Concurrency Load** |
6060
| **Memory Allocation Profile** | O(N) linear explosion based on history | O(1) deterministic cap via Guardrails | **Eliminated Session OOM Vulnerability** |
6161
| **Fallback Resiliency** | System Timeout / Cascade Drop | Instant Automatic Cache Triage | **99.99% Availability Guarantee** |
62+
63+
## 📊 Metrics Table
64+
65+
Measured from the repository on 2026-07-12. Runtime and SLO values are recorded from the checked-in configuration, metrics documentation, and README architecture notes.
66+
67+
| Area | Metric | Current / Recommended Value | Source |
68+
|---|---:|---:|---|
69+
| Codebase | Tracked files | 43 | `git ls-files` |
70+
| Codebase | Python files | 22 | `*.py` files across app, recommender, docs, and tests |
71+
| Codebase | Python NCLOC | 995 | Non-empty, non-comment Python lines |
72+
| Tests | Test files | 2 | `tests/test_*.py` |
73+
| Tests | Pytest cases | 27 passing | `pytest --cov=app --cov=recommender` |
74+
| Tests | Coverage scope | `app`, `recommender` | `pytest-cov` |
75+
| Tests | Combined coverage | 54% | Local coverage run |
76+
| CI/CD | GitHub Actions workflows | 7 | `.github/workflows/*.yml` |
77+
| Dependencies | Runtime dependencies | 12 | `requirements.txt` |
78+
| Delivery | Container assets | 2 | `Dockerfile`, `docker-compose.yml` |
79+
| Delivery | Kubernetes manifests | 3 | `k8s/*.yaml` |
80+
| Documentation | Documentation pages | 4 | `README.md`, `docs/*.md` |
81+
| Model Config | Max sequence length | 50 items | `app.core.config.Settings.max_sequence_length` |
82+
| Model Config | Default top-k recommendations | 10 items | `app.core.config.Settings.top_k` |
83+
| Model Config | Embedding dimension | 64 | `app.core.config.Settings.embedding_dim` |
84+
| Model Config | Hidden dimension | 128 | `app.core.config.Settings.hidden_dim` |
85+
| Model Config | Recurrent layers | 2 | `app.core.config.Settings.num_layers` |
86+
| Model Architecture | Encoder | Bidirectional LSTM + attention | `app.core.model.DeepSequenceModel` |
87+
| Model Architecture | Padding index | 0 | `SequenceProcessor` / `DeepSequenceModel` |
88+
| API | Recommendation endpoint | `POST /recommendations/` | `app.api.routes` |
89+
| API | Health endpoint | `GET /recommendations/health` | `app.api.routes` |
90+
| Observability | Active requests | `deepseq_active_requests` | Prometheus gauge |
91+
| Observability | Recommendation total | `deepseq_recommendations_total{status}` | Prometheus counter |
92+
| Observability | Request latency | `deepseq_recommendation_latency_seconds` | Prometheus histogram |
93+
| Observability | Model latency | `deepseq_model_inference_latency_seconds` | Prometheus histogram |
94+
| Observability | Cache hits | `deepseq_cache_hits_total` | Prometheus counter |
95+
| Observability | Cache misses | `deepseq_cache_misses_total` | Prometheus counter |
96+
| SLO | p50 recommendation latency | < 50 ms | `docs/metrics.md` |
97+
| SLO | p99 recommendation latency | < 250 ms | `docs/metrics.md` |
98+
| SLO | Model inference p50 latency | < 20 ms | `docs/metrics.md` |
99+
| SLO | Availability target | >= 99.9% | `docs/metrics.md` |
100+
| SLO | Error-rate target | < 0.1% | `docs/metrics.md` |
101+
| Architecture Benchmark | Documented p99 latency range | 15-42 ms bounded engine | README benchmark table |
102+
| Architecture Benchmark | Documented throughput density | ~12,000 requests/sec | README benchmark table |
103+
| Architecture Benchmark | Documented memory profile | O(1) deterministic cap | README benchmark table |
104+
| Architecture Benchmark | Documented fallback availability | 99.99% availability guarantee | README benchmark table |
105+
62106
## 🚀 Quick Start Instructions
63107
### Prerequisites
64108
* Python 3.10 or greater installed locally.

0 commit comments

Comments
 (0)