Skip to content

README: practical notes from a pre-release user study - #10

Merged
Akram Zaytar (Akramz) merged 1 commit into
mainfrom
readme-practical-notes
Oct 31, 2026
Merged

Akram Zaytar (Akramz) merged 1 commit into
mainfrom
readme-practical-notes

Conversation

@Akramz

Copy link
Copy Markdown
Collaborator

Docs only (README, +12/-6). Two agents used the library as new users (Helmets + AlphaEarth; UCI Adult and wine quality). These notes cover the problems that mislead users but are too large to fix in code before release; the code fixes go to v0.1.1.

Added, each verified against the code or a repro:

  • Assumptions: clustered labels (several rows per photo/field) need Split(name, groups=...). On Helmets (2 rows per photo), the default row split gave known-inclusion bias -0.06 / 70% coverage vs -0.017 / 95% with a photo split. The bootstrap then resamples whole clusters by default.
  • propensity_split: states the default (correction groups on labeled rows, each deployment row alone) and says to pass the same groups when folds are grouped. With 1 km block folds and the default, propensity AUC fell to 0.37.
  • Output: treat n_eff below a few dozen or auc near 1 as no usable estimate. Real Helmets printed n_eff 5, intervals [-0.04, 0.72], AUC 0.99, with no flag.
  • Input table: features must be numeric (strings crash with could not convert string to float); rows with a missing value are dropped; integer labels with a separate deployment file read as 3.0 and a model fitted on 3 is rejected; lat/lon must be exactly these names.
  • CLI: a --fit-model module in the current folder needs PYTHONPATH=. (checked).

Review: wording, and the "few dozen" n_eff rule of thumb, which is a judgment call.

🤖 Generated with Claude Code

Clustered labels need a grouped split; grouped folds need the same groups
in propensity_split; low n_eff or auc near 1 means no usable estimate;
features must be numeric; integer labels with a separate deployment file;
exact lat/lon names; PYTHONPATH for a local --fit-model module.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Akramz
Akram Zaytar (Akramz) merged commit 1700d14 into main Oct 31, 2026
5 checks passed
@Akramz
Akram Zaytar (Akramz) deleted the readme-practical-notes branch October 31, 2026 09:22
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.

1 participant