Skip to content

Reduce README to factual project description - #36

Merged
Mark007-R merged 1 commit into
devfrom
chore/strip-readme-narrative
Aug 5, 2026
Merged

Mark007-R merged 1 commit into
devfrom
chore/strip-readme-narrative

Conversation

@Mark007-R

Copy link
Copy Markdown
Owner

Strips the project narrative, leaving what the repo is, how to run it, and what data it uses.

Removed

Section What it held
The headline: the leakage fix is the story Before/after AUC table and the leakage narrative
Final champion + the gap closed honestly Champion-vs-AutoGluon comparison
The four MLOps capabilities Headline metrics per capability
Frontier guard-rail: why LLMs don't do tabular fraud Claude-vs-XGBoost cost/latency/AUC table
MLOps ablation (L0 → L3) Per-layer AUC contribution
Architecture, Tests, Repo layout Design diagram, test breakdown, annotated layout

Kept

Live-demo link, the quick-start block verbatim (compose, MLflow, Streamlit, DVC, registry promote/rollback, feature benchmark, scripts/demo.sh, pytest incl. the CI-mode flag), the dataset table with row counts and windows, and the licence line verbatim (MIT. See LICENSE).

The dataset table keeps the chronological-split note, since that describes how the data is partitioned — needed to use the pipeline correctly — without the before/after narrative.

Verification

9,280 B → 1,731 B. No day/sprint/audit/champion/ablation/leakage/AUC/Claude markers remain. Every referenced path (LICENSE, app.py, scripts/demo.sh, dvc.yaml, tests/, docker-compose.yml) confirmed present.

Removes the leakage-fix headline, the champion-vs-AutoGluon table, the
four-MLOps-capabilities table, the frontier LLM comparison, the L0-L3
ablation, the architecture diagram, the test breakdown and the repo
layout. Keeps the live-demo link, the quick-start block verbatim, the
dataset table and the licence line unchanged. 9.3 KB to 1.7 KB.
Copilot AI lite review requested due to automatic review settings August 5, 2026 11:44
@Mark007-R
Mark007-R merged commit c4cf643 into dev Aug 5, 2026

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 was unable to review this pull request because the user who requested the review has reached their quota limit.

@Mark007-R
Mark007-R deleted the chore/strip-readme-narrative branch August 5, 2026 11:44
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