Skip to content

docs: align data description and refresh example metrics#12

Merged
AmirhosseinHonardoust merged 2 commits into
mainfrom
docs/fix-data-description-consistency
Jun 19, 2026
Merged

docs: align data description and refresh example metrics#12
AmirhosseinHonardoust merged 2 commits into
mainfrom
docs/fix-data-description-consistency

Conversation

@AmirhosseinHonardoust

Copy link
Copy Markdown
Owner

Fixes inconsistencies between the docs and the actual workflow.

  • Replace the inaccurate "highly separable" wording in train_model.py,
    dashboard_utils.py, and app.py. The generator deliberately produces
    overlapping classes with label noise, so the data is not highly
    separable. Wording now matches the README and generator.
  • Refresh the README example-metrics table to current values
    reproducible with --seed 42 (ROC-AUC unchanged at 0.976; AP, Brier,
    threshold, precision, recall, and flagged rate updated). Add a note
    that exact values can vary across scikit-learn/NumPy versions.
  • Add SciPy to the Tech Stack list (now an explicit dependency).

Verified locally: ruff/black/mypy clean, 34/34 tests pass (including
the data_note "synthetic" assertion). Metrics confirmed deterministic
across repeated runs.

@AmirhosseinHonardoust AmirhosseinHonardoust self-assigned this Jun 19, 2026
@AmirhosseinHonardoust AmirhosseinHonardoust added the enhancement New feature or request label Jun 19, 2026
@AmirhosseinHonardoust
AmirhosseinHonardoust merged commit bdb8069 into main Jun 19, 2026
8 checks passed
@AmirhosseinHonardoust
AmirhosseinHonardoust deleted the docs/fix-data-description-consistency branch June 19, 2026 22:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant