Restructure Makefile
Browse files- Makefile +109 -39
- README.md +145 -79
- docs/chunking_decisions.md +99 -0
- sage/services/baselines.py +51 -0
- scripts/evaluation.py +24 -10
- scripts/faithfulness.py +137 -0
- scripts/human_eval.py +12 -0
Makefile
CHANGED
|
@@ -1,4 +1,4 @@
|
|
| 1 |
-
.PHONY: all setup data data-validate eval eval-
|
| 2 |
|
| 3 |
# ---------------------------------------------------------------------------
|
| 4 |
# Configurable Variables (override: make demo QUERY="gaming mouse")
|
|
@@ -9,6 +9,8 @@ TOP_K ?= 1
|
|
| 9 |
SAMPLES ?= 10
|
| 10 |
SEED ?= 42
|
| 11 |
PORT ?= 8000
|
|
|
|
|
|
|
| 12 |
|
| 13 |
# ---------------------------------------------------------------------------
|
| 14 |
# Environment Check
|
|
@@ -75,57 +77,94 @@ eda: check-env
|
|
| 75 |
python scripts/eda.py
|
| 76 |
|
| 77 |
# ---------------------------------------------------------------------------
|
| 78 |
-
# Evaluation Suite
|
| 79 |
# ---------------------------------------------------------------------------
|
| 80 |
|
| 81 |
-
#
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 82 |
eval: check-env
|
| 83 |
@echo "=== EVALUATION SUITE ===" && \
|
| 84 |
echo "" && \
|
| 85 |
-
echo "---
|
| 86 |
python scripts/build_natural_eval_dataset.py && \
|
| 87 |
-
echo "" && \
|
| 88 |
-
echo "--- Recommendation evaluation (natural queries) ---" && \
|
| 89 |
python scripts/evaluation.py --dataset eval_natural_queries.json --section primary && \
|
| 90 |
echo "" && \
|
| 91 |
-
echo "--- Explanation tests ---" && \
|
| 92 |
python scripts/explanation.py --section basic && \
|
| 93 |
python scripts/explanation.py --section gate && \
|
| 94 |
python scripts/explanation.py --section verify && \
|
| 95 |
python scripts/explanation.py --section cold && \
|
| 96 |
echo "" && \
|
| 97 |
-
echo "--- Faithfulness
|
| 98 |
python scripts/faithfulness.py --samples $(SAMPLES) --ragas && \
|
| 99 |
echo "" && \
|
| 100 |
-
echo "--- Sanity checks
|
| 101 |
python scripts/sanity_checks.py --section spot && \
|
| 102 |
echo "" && \
|
| 103 |
echo "=== EVALUATION COMPLETE ==="
|
| 104 |
|
| 105 |
-
#
|
| 106 |
-
|
| 107 |
-
|
| 108 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 109 |
echo "" && \
|
| 110 |
-
echo "---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 111 |
python scripts/evaluation.py --dataset eval_natural_queries.json --section all && \
|
| 112 |
echo "" && \
|
| 113 |
-
echo "---
|
| 114 |
-
python scripts/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 115 |
echo "" && \
|
| 116 |
-
echo "---
|
| 117 |
python scripts/faithfulness.py --analyze && \
|
| 118 |
python scripts/faithfulness.py --adjusted && \
|
| 119 |
echo "" && \
|
| 120 |
-
echo "
|
| 121 |
-
|
| 122 |
-
|
| 123 |
-
eval
|
| 124 |
-
|
| 125 |
-
|
| 126 |
-
python scripts/
|
| 127 |
-
|
| 128 |
-
@echo "Quick eval complete"
|
| 129 |
|
| 130 |
# ---------------------------------------------------------------------------
|
| 131 |
# Demo
|
|
@@ -155,8 +194,9 @@ demo-interview: check-env
|
|
| 155 |
# Full Pipeline
|
| 156 |
# ---------------------------------------------------------------------------
|
| 157 |
|
| 158 |
-
|
| 159 |
-
|
|
|
|
| 160 |
|
| 161 |
# ---------------------------------------------------------------------------
|
| 162 |
# API
|
|
@@ -255,6 +295,7 @@ health:
|
|
| 255 |
# ---------------------------------------------------------------------------
|
| 256 |
|
| 257 |
# Clear processed data, keep raw download cache and Qdrant Cloud data
|
|
|
|
| 258 |
reset:
|
| 259 |
@echo "Clearing processed data..."
|
| 260 |
rm -f data/reviews_prepared_*.parquet
|
|
@@ -263,10 +304,29 @@ reset:
|
|
| 263 |
rm -rf data/eval/
|
| 264 |
rm -f data/eval_results/eval_*.json
|
| 265 |
rm -f data/eval_results/faithfulness_*.json
|
| 266 |
-
|
|
|
|
|
|
|
|
|
|
| 267 |
rm -rf data/figures/
|
| 268 |
rm -f reports/eda_report.md
|
| 269 |
-
@echo "Done.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 270 |
|
| 271 |
# ---------------------------------------------------------------------------
|
| 272 |
# Kaggle
|
|
@@ -363,10 +423,18 @@ help:
|
|
| 363 |
@echo "PIPELINE:"
|
| 364 |
@echo " make data Load, chunk, embed, and index reviews"
|
| 365 |
@echo " make data-validate Validate data outputs"
|
| 366 |
-
@echo " make eda Exploratory data analysis (
|
| 367 |
-
@echo "
|
| 368 |
-
@echo "
|
| 369 |
-
@echo " make eval-quick Quick
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 370 |
@echo ""
|
| 371 |
@echo "API:"
|
| 372 |
@echo " make serve Start API server (PORT=8000)"
|
|
@@ -396,8 +464,10 @@ help:
|
|
| 396 |
@echo " make reset-hard Reset + clear Qdrant + raw data cache"
|
| 397 |
@echo ""
|
| 398 |
@echo "VARIABLES:"
|
| 399 |
-
@echo " QUERY
|
| 400 |
-
@echo " TOP_K
|
| 401 |
-
@echo " SAMPLES
|
| 402 |
-
@echo " SEED
|
| 403 |
-
@echo " PORT
|
|
|
|
|
|
|
|
|
| 1 |
+
.PHONY: all setup data data-validate eval eval-all eval-quick demo demo-interview reset reset-hard check-env qdrant-up qdrant-down qdrant-status eda serve serve-dev docker-build docker-run deploy-info human-eval-generate human-eval human-eval-analyze test lint typecheck ci info summary metrics-snapshot health load-test load-test-quick help
|
| 2 |
|
| 3 |
# ---------------------------------------------------------------------------
|
| 4 |
# Configurable Variables (override: make demo QUERY="gaming mouse")
|
|
|
|
| 9 |
SAMPLES ?= 10
|
| 10 |
SEED ?= 42
|
| 11 |
PORT ?= 8000
|
| 12 |
+
URL ?= https://vxa8502-sage.hf.space
|
| 13 |
+
REQUESTS ?= 50
|
| 14 |
|
| 15 |
# ---------------------------------------------------------------------------
|
| 16 |
# Environment Check
|
|
|
|
| 77 |
python scripts/eda.py
|
| 78 |
|
| 79 |
# ---------------------------------------------------------------------------
|
| 80 |
+
# Evaluation Suite (layered: quick → standard → complete)
|
| 81 |
# ---------------------------------------------------------------------------
|
| 82 |
|
| 83 |
+
# Quick: Fast iteration, no RAGAS (~1 min)
|
| 84 |
+
# - Primary retrieval metrics (NDCG, Hit@K, MRR)
|
| 85 |
+
# - Basic faithfulness (HHEM only, 5 samples)
|
| 86 |
+
eval-quick: check-env
|
| 87 |
+
@echo "=== QUICK EVALUATION ===" && \
|
| 88 |
+
python scripts/build_natural_eval_dataset.py && \
|
| 89 |
+
python scripts/evaluation.py --dataset eval_natural_queries.json --section primary && \
|
| 90 |
+
python scripts/faithfulness.py --samples 5 && \
|
| 91 |
+
echo "=== QUICK EVAL COMPLETE ==="
|
| 92 |
+
|
| 93 |
+
# Standard: Pre-commit validation (~5 min)
|
| 94 |
+
# - Primary retrieval metrics
|
| 95 |
+
# - Explanation tests (basic, gate, verify, cold-start)
|
| 96 |
+
# - Faithfulness (HHEM + RAGAS)
|
| 97 |
+
# - Spot checks
|
| 98 |
eval: check-env
|
| 99 |
@echo "=== EVALUATION SUITE ===" && \
|
| 100 |
echo "" && \
|
| 101 |
+
echo "--- [1/4] Retrieval metrics ---" && \
|
| 102 |
python scripts/build_natural_eval_dataset.py && \
|
|
|
|
|
|
|
| 103 |
python scripts/evaluation.py --dataset eval_natural_queries.json --section primary && \
|
| 104 |
echo "" && \
|
| 105 |
+
echo "--- [2/4] Explanation tests ---" && \
|
| 106 |
python scripts/explanation.py --section basic && \
|
| 107 |
python scripts/explanation.py --section gate && \
|
| 108 |
python scripts/explanation.py --section verify && \
|
| 109 |
python scripts/explanation.py --section cold && \
|
| 110 |
echo "" && \
|
| 111 |
+
echo "--- [3/4] Faithfulness (HHEM + RAGAS) ---" && \
|
| 112 |
python scripts/faithfulness.py --samples $(SAMPLES) --ragas && \
|
| 113 |
echo "" && \
|
| 114 |
+
echo "--- [4/4] Sanity checks ---" && \
|
| 115 |
python scripts/sanity_checks.py --section spot && \
|
| 116 |
echo "" && \
|
| 117 |
echo "=== EVALUATION COMPLETE ==="
|
| 118 |
|
| 119 |
+
# Complete: Full reproducible suite (~15 min)
|
| 120 |
+
# - EDA (production data stats + figures)
|
| 121 |
+
# - All retrieval metrics + ablations (aggregation, rating, K, weights)
|
| 122 |
+
# - Baseline comparison (Random, Popularity, ItemKNN)
|
| 123 |
+
# - All explanation tests
|
| 124 |
+
# - Faithfulness (HHEM + RAGAS)
|
| 125 |
+
# - Grounding delta (WITH vs WITHOUT evidence)
|
| 126 |
+
# - Failure analysis + adjusted metrics
|
| 127 |
+
# - All sanity checks (spot, adversarial, empty, calibration)
|
| 128 |
+
# - Human eval analysis (if annotations exist)
|
| 129 |
+
# - Summary report
|
| 130 |
+
eval-all: check-env
|
| 131 |
+
@echo "=== COMPLETE EVALUATION SUITE ===" && \
|
| 132 |
echo "" && \
|
| 133 |
+
echo "--- [1/9] EDA (production data) ---" && \
|
| 134 |
+
mkdir -p data/figures reports && \
|
| 135 |
+
python scripts/eda.py && \
|
| 136 |
+
echo "" && \
|
| 137 |
+
echo "--- [2/9] Retrieval metrics + ablations ---" && \
|
| 138 |
+
python scripts/build_natural_eval_dataset.py && \
|
| 139 |
python scripts/evaluation.py --dataset eval_natural_queries.json --section all && \
|
| 140 |
echo "" && \
|
| 141 |
+
echo "--- [3/9] Baseline comparison ---" && \
|
| 142 |
+
python scripts/evaluation.py --dataset eval_natural_queries.json --section primary --baselines && \
|
| 143 |
+
echo "" && \
|
| 144 |
+
echo "--- [4/9] Explanation tests ---" && \
|
| 145 |
+
python scripts/explanation.py --section basic && \
|
| 146 |
+
python scripts/explanation.py --section gate && \
|
| 147 |
+
python scripts/explanation.py --section verify && \
|
| 148 |
+
python scripts/explanation.py --section cold && \
|
| 149 |
+
echo "" && \
|
| 150 |
+
echo "--- [5/9] Faithfulness (HHEM + RAGAS) ---" && \
|
| 151 |
+
python scripts/faithfulness.py --samples $(SAMPLES) --ragas && \
|
| 152 |
+
echo "" && \
|
| 153 |
+
echo "--- [6/9] Grounding delta experiment ---" && \
|
| 154 |
+
python scripts/faithfulness.py --delta && \
|
| 155 |
echo "" && \
|
| 156 |
+
echo "--- [7/9] Failure analysis ---" && \
|
| 157 |
python scripts/faithfulness.py --analyze && \
|
| 158 |
python scripts/faithfulness.py --adjusted && \
|
| 159 |
echo "" && \
|
| 160 |
+
echo "--- [8/9] All sanity checks ---" && \
|
| 161 |
+
python scripts/sanity_checks.py --section all && \
|
| 162 |
+
echo "" && \
|
| 163 |
+
echo "--- [9/9] Human eval analysis ---" && \
|
| 164 |
+
(python scripts/human_eval.py --analyze 2>/dev/null || echo " (skipped - no annotations found)") && \
|
| 165 |
+
echo "" && \
|
| 166 |
+
python scripts/summary.py && \
|
| 167 |
+
echo "=== COMPLETE EVALUATION DONE ==="
|
|
|
|
| 168 |
|
| 169 |
# ---------------------------------------------------------------------------
|
| 170 |
# Demo
|
|
|
|
| 194 |
# Full Pipeline
|
| 195 |
# ---------------------------------------------------------------------------
|
| 196 |
|
| 197 |
+
# Complete reproducible pipeline: data + full eval + demo
|
| 198 |
+
all: qdrant-up data eval-all demo
|
| 199 |
+
@echo "=== FULL PIPELINE COMPLETE ==="
|
| 200 |
|
| 201 |
# ---------------------------------------------------------------------------
|
| 202 |
# API
|
|
|
|
| 295 |
# ---------------------------------------------------------------------------
|
| 296 |
|
| 297 |
# Clear processed data, keep raw download cache and Qdrant Cloud data
|
| 298 |
+
# After reset, run: make eval-all (full reproducible suite)
|
| 299 |
reset:
|
| 300 |
@echo "Clearing processed data..."
|
| 301 |
rm -f data/reviews_prepared_*.parquet
|
|
|
|
| 304 |
rm -rf data/eval/
|
| 305 |
rm -f data/eval_results/eval_*.json
|
| 306 |
rm -f data/eval_results/faithfulness_*.json
|
| 307 |
+
rm -f data/eval_results/failure_analysis_*.json
|
| 308 |
+
rm -f data/eval_results/adjusted_faithfulness_*.json
|
| 309 |
+
rm -f data/eval_results/grounding_delta_*.json
|
| 310 |
+
@echo " (human_eval_*.json preserved — run 'make human-eval' to re-annotate)"
|
| 311 |
rm -rf data/figures/
|
| 312 |
rm -f reports/eda_report.md
|
| 313 |
+
@echo "Done. Run 'make eval-all' to reproduce full evaluation suite."
|
| 314 |
+
@echo " (Use 'make reset-hard' to also clear Qdrant + raw cache)"
|
| 315 |
+
|
| 316 |
+
# ---------------------------------------------------------------------------
|
| 317 |
+
# Load Testing
|
| 318 |
+
# ---------------------------------------------------------------------------
|
| 319 |
+
|
| 320 |
+
# Run load test against production (or local with URL=http://localhost:8000)
|
| 321 |
+
# Target: P99 < 500ms
|
| 322 |
+
load-test:
|
| 323 |
+
@echo "=== LOAD TEST ==="
|
| 324 |
+
python scripts/load_test.py --url $(URL) --requests $(REQUESTS)
|
| 325 |
+
|
| 326 |
+
# Quick load test (20 requests, no explanations - tests retrieval only)
|
| 327 |
+
load-test-quick:
|
| 328 |
+
@echo "=== QUICK LOAD TEST (retrieval only) ==="
|
| 329 |
+
python scripts/load_test.py --url $(URL) --requests 20 --no-explain
|
| 330 |
|
| 331 |
# ---------------------------------------------------------------------------
|
| 332 |
# Kaggle
|
|
|
|
| 423 |
@echo "PIPELINE:"
|
| 424 |
@echo " make data Load, chunk, embed, and index reviews"
|
| 425 |
@echo " make data-validate Validate data outputs"
|
| 426 |
+
@echo " make eda Exploratory data analysis (queries Qdrant)"
|
| 427 |
+
@echo ""
|
| 428 |
+
@echo "EVALUATION (layered):"
|
| 429 |
+
@echo " make eval-quick Quick iteration: NDCG + HHEM only (~1 min)"
|
| 430 |
+
@echo " make eval Standard: metrics + explanation + faithfulness (~5 min)"
|
| 431 |
+
@echo " make eval-all Complete: everything automated (~15 min)"
|
| 432 |
+
@echo " Includes: EDA, ablations, baselines, delta, analysis"
|
| 433 |
+
@echo ""
|
| 434 |
+
@echo "LOAD TESTING:"
|
| 435 |
+
@echo " make load-test Run 50 requests against production (P99 target)"
|
| 436 |
+
@echo " make load-test URL=... Test against custom URL"
|
| 437 |
+
@echo " make load-test-quick 20 requests, no explanations (retrieval only)"
|
| 438 |
@echo ""
|
| 439 |
@echo "API:"
|
| 440 |
@echo " make serve Start API server (PORT=8000)"
|
|
|
|
| 464 |
@echo " make reset-hard Reset + clear Qdrant + raw data cache"
|
| 465 |
@echo ""
|
| 466 |
@echo "VARIABLES:"
|
| 467 |
+
@echo " QUERY Demo query (default: wireless headphones...)"
|
| 468 |
+
@echo " TOP_K Number of results (default: 1)"
|
| 469 |
+
@echo " SAMPLES Faithfulness eval samples (default: 10)"
|
| 470 |
+
@echo " SEED Random seed for human eval (default: 42)"
|
| 471 |
+
@echo " PORT API port (default: 8000)"
|
| 472 |
+
@echo " URL Load test target (default: https://vxa8502-sage.hf.space)"
|
| 473 |
+
@echo " REQUESTS Load test request count (default: 50)"
|
README.md
CHANGED
|
@@ -6,149 +6,215 @@ colorTo: yellow
|
|
| 6 |
sdk: docker
|
| 7 |
app_port: 7860
|
| 8 |
---
|
| 9 |
-
<!--
|
| 10 |
|
| 11 |
# Sage
|
| 12 |
|
| 13 |
-
|
| 14 |
|
| 15 |
-
|
| 16 |
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
|
| 22 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 23 |
|
| 24 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 25 |
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 32 |
|
| 33 |
## Quick Start
|
| 34 |
|
| 35 |
-
###
|
| 36 |
|
| 37 |
```bash
|
| 38 |
-
git clone https://github.com/
|
| 39 |
-
cd sage
|
| 40 |
cp .env.example .env
|
| 41 |
-
# Edit .env
|
| 42 |
|
| 43 |
docker-compose up
|
| 44 |
curl http://localhost:8000/health
|
| 45 |
```
|
| 46 |
|
| 47 |
-
###
|
| 48 |
|
| 49 |
```bash
|
| 50 |
-
python3 -m venv .venv
|
| 51 |
-
|
| 52 |
-
pip install -e ".[dev,pipeline,api,anthropic]" # or openai
|
| 53 |
|
| 54 |
cp .env.example .env
|
| 55 |
-
# Edit .env: add
|
| 56 |
|
| 57 |
-
make
|
| 58 |
-
make
|
|
|
|
| 59 |
```
|
| 60 |
|
| 61 |
-
|
| 62 |
|
| 63 |
```bash
|
| 64 |
-
# Required
|
| 65 |
-
|
| 66 |
-
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
#
|
| 70 |
-
|
|
|
|
| 71 |
```
|
| 72 |
|
|
|
|
|
|
|
| 73 |
## API Reference
|
| 74 |
|
| 75 |
### POST /recommend
|
| 76 |
|
| 77 |
```bash
|
| 78 |
-
curl -X POST
|
| 79 |
-H "Content-Type: application/json" \
|
| 80 |
-d '{"query": "wireless earbuds for running", "k": 3, "explain": true}'
|
| 81 |
```
|
| 82 |
|
| 83 |
-
Returns ranked products with
|
|
|
|
|
|
|
|
|
|
|
|
|
| 84 |
|
| 85 |
### POST /recommend/stream
|
| 86 |
|
| 87 |
-
|
| 88 |
|
| 89 |
### GET /health
|
| 90 |
|
| 91 |
-
|
|
|
|
|
|
|
| 92 |
|
| 93 |
### GET /metrics
|
| 94 |
|
| 95 |
-
Prometheus metrics:
|
| 96 |
|
| 97 |
### GET /cache/stats
|
| 98 |
|
| 99 |
-
|
| 100 |
-
|
| 101 |
-
|
| 102 |
-
|
| 103 |
-
| Condition | System Behavior |
|
| 104 |
-
|-----------|-----------------|
|
| 105 |
-
| Insufficient evidence | Refuses to explain |
|
| 106 |
-
| Quote not found in source | Falls back to paraphrased claims |
|
| 107 |
-
| HHEM confidence below threshold | Flags explanation as uncertain |
|
| 108 |
|
| 109 |
-
|
| 110 |
|
| 111 |
-
##
|
| 112 |
|
| 113 |
```bash
|
| 114 |
-
make
|
| 115 |
-
make
|
| 116 |
-
make eval #
|
| 117 |
-
make
|
| 118 |
```
|
| 119 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 120 |
## Project Structure
|
| 121 |
|
| 122 |
```
|
| 123 |
sage/
|
| 124 |
-
├── adapters/
|
| 125 |
-
├── api/
|
| 126 |
-
├──
|
| 127 |
-
├──
|
| 128 |
-
├── services/ # Business logic (retrieval, explanation, cache)
|
| 129 |
scripts/
|
| 130 |
-
├── pipeline.py
|
| 131 |
-
├──
|
| 132 |
-
├──
|
| 133 |
-
├──
|
| 134 |
-
├──
|
| 135 |
-
├── human_eval.py # Human evaluation workflow
|
| 136 |
-
├── sanity_checks.py # Spot checks and calibration
|
| 137 |
-
├── load_test.py # Latency benchmarking
|
| 138 |
-
├── eda.py # Exploratory data analysis
|
| 139 |
-
tests/
|
| 140 |
-
├── test_api.py
|
| 141 |
-
├── test_evidence.py
|
| 142 |
-
├── test_aggregation.py
|
| 143 |
```
|
| 144 |
|
| 145 |
-
|
|
|
|
|
|
|
| 146 |
|
| 147 |
-
|
| 148 |
-
|
| 149 |
-
|
| 150 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 151 |
|
| 152 |
## License
|
| 153 |
|
| 154 |
-
Academic
|
|
|
|
| 6 |
sdk: docker
|
| 7 |
app_port: 7860
|
| 8 |
---
|
| 9 |
+
<!-- HF Spaces metadata above; hidden on HF, visible on GitHub -->
|
| 10 |
|
| 11 |
# Sage
|
| 12 |
|
| 13 |
+
**Product recommendations without explanations are black boxes.** Users see "You might like X" but never learn *why*. This system retrieves products via semantic search over real customer reviews, then generates natural language explanations grounded in that evidence. Every claim is verified against source text using hallucination detection.
|
| 14 |
|
| 15 |
+
**Live demo:** [vxa8502-sage.hf.space](https://vxa8502-sage.hf.space)
|
| 16 |
|
| 17 |
+
---
|
| 18 |
+
|
| 19 |
+
## Results
|
| 20 |
+
|
| 21 |
+
| Metric | Target | Achieved | Status |
|
| 22 |
+
|--------|--------|----------|--------|
|
| 23 |
+
| NDCG@10 (recommendation quality) | > 0.30 | 0.295 | 98% |
|
| 24 |
+
| Claim-level faithfulness (HHEM) | > 0.85 | 0.968 | Pass |
|
| 25 |
+
| Human evaluation (n=50) | > 3.5/5 | 4.43/5 | Pass |
|
| 26 |
+
| P99 latency (retrieval) | < 500ms | 283ms | Pass |
|
| 27 |
+
| P99 latency (cache hit) | < 100ms | ~80ms | Pass |
|
| 28 |
+
|
| 29 |
+
**Grounding impact:** Explanations generated WITH evidence score 69% on HHEM. WITHOUT evidence: 3%. RAG grounding reduces hallucination by 66 percentage points.
|
| 30 |
+
|
| 31 |
+
---
|
| 32 |
+
|
| 33 |
+
## Architecture
|
| 34 |
+
|
| 35 |
+
```
|
| 36 |
+
User Query: "wireless earbuds for running"
|
| 37 |
+
│
|
| 38 |
+
▼
|
| 39 |
+
┌─────────────────────────────────────────────────────────────┐
|
| 40 |
+
│ SAGE API (FastAPI) │
|
| 41 |
+
├─────────────────────────────────────────────────────────────┤
|
| 42 |
+
│ 1. EMBED │ E5-small (384-dim) ~20ms │
|
| 43 |
+
│ 2. CACHE CHECK │ Exact + semantic (0.92 sim) ~1ms │
|
| 44 |
+
│ 3. RETRIEVE │ Qdrant vector search ~50ms │
|
| 45 |
+
│ 4. AGGREGATE │ Chunk → Product (MAX score) ~1ms │
|
| 46 |
+
│ 5. EXPLAIN │ Claude/GPT + evidence ~300ms │
|
| 47 |
+
│ 6. VERIFY │ HHEM hallucination check ~50ms │
|
| 48 |
+
└─────────────────────────────────────────────────────────────┘
|
| 49 |
+
│
|
| 50 |
+
▼
|
| 51 |
+
┌─────────────────────────────────────────────────────────────┐
|
| 52 |
+
│ Response: │
|
| 53 |
+
│ - Product ID + score │
|
| 54 |
+
│ - Explanation with [citations] │
|
| 55 |
+
│ - HHEM confidence score │
|
| 56 |
+
│ - Quote verification results │
|
| 57 |
+
└─────────────────────────────────────────────────────────────┘
|
| 58 |
+
```
|
| 59 |
+
|
| 60 |
+
**Data flow:** 1M Amazon reviews → 5-core filter → 30K reviews → semantic chunking → 423K chunks in Qdrant.
|
| 61 |
|
| 62 |
+
---
|
| 63 |
+
|
| 64 |
+
## Design Trade-offs
|
| 65 |
+
|
| 66 |
+
| Decision | Alternative | Why This Choice |
|
| 67 |
+
|----------|-------------|-----------------|
|
| 68 |
+
| **E5-small** (384-dim) | E5-large, BGE-large | 3x faster inference, 0.02 NDCG delta. Latency > marginal accuracy. |
|
| 69 |
+
| **Qdrant** | Pinecone, Weaviate | Free cloud tier (1GB), gRPC, native Python client. |
|
| 70 |
+
| **Semantic chunking** | Fixed-window | Preserves complete arguments; +12% quote verification rate. |
|
| 71 |
+
| **MAX aggregation** | MEAN, weighted | Best single chunk matters more than average for explanations. |
|
| 72 |
+
| **HHEM** (Vectara) | NLI models, GPT-4 judge | Purpose-built for RAG; no API cost; 0.97 AUC on HaluEval. |
|
| 73 |
+
| **Claim-level HHEM** | Full-explanation HHEM | Isolates hallucinated claims; more actionable than binary pass/fail. |
|
| 74 |
+
| **Quality gate** (refuse) | Always answer | Reduces hallucination; 46% refusal rate is a feature, not a bug. |
|
| 75 |
+
|
| 76 |
+
See [`docs/chunking_decisions.md`](docs/chunking_decisions.md) for detailed chunking rationale.
|
| 77 |
+
|
| 78 |
+
---
|
| 79 |
|
| 80 |
+
## Known Limitations
|
| 81 |
+
|
| 82 |
+
| Limitation | Impact | Mitigation |
|
| 83 |
+
|------------|--------|------------|
|
| 84 |
+
| **Single category** (Electronics) | Can't recommend across categories | Architecture supports multi-category; data constraint only |
|
| 85 |
+
| **No image features** | Misses visual product attributes | Could add CLIP embeddings in future |
|
| 86 |
+
| **English only** | Non-English reviews have lower retrieval quality | E5 is primarily English-trained |
|
| 87 |
+
| **Cache invalidation manual** | Stale explanations possible | TTL-based expiry (1 hour); manual `/cache/clear` |
|
| 88 |
+
| **LLM latency on free tier** | P99 ~4s with explanations | Retrieval alone is 283ms; cache hits are ~80ms |
|
| 89 |
+
| **No user personalization** | Same results for all users | Would need user history for collaborative filtering |
|
| 90 |
+
|
| 91 |
+
---
|
| 92 |
|
| 93 |
## Quick Start
|
| 94 |
|
| 95 |
+
### Docker (recommended)
|
| 96 |
|
| 97 |
```bash
|
| 98 |
+
git clone https://github.com/yourusername/sage
|
| 99 |
+
cd sage
|
| 100 |
cp .env.example .env
|
| 101 |
+
# Edit .env: add ANTHROPIC_API_KEY (or OPENAI_API_KEY)
|
| 102 |
|
| 103 |
docker-compose up
|
| 104 |
curl http://localhost:8000/health
|
| 105 |
```
|
| 106 |
|
| 107 |
+
### Local Development
|
| 108 |
|
| 109 |
```bash
|
| 110 |
+
python3 -m venv .venv && source .venv/bin/activate
|
| 111 |
+
pip install -e ".[dev,pipeline,api,anthropic]"
|
|
|
|
| 112 |
|
| 113 |
cp .env.example .env
|
| 114 |
+
# Edit .env: add API keys
|
| 115 |
|
| 116 |
+
make qdrant-up # Start local Qdrant
|
| 117 |
+
make data # Load data (or use Qdrant Cloud)
|
| 118 |
+
make serve # Start API at localhost:8000
|
| 119 |
```
|
| 120 |
|
| 121 |
+
### Environment Variables
|
| 122 |
|
| 123 |
```bash
|
| 124 |
+
# Required (one of)
|
| 125 |
+
ANTHROPIC_API_KEY=sk-ant-...
|
| 126 |
+
OPENAI_API_KEY=sk-...
|
| 127 |
+
LLM_PROVIDER=anthropic # or "openai"
|
| 128 |
+
|
| 129 |
+
# Optional: Qdrant Cloud (instead of local)
|
| 130 |
+
QDRANT_URL=https://xxx.cloud.qdrant.io
|
| 131 |
+
QDRANT_API_KEY=...
|
| 132 |
```
|
| 133 |
|
| 134 |
+
---
|
| 135 |
+
|
| 136 |
## API Reference
|
| 137 |
|
| 138 |
### POST /recommend
|
| 139 |
|
| 140 |
```bash
|
| 141 |
+
curl -X POST https://vxa8502-sage.hf.space/recommend \
|
| 142 |
-H "Content-Type: application/json" \
|
| 143 |
-d '{"query": "wireless earbuds for running", "k": 3, "explain": true}'
|
| 144 |
```
|
| 145 |
|
| 146 |
+
Returns ranked products with:
|
| 147 |
+
- Explanation grounded in customer reviews
|
| 148 |
+
- HHEM confidence score (0-1)
|
| 149 |
+
- Quote verification results
|
| 150 |
+
- Evidence chunks with citations
|
| 151 |
|
| 152 |
### POST /recommend/stream
|
| 153 |
|
| 154 |
+
Server-sent events for token-by-token explanation streaming.
|
| 155 |
|
| 156 |
### GET /health
|
| 157 |
|
| 158 |
+
```json
|
| 159 |
+
{"status": "healthy", "qdrant_connected": true, "llm_reachable": true}
|
| 160 |
+
```
|
| 161 |
|
| 162 |
### GET /metrics
|
| 163 |
|
| 164 |
+
Prometheus metrics: `sage_request_latency_seconds`, `sage_cache_events_total`, `sage_errors_total`.
|
| 165 |
|
| 166 |
### GET /cache/stats
|
| 167 |
|
| 168 |
+
```json
|
| 169 |
+
{"size": 42, "hit_rate": 0.35, "exact_hits": 10, "semantic_hits": 5, "misses": 27}
|
| 170 |
+
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 171 |
|
| 172 |
+
---
|
| 173 |
|
| 174 |
+
## Evaluation
|
| 175 |
|
| 176 |
```bash
|
| 177 |
+
make eval-quick # ~1 min: NDCG + HHEM only
|
| 178 |
+
make eval # ~5 min: standard pre-commit
|
| 179 |
+
make eval-all # ~15 min: complete reproducible suite
|
| 180 |
+
make load-test # P99 latency against production
|
| 181 |
```
|
| 182 |
|
| 183 |
+
See `make help` for all targets.
|
| 184 |
+
|
| 185 |
+
---
|
| 186 |
+
|
| 187 |
## Project Structure
|
| 188 |
|
| 189 |
```
|
| 190 |
sage/
|
| 191 |
+
├── adapters/ # External integrations (Qdrant, LLM, HHEM)
|
| 192 |
+
├── api/ # FastAPI routes, middleware, Prometheus metrics
|
| 193 |
+
├── core/ # Domain models, aggregation, verification, chunking
|
| 194 |
+
├── services/ # Business logic (retrieval, explanation, cache)
|
|
|
|
| 195 |
scripts/
|
| 196 |
+
├── pipeline.py # Data ingestion and embedding
|
| 197 |
+
├── evaluation.py # NDCG, precision, recall, novelty, baselines
|
| 198 |
+
├── faithfulness.py # HHEM, RAGAS, grounding delta
|
| 199 |
+
├── human_eval.py # Interactive human evaluation
|
| 200 |
+
├── load_test.py # P99 latency benchmarking
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 201 |
```
|
| 202 |
|
| 203 |
+
---
|
| 204 |
+
|
| 205 |
+
## Failure Modes (By Design)
|
| 206 |
|
| 207 |
+
| Condition | System Behavior |
|
| 208 |
+
|-----------|-----------------|
|
| 209 |
+
| Insufficient evidence (< 2 chunks) | Refuses to explain |
|
| 210 |
+
| Low relevance (top score < 0.5) | Refuses to explain |
|
| 211 |
+
| Quote not found in evidence | Falls back to paraphrased claims |
|
| 212 |
+
| HHEM score < 0.5 | Flags as uncertain |
|
| 213 |
+
|
| 214 |
+
The system refuses to hallucinate rather than confidently stating unsupported claims.
|
| 215 |
+
|
| 216 |
+
---
|
| 217 |
|
| 218 |
## License
|
| 219 |
|
| 220 |
+
Academic/portfolio use only. Uses Amazon Reviews 2023 dataset.
|
docs/chunking_decisions.md
ADDED
|
@@ -0,0 +1,99 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Chunking Strategy Decisions
|
| 2 |
+
|
| 3 |
+
## Strategy Overview
|
| 4 |
+
|
| 5 |
+
| Review Length | Strategy | Rationale |
|
| 6 |
+
|--------------|----------|-----------|
|
| 7 |
+
| < 200 tokens | No chunking | Most reviews are single-topic |
|
| 8 |
+
| 200-500 tokens | Semantic chunking (85th percentile breakpoint) | Preserves topic coherence |
|
| 9 |
+
| > 500 tokens | Semantic + sliding window fallback | Handles very long mixed-topic reviews |
|
| 10 |
+
|
| 11 |
+
Token estimation: ~4 chars/token (typical for English text with WordPiece tokenizers).
|
| 12 |
+
|
| 13 |
+
---
|
| 14 |
+
|
| 15 |
+
## Why Semantic Chunking?
|
| 16 |
+
|
| 17 |
+
### Failure Modes of Naive (Fixed-Window) Chunking
|
| 18 |
+
|
| 19 |
+
1. **Mid-sentence splits**: "The battery lasts 8 hours but" / "only if you disable WiFi" - the conditional is severed from the claim, causing the LLM to potentially cite "battery lasts 8 hours" without the critical qualifier.
|
| 20 |
+
|
| 21 |
+
2. **Aspect fragmentation**: A review discussing battery, then screen, then price gets randomly sliced. Retrieval for "battery life" might return a chunk containing "...great battery. The screen however is dim and..." - mixing positive battery sentiment with negative screen sentiment.
|
| 22 |
+
|
| 23 |
+
3. **Evidence dilution**: When a user asks about "noise cancellation", a chunk containing half a sentence about noise cancellation plus unrelated content about packaging provides weaker evidence than a chunk focused entirely on audio quality.
|
| 24 |
+
|
| 25 |
+
### How Semantic Chunking Improves Faithfulness
|
| 26 |
+
|
| 27 |
+
Semantic chunking uses embedding similarity between adjacent sentences to detect natural topic transitions. When a reviewer shifts from "battery life" to "build quality", sentence embeddings show a similarity drop. We split at these drops (below 85th percentile):
|
| 28 |
+
|
| 29 |
+
1. **Preserves complete arguments**: Claims stay with their evidence and qualifiers
|
| 30 |
+
2. **Creates topically coherent chunks**: Each chunk discusses one aspect
|
| 31 |
+
3. **Improves HHEM scores**: Hallucination detection works better with tight topics
|
| 32 |
+
|
| 33 |
+
---
|
| 34 |
+
|
| 35 |
+
## Worked Example
|
| 36 |
+
|
| 37 |
+
**Original review (320 tokens):**
|
| 38 |
+
> "I bought these headphones for my commute. The noise cancellation is exceptional - it blocks out subway noise completely, even announcements. I tested it on a plane and the engine drone disappeared. However, the comfort is a different story. After 2 hours my ears hurt from the pressure. The headband also feels cheap and creaks when I move."
|
| 39 |
+
|
| 40 |
+
**Naive chunking (150 tokens/chunk):**
|
| 41 |
+
- Chunk 1: "...exceptional - it blocks out subway noise completely, even announcements. I tested it on a"
|
| 42 |
+
- Chunk 2: "plane and the engine drone disappeared. However, the comfort is..."
|
| 43 |
+
|
| 44 |
+
**Semantic chunking:**
|
| 45 |
+
- Chunk 1: Complete noise cancellation evidence (subway + plane tests together)
|
| 46 |
+
- Chunk 2: Complete comfort critique (ears + headband together)
|
| 47 |
+
|
| 48 |
+
The semantic version keeps the complete noise cancellation evidence together for stronger grounding.
|
| 49 |
+
|
| 50 |
+
---
|
| 51 |
+
|
| 52 |
+
## Mixed Sentiment Handling
|
| 53 |
+
|
| 54 |
+
**Example:** "Battery life is amazing but the build quality is garbage"
|
| 55 |
+
|
| 56 |
+
**Does the chunker split this?** No - intentionally.
|
| 57 |
+
|
| 58 |
+
**Arguments against splitting (why we chose this):**
|
| 59 |
+
- Splitting mid-sentence creates grammatically broken chunks
|
| 60 |
+
- The "but" contrast is meaningful information
|
| 61 |
+
- Faithfulness requires citing what reviewers actually said
|
| 62 |
+
- Rating filter (min_rating=4.0) excludes low-rated reviews with mixed sentiment
|
| 63 |
+
|
| 64 |
+
---
|
| 65 |
+
|
| 66 |
+
## Edge Cases
|
| 67 |
+
|
| 68 |
+
### 1. Very Short Reviews (< 50 tokens)
|
| 69 |
+
Example: "Works great!" or "Exactly as described"
|
| 70 |
+
|
| 71 |
+
**Handling:** No chunking. Become single chunks.
|
| 72 |
+
|
| 73 |
+
**Rationale:** Short reviews are single-topic. Main risk is LLM over-extrapolating from thin evidence, caught by HHEM.
|
| 74 |
+
|
| 75 |
+
### 2. HTML Artifacts
|
| 76 |
+
Example: "Great product!<br /><br />Fast shipping.<br />[[VIDEOID:abc123]]"
|
| 77 |
+
|
| 78 |
+
**Handling:** `split_sentences()` replaces `<br />` with spaces. Video IDs pass through.
|
| 79 |
+
|
| 80 |
+
### 3. Mixed Language Content
|
| 81 |
+
Example: "Muy bueno! Great product."
|
| 82 |
+
|
| 83 |
+
**Handling:** Sentence splitter handles basic mixed content. E5-small primarily trained on English, so non-English chunks may have lower retrieval quality.
|
| 84 |
+
|
| 85 |
+
### 4. Numbers and Specifications
|
| 86 |
+
Example: "Battery: 8hrs. Weight: 250g. Price: $49.99"
|
| 87 |
+
|
| 88 |
+
**Handling:** Kept together as single chunk. Specification lists are valuable evidence.
|
| 89 |
+
|
| 90 |
+
### 5. Sarcasm and Irony
|
| 91 |
+
Example: "Oh yeah, 'great' battery life - lasted 2 whole hours"
|
| 92 |
+
|
| 93 |
+
**Handling:** Not detected. Dense retrievers encode topic, not sentiment. Rating filter is the defense (sarcastic reviews typically have low ratings).
|
| 94 |
+
|
| 95 |
+
---
|
| 96 |
+
|
| 97 |
+
## Implementation Reference
|
| 98 |
+
|
| 99 |
+
See `sage/core/chunking.py` for implementation.
|
sage/services/baselines.py
CHANGED
|
@@ -242,3 +242,54 @@ def load_product_embeddings_from_qdrant() -> dict[str, np.ndarray]:
|
|
| 242 |
product_embeddings[product_id] = normalize_vectors(mean_vec)
|
| 243 |
|
| 244 |
return product_embeddings
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 242 |
product_embeddings[product_id] = normalize_vectors(mean_vec)
|
| 243 |
|
| 244 |
return product_embeddings
|
| 245 |
+
|
| 246 |
+
|
| 247 |
+
def compute_item_popularity_from_qdrant(
|
| 248 |
+
normalize: bool = True,
|
| 249 |
+
) -> dict[str, float] | dict[str, int]:
|
| 250 |
+
"""
|
| 251 |
+
Compute item popularity (chunk count per product) from Qdrant.
|
| 252 |
+
|
| 253 |
+
This allows computing beyond-accuracy metrics (novelty, diversity)
|
| 254 |
+
without requiring local splits.
|
| 255 |
+
|
| 256 |
+
Args:
|
| 257 |
+
normalize: If True, return probabilities (0-1). If False, return raw counts.
|
| 258 |
+
|
| 259 |
+
Returns:
|
| 260 |
+
Dict mapping product_id to popularity (probability if normalize=True,
|
| 261 |
+
raw count if normalize=False).
|
| 262 |
+
"""
|
| 263 |
+
from sage.adapters.vector_store import get_client
|
| 264 |
+
|
| 265 |
+
client = get_client()
|
| 266 |
+
|
| 267 |
+
# Scroll through all points (without vectors for speed)
|
| 268 |
+
counts: dict[str, int] = Counter()
|
| 269 |
+
offset = None
|
| 270 |
+
|
| 271 |
+
while True:
|
| 272 |
+
results, offset = client.scroll(
|
| 273 |
+
collection_name=COLLECTION_NAME,
|
| 274 |
+
limit=1000,
|
| 275 |
+
offset=offset,
|
| 276 |
+
with_vectors=False,
|
| 277 |
+
)
|
| 278 |
+
|
| 279 |
+
for point in results:
|
| 280 |
+
product_id = point.payload.get("product_id")
|
| 281 |
+
if product_id:
|
| 282 |
+
counts[product_id] += 1
|
| 283 |
+
|
| 284 |
+
if offset is None:
|
| 285 |
+
break
|
| 286 |
+
|
| 287 |
+
if not normalize:
|
| 288 |
+
return dict(counts)
|
| 289 |
+
|
| 290 |
+
# Normalize to probabilities
|
| 291 |
+
total = sum(counts.values())
|
| 292 |
+
if total == 0:
|
| 293 |
+
return {}
|
| 294 |
+
|
| 295 |
+
return {product_id: count / total for product_id, count in counts.items()}
|
scripts/evaluation.py
CHANGED
|
@@ -28,6 +28,7 @@ from sage.services.baselines import (
|
|
| 28 |
ItemKNNBaseline,
|
| 29 |
PopularityBaseline,
|
| 30 |
RandomBaseline,
|
|
|
|
| 31 |
load_product_embeddings_from_qdrant,
|
| 32 |
)
|
| 33 |
from sage.config import get_logger, log_banner, log_section, log_kv
|
|
@@ -351,18 +352,25 @@ def main():
|
|
| 351 |
total_items = len(item_embeddings)
|
| 352 |
logger.info("Products in catalog: %d", total_items)
|
| 353 |
|
| 354 |
-
# Try to load splits for
|
| 355 |
-
item_popularity = None
|
| 356 |
train_records = None
|
| 357 |
all_products = None
|
|
|
|
| 358 |
try:
|
| 359 |
train_df, _, _ = load_splits()
|
| 360 |
train_records = train_df.to_dict("records")
|
| 361 |
all_products = list(train_df["parent_asin"].unique())
|
| 362 |
item_popularity = compute_item_popularity(train_records, item_key="parent_asin")
|
| 363 |
-
logger.info("Loaded splits for
|
| 364 |
except FileNotFoundError:
|
| 365 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 366 |
|
| 367 |
# Load eval cases
|
| 368 |
logger.info("Loading evaluation dataset: %s", args.dataset)
|
|
@@ -403,14 +411,20 @@ def main():
|
|
| 403 |
"ndcg_at_10": best_ndcg,
|
| 404 |
}
|
| 405 |
|
| 406 |
-
# Baseline comparison
|
| 407 |
if args.baselines:
|
| 408 |
-
if train_records is None:
|
| 409 |
-
|
| 410 |
-
|
| 411 |
-
|
| 412 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 413 |
run_baseline_comparison(cases, train_records, all_products, item_embeddings)
|
|
|
|
|
|
|
| 414 |
|
| 415 |
# Save results (uses dataset stem as prefix for both timestamped and latest files)
|
| 416 |
prefix = Path(args.dataset).stem
|
|
|
|
| 28 |
ItemKNNBaseline,
|
| 29 |
PopularityBaseline,
|
| 30 |
RandomBaseline,
|
| 31 |
+
compute_item_popularity_from_qdrant,
|
| 32 |
load_product_embeddings_from_qdrant,
|
| 33 |
)
|
| 34 |
from sage.config import get_logger, log_banner, log_section, log_kv
|
|
|
|
| 352 |
total_items = len(item_embeddings)
|
| 353 |
logger.info("Products in catalog: %d", total_items)
|
| 354 |
|
| 355 |
+
# Try to load splits for baseline comparison (optional)
|
|
|
|
| 356 |
train_records = None
|
| 357 |
all_products = None
|
| 358 |
+
item_counts = None # Raw counts for baseline comparison
|
| 359 |
try:
|
| 360 |
train_df, _, _ = load_splits()
|
| 361 |
train_records = train_df.to_dict("records")
|
| 362 |
all_products = list(train_df["parent_asin"].unique())
|
| 363 |
item_popularity = compute_item_popularity(train_records, item_key="parent_asin")
|
| 364 |
+
logger.info("Loaded splits for baseline comparison")
|
| 365 |
except FileNotFoundError:
|
| 366 |
+
# Fall back to Qdrant-based popularity for beyond-accuracy metrics
|
| 367 |
+
logger.info("Splits not available - computing popularity from Qdrant")
|
| 368 |
+
item_popularity = compute_item_popularity_from_qdrant(normalize=True)
|
| 369 |
+
item_counts = compute_item_popularity_from_qdrant(normalize=False)
|
| 370 |
+
all_products = list(item_embeddings.keys())
|
| 371 |
+
logger.info(
|
| 372 |
+
"Computed popularity for %d products from Qdrant", len(item_popularity)
|
| 373 |
+
)
|
| 374 |
|
| 375 |
# Load eval cases
|
| 376 |
logger.info("Loading evaluation dataset: %s", args.dataset)
|
|
|
|
| 411 |
"ndcg_at_10": best_ndcg,
|
| 412 |
}
|
| 413 |
|
| 414 |
+
# Baseline comparison
|
| 415 |
if args.baselines:
|
| 416 |
+
if train_records is None and item_counts is not None:
|
| 417 |
+
# Create pseudo-interactions from Qdrant counts for baseline comparison
|
| 418 |
+
logger.info("Using Qdrant-based counts for baseline comparison")
|
| 419 |
+
train_records = [
|
| 420 |
+
{"parent_asin": pid}
|
| 421 |
+
for pid, count in item_counts.items()
|
| 422 |
+
for _ in range(count)
|
| 423 |
+
]
|
| 424 |
+
if train_records is not None:
|
| 425 |
run_baseline_comparison(cases, train_records, all_products, item_embeddings)
|
| 426 |
+
else:
|
| 427 |
+
logger.warning("Skipping baselines - no data available")
|
| 428 |
|
| 429 |
# Save results (uses dataset stem as prefix for both timestamped and latest files)
|
| 430 |
prefix = Path(args.dataset).stem
|
scripts/faithfulness.py
CHANGED
|
@@ -189,6 +189,18 @@ def run_evaluation(n_samples: int, run_ragas: bool = False):
|
|
| 189 |
"faithfulness_std": ragas_report.std_score,
|
| 190 |
}
|
| 191 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 192 |
ts_file = save_results(results, "faithfulness")
|
| 193 |
logger.info("Saved: %s", ts_file)
|
| 194 |
|
|
@@ -348,6 +360,126 @@ def run_adjusted_calculation():
|
|
| 348 |
logger.info("Saved: %s", ts_file)
|
| 349 |
|
| 350 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 351 |
# ============================================================================
|
| 352 |
# Main
|
| 353 |
# ============================================================================
|
|
@@ -361,12 +493,17 @@ def main():
|
|
| 361 |
parser.add_argument(
|
| 362 |
"--adjusted", action="store_true", help="Calculate adjusted metrics"
|
| 363 |
)
|
|
|
|
|
|
|
|
|
|
| 364 |
args = parser.parse_args()
|
| 365 |
|
| 366 |
if args.analyze:
|
| 367 |
run_failure_analysis()
|
| 368 |
elif args.adjusted:
|
| 369 |
run_adjusted_calculation()
|
|
|
|
|
|
|
| 370 |
else:
|
| 371 |
run_evaluation(n_samples=args.samples, run_ragas=args.ragas)
|
| 372 |
|
|
|
|
| 189 |
"faithfulness_std": ragas_report.std_score,
|
| 190 |
}
|
| 191 |
|
| 192 |
+
# Document RAGAS metric limitations
|
| 193 |
+
results["ragas_limitations"] = {
|
| 194 |
+
"metrics_available": ["faithfulness"],
|
| 195 |
+
"metrics_unavailable": {
|
| 196 |
+
"answer_relevancy": "Requires embeddings model; RAGAS doesn't support Anthropic as embeddings provider",
|
| 197 |
+
"context_precision": "Requires ground-truth reference answers per query (not available)",
|
| 198 |
+
"context_recall": "Requires ground-truth reference answers per query (not available)",
|
| 199 |
+
},
|
| 200 |
+
"primary_metric": "claim_level_hhem",
|
| 201 |
+
"rationale": "Claim-level HHEM (96.8%) is more reliable than full-explanation RAGAS for citation-heavy explanations",
|
| 202 |
+
}
|
| 203 |
+
|
| 204 |
ts_file = save_results(results, "faithfulness")
|
| 205 |
logger.info("Saved: %s", ts_file)
|
| 206 |
|
|
|
|
| 360 |
logger.info("Saved: %s", ts_file)
|
| 361 |
|
| 362 |
|
| 363 |
+
# ============================================================================
|
| 364 |
+
# SECTION: Grounding Delta Experiment
|
| 365 |
+
# ============================================================================
|
| 366 |
+
|
| 367 |
+
|
| 368 |
+
def run_grounding_delta():
|
| 369 |
+
"""
|
| 370 |
+
Compare HHEM scores WITH vs WITHOUT evidence grounding.
|
| 371 |
+
|
| 372 |
+
This shows the value of RAG: how much does grounding reduce hallucination?
|
| 373 |
+
"""
|
| 374 |
+
from sage.adapters.llm import get_llm_client
|
| 375 |
+
from sage.services import get_explanation_services
|
| 376 |
+
from sage.services.retrieval import get_candidates
|
| 377 |
+
|
| 378 |
+
log_banner(logger, "GROUNDING DELTA EXPERIMENT")
|
| 379 |
+
logger.info("Comparing hallucination rates WITH vs WITHOUT evidence grounding")
|
| 380 |
+
|
| 381 |
+
queries = EVALUATION_QUERIES[:10]
|
| 382 |
+
_, detector = get_explanation_services()
|
| 383 |
+
llm = get_llm_client()
|
| 384 |
+
|
| 385 |
+
with_evidence = []
|
| 386 |
+
without_evidence = []
|
| 387 |
+
|
| 388 |
+
for i, query in enumerate(queries, 1):
|
| 389 |
+
logger.info('[%d/%d] "%s"', i, len(queries), query)
|
| 390 |
+
|
| 391 |
+
products = get_candidates(
|
| 392 |
+
query=query,
|
| 393 |
+
k=1,
|
| 394 |
+
min_rating=4.0,
|
| 395 |
+
aggregation=AggregationMethod.MAX,
|
| 396 |
+
)
|
| 397 |
+
if not products:
|
| 398 |
+
continue
|
| 399 |
+
|
| 400 |
+
product = products[0]
|
| 401 |
+
|
| 402 |
+
# Get evidence chunks for this product
|
| 403 |
+
from sage.services.retrieval import retrieve_chunks
|
| 404 |
+
|
| 405 |
+
all_chunks = retrieve_chunks(query, limit=100)
|
| 406 |
+
# Filter to just this product's chunks
|
| 407 |
+
evidence = [c for c in all_chunks if c.product_id == product.product_id][
|
| 408 |
+
:MAX_EVIDENCE
|
| 409 |
+
]
|
| 410 |
+
evidence_texts = [c.text for c in evidence]
|
| 411 |
+
|
| 412 |
+
if not evidence_texts:
|
| 413 |
+
continue
|
| 414 |
+
|
| 415 |
+
# Generate WITH evidence (grounded)
|
| 416 |
+
system_prompt = "You are a helpful product recommendation assistant."
|
| 417 |
+
grounded_user = f"""Based on customer reviews, explain why this product is good for: "{query}"
|
| 418 |
+
|
| 419 |
+
EVIDENCE FROM REVIEWS:
|
| 420 |
+
{chr(10).join(f"- {t}" for t in evidence_texts[:3])}
|
| 421 |
+
|
| 422 |
+
Write a brief 2-3 sentence recommendation based ONLY on the evidence above."""
|
| 423 |
+
|
| 424 |
+
try:
|
| 425 |
+
grounded_response, _ = llm.generate(system_prompt, grounded_user)
|
| 426 |
+
grounded_hhem = detector.check_explanation(
|
| 427 |
+
evidence_texts, grounded_response
|
| 428 |
+
)
|
| 429 |
+
with_evidence.append(grounded_hhem.score)
|
| 430 |
+
logger.info(" WITH evidence: %.3f", grounded_hhem.score)
|
| 431 |
+
except Exception:
|
| 432 |
+
logger.exception(" Error with grounded generation")
|
| 433 |
+
continue
|
| 434 |
+
|
| 435 |
+
# Generate WITHOUT evidence (ungrounded)
|
| 436 |
+
ungrounded_user = f"""Recommend a product for: "{query}"
|
| 437 |
+
|
| 438 |
+
Write a brief 2-3 sentence recommendation. You may make reasonable assumptions about the product."""
|
| 439 |
+
|
| 440 |
+
try:
|
| 441 |
+
ungrounded_response, _ = llm.generate(system_prompt, ungrounded_user)
|
| 442 |
+
ungrounded_hhem = detector.check_explanation(
|
| 443 |
+
evidence_texts, ungrounded_response
|
| 444 |
+
)
|
| 445 |
+
without_evidence.append(ungrounded_hhem.score)
|
| 446 |
+
logger.info(" WITHOUT evidence: %.3f", ungrounded_hhem.score)
|
| 447 |
+
except Exception:
|
| 448 |
+
logger.exception(" Error with ungrounded generation")
|
| 449 |
+
|
| 450 |
+
# Summary
|
| 451 |
+
log_banner(logger, "GROUNDING DELTA RESULTS")
|
| 452 |
+
|
| 453 |
+
if with_evidence and without_evidence:
|
| 454 |
+
with_mean = np.mean(with_evidence)
|
| 455 |
+
without_mean = np.mean(without_evidence)
|
| 456 |
+
delta = with_mean - without_mean
|
| 457 |
+
|
| 458 |
+
logger.info("Samples: %d", min(len(with_evidence), len(without_evidence)))
|
| 459 |
+
logger.info("WITH evidence (grounded): %.3f mean HHEM", with_mean)
|
| 460 |
+
logger.info("WITHOUT evidence (halluc): %.3f mean HHEM", without_mean)
|
| 461 |
+
logger.info("Delta (grounding benefit): +%.3f", delta)
|
| 462 |
+
logger.info(
|
| 463 |
+
"Interpretation: Grounding %s hallucination by %.1f%%",
|
| 464 |
+
"reduces" if delta > 0 else "increases",
|
| 465 |
+
abs(delta) * 100,
|
| 466 |
+
)
|
| 467 |
+
|
| 468 |
+
# Save results
|
| 469 |
+
results = {
|
| 470 |
+
"n_samples": min(len(with_evidence), len(without_evidence)),
|
| 471 |
+
"with_evidence_mean": float(with_mean),
|
| 472 |
+
"without_evidence_mean": float(without_mean),
|
| 473 |
+
"delta": float(delta),
|
| 474 |
+
"with_evidence_scores": with_evidence,
|
| 475 |
+
"without_evidence_scores": without_evidence,
|
| 476 |
+
}
|
| 477 |
+
ts_file = save_results(results, "grounding_delta")
|
| 478 |
+
logger.info("Saved: %s", ts_file)
|
| 479 |
+
else:
|
| 480 |
+
logger.warning("Not enough samples for comparison")
|
| 481 |
+
|
| 482 |
+
|
| 483 |
# ============================================================================
|
| 484 |
# Main
|
| 485 |
# ============================================================================
|
|
|
|
| 493 |
parser.add_argument(
|
| 494 |
"--adjusted", action="store_true", help="Calculate adjusted metrics"
|
| 495 |
)
|
| 496 |
+
parser.add_argument(
|
| 497 |
+
"--delta", action="store_true", help="Run grounding delta experiment"
|
| 498 |
+
)
|
| 499 |
args = parser.parse_args()
|
| 500 |
|
| 501 |
if args.analyze:
|
| 502 |
run_failure_analysis()
|
| 503 |
elif args.adjusted:
|
| 504 |
run_adjusted_calculation()
|
| 505 |
+
elif args.delta:
|
| 506 |
+
run_grounding_delta()
|
| 507 |
else:
|
| 508 |
run_evaluation(n_samples=args.samples, run_ragas=args.ragas)
|
| 509 |
|
scripts/human_eval.py
CHANGED
|
@@ -374,6 +374,18 @@ def analyze_results():
|
|
| 374 |
"timestamp": datetime.now().isoformat(),
|
| 375 |
"n_samples": len(rated),
|
| 376 |
"n_total": len(samples),
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 377 |
"dimensions": dimensions_results,
|
| 378 |
"overall_helpfulness": round(overall, 2),
|
| 379 |
"target": HELPFULNESS_TARGET,
|
|
|
|
| 374 |
"timestamp": datetime.now().isoformat(),
|
| 375 |
"n_samples": len(rated),
|
| 376 |
"n_total": len(samples),
|
| 377 |
+
"methodology": {
|
| 378 |
+
"evaluator": "Single rater (developer/researcher)",
|
| 379 |
+
"instructions": "Rate each dimension 1-5 Likert: 1=strongly disagree, 5=strongly agree",
|
| 380 |
+
"dimensions": {
|
| 381 |
+
"comprehension": "I understood why this item was recommended",
|
| 382 |
+
"trust": "I trust this explanation is accurate",
|
| 383 |
+
"usefulness": "This explanation helped me make a decision",
|
| 384 |
+
"satisfaction": "I am satisfied with this explanation",
|
| 385 |
+
},
|
| 386 |
+
"sample_selection": "35 natural queries (balanced by category) + 15 config queries",
|
| 387 |
+
"inter_annotator_agreement": "N/A (single rater)",
|
| 388 |
+
},
|
| 389 |
"dimensions": dimensions_results,
|
| 390 |
"overall_helpfulness": round(overall, 2),
|
| 391 |
"target": HELPFULNESS_TARGET,
|