Skip to content

Align README, header and installation guidance with earlyon v0.3.0 - #7

Merged
sohams25 merged 1 commit into
mainfrom
docs/v0.3-readme-header-and-pypi
Jul 22, 2026
Merged

Align README, header and installation guidance with earlyon v0.3.0#7
sohams25 merged 1 commit into
mainfrom
docs/v0.3-readme-header-and-pypi

Conversation

@sohams25

Copy link
Copy Markdown
Owner

Documentation-only alignment of the public face with what v0.3.0 actually is. No product behavior, package version, tag or GitHub Release is changed.

What changed

  • Stale wording removed: no more production-ready anywhere user-facing; "wrap anything", "take both savings", "earlyon is the pip install version", and the v0.2-era numeric claims are gone.
  • Truthful installation: the primary command is pip install git+https://github.com/sohams25/earlyon@v0.3.0; PyPI appears only as a clearly labelled pending note (the package is not on PyPI yet — trusted publisher not configured).
  • Header/banner: subtitle now "Train, calibrate, and benchmark early-exit vision models"; SVGs are labelled illustrative, the "12%" figures and the deprecated computation_used field are removed, alt text corrected. Same visual identity, edited in the SVG sources.
  • Per-head calibration + explicit enablement documented: independent temperature per exit and final head, threshold search after fitting, split discipline, explicit disable that cannot fire through a sentinel; small pipeline flow diagram.
  • Benchmark evidence updated, negatives preserved: one bounded seeded CIFAR-10 run (1.10× throughput, worse median latency, competitive static MobileNetV2, noise 2.05× labelled synthetic best-case). Legacy v0.2 tables/appendix removed from the README (still quarantined in docs/benchmarks.json).
  • Erratum (#6): running the README example exposed that the FLOPs reuse detector false-positives on torchvision ResNet's shared zero-FLOP ReLUs, so the run's estimated fraction (0.88) came from the flagged low-confidence uniform fallback; fvcore attribution gives ~0.92 (~8% estimated saving, not 12%). Documented in the README table footnote, CUDA_EVIDENCE.md erratum, and appended to the evidence JSON without altering recorded fields. Core fix deferred to a future patch per release policy — measured columns are unaffected.
  • Static smaller-model comparison: new "Why not just deploy a smaller model?" section.
  • Execution modes separated: eager routed vs all-exits ONNX (not conditional execution) vs narrow staged runtime, stated before the deep docs.
  • Jetson/TensorRT status: procedures documented, no measurements published, no TensorRT claim, laptop-GPU results don't predict Jetson.
  • Checkpoint v2 + migration: what the format records, deterministic v1 migration verified against a genuine prior-version fixture, backup advice, migration-guide link.
  • Roadmap: completed v0.3 work removed; explicit feature freeze; narrow evidence-driven items only.

Verification

  • All 5 README Python blocks executed against v0.3.0.
  • 270 tests, 95% coverage, mypy strict, ruff/black/isort clean, build + twine check PASSED, installed-wheel smoke SMOKE OK, relative-link check clean, secret scan clean.

- intro rewritten: what earlyon does, then the execution limitation (eager
  routing; all-exits ONNX is not conditional early exit; staged runtime is
  narrow) before any example
- install: primary command is the v0.3.0 GitHub tag; PyPI shown only as a
  clearly labelled pending note
- banner/demo SVGs: subtitle now 'Train, calibrate, and benchmark early-exit
  vision models'; illustrative-only labelling; numeric per-exit percentages
  and the deprecated computation_used field removed; accurate alt text
- per-head calibration section + pipeline flow; explicit-enablement wording
- benchmark section: single bounded-run table with negatives preserved,
  noise 2.05x labelled synthetic best-case, legacy v0.2 tables and appendix
  removed (quarantined in docs/benchmarks.json)
- ERRATUM (#6): the run's estimated FLOPs fraction came from the flagged
  low-confidence uniform fallback (reuse detector false-positive on
  torchvision ResNet shared ReLU); fvcore attribution gives ~0.92 not 0.88
  (~8% estimated saving). Noted in README, CUDA_EVIDENCE.md and appended to
  the evidence JSON without altering recorded fields. No core code changed.
- 'Why not just deploy a smaller model?' section; execution/export modes
  and Jetson/TensorRT status sections; roadmap narrowed with explicit
  feature freeze; custom_ee claims scoped to the tested contract
- preferred examples use estimated_backbone_flops_fraction; archived
  marketing copy quarantine-labelled
@sohams25
sohams25 merged commit 266728c into main Jul 22, 2026
3 checks passed
@sohams25
sohams25 deleted the docs/v0.3-readme-header-and-pypi branch July 22, 2026 13:14
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