Align README, header and installation guidance with earlyon v0.3.0 - #7
Merged
Conversation
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
production-readyanywhere user-facing; "wrap anything", "take both savings", "earlyon is the pip install version", and the v0.2-era numeric claims are gone.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).computation_usedfield are removed, alt text corrected. Same visual identity, edited in the SVG sources.docs/benchmarks.json).CUDA_EVIDENCE.mderratum, and appended to the evidence JSON without altering recorded fields. Core fix deferred to a future patch per release policy — measured columns are unaffected.Verification
twine checkPASSED, installed-wheel smokeSMOKE OK, relative-link check clean, secret scan clean.