Skip to content

docs: full README rewrite — measured ML champions + honest metrics + production stack - #14

Merged
Mark007-R merged 1 commit into
mainfrom
docs/readme-rewrite
May 31, 2026
Merged

Mark007-R merged 1 commit into
mainfrom
docs/readme-rewrite

Conversation

@Mark007-R

Copy link
Copy Markdown
Owner

What this is

A fully new README reflecting the 7-day upgrade sprint, replacing the legacy feature-list version.

Highlights

  • Audit table — what was real ML vs not (keyword complaint scan + template RAG were not models; only VADER sentiment was real).
  • Measured metrics with source files:
    • Sentiment NLI zero-shot macro-F1 0.701 vs VADER 0.466 (Neutral F1 6× lift)
    • Complaint TF-IDF+LightGBM 0.8525 vs keyword 0.8335 — with an honest per-class win/loss split (wins delivery/portion/food-quality, loses price/ambience)
    • RAG context-recall +0.105 and <10 ms warm cache (240× vs cold)
    • Frontier comparison: specialized beats Claude/DistilBERT zero-shot on complaints + subset-accuracy
  • Signature-preservation story (Flask call-sites unchanged), 88-test suite, Docker + FastAPI + Redis production stack.

Scope

Docs only — Readme.md rewrite (+144 / −317). No code touched. All numbers cite committed files under results/ and docs/MODEL_CARD.md.

…oduction stack

Replaces the legacy feature-list README with a results-driven one reflecting the
7-day upgrade sprint:
- The "what was AI vs what is now ML" audit table (keyword/template were not models)
- Measured metrics with source files: sentiment NLI macro-F1 0.701 vs VADER 0.466;
  complaint TF-IDF+LGBM 0.8525 vs keyword 0.8335 (with honest per-class win/loss split);
  RAG context-recall +0.105 + <10ms warm cache; frontier comparison (specialized beats
  zero-shot on complaints/subset-accuracy)
- Signature-preservation story (Flask call-sites unchanged), 88-test suite, Docker/FastAPI/Redis stack
Copilot AI review requested due to automatic review settings May 31, 2026 17:34
@Mark007-R
Mark007-R merged commit f6e7477 into main May 31, 2026
1 check failed
@Mark007-R
Mark007-R deleted the docs/readme-rewrite branch May 31, 2026 17:34

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants