README: show the library being used - #84
Merged
Merged
Conversation
Tier 9 published a tolerance table and a benchmark page, and the README named neither the tools that produce them nor the three bindings that have to be built before a real engine runs anything. A number is only reproducible if somebody can find the command. Also corrects the analyze and format lines, which said `.` where the CI scopes to packages/. Running them as written fails on the Flutter example, whose generated sources plain Dart tooling cannot parse, which is why that has its own job.
The README jumped from Installation to Architecture. For a library whose whole claim is export, generate, gate, not showing that loop was the omission that mattered: a reader could finish the page knowing what Fluttorch believes and not one line of how to call it. Usage now covers the loop and the parts of it that are not guessable. What a failure report says and why drift is deliberately not an exception. That capabilities are asked for rather than assumed, and that asking for determinism you cannot have throws. That preprocessing is generated because a centre crop with an odd margin produces a picture either way. That a bundle can be more than one file, and that omitting the second one is refused rather than run. Every signature in it was read off the generated code or the source, not recalled. Two were wrong on the first pass: the exception prints `on "image"` rather than `at image`, and fromSource takes a Float32List. The other direction: Installation loses two sentences of attestation history that belong in the release notes, and the roadmap's five paragraphs of shipped tiers become a table. Neither was wrong. Both were between a reader and what they came for.
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
1 participant
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.
The README went from Installation straight to Architecture. For a library whose
whole claim is export, generate, gate, that loop was never shown: a reader could
finish the page knowing what Fluttorch believes and not one line of how to call
it. Kdrant and Kmemo both carry a deep
Usagesection and this had none.What was added
Usage, with the loop and the parts of it that are not guessable from theprose above it.
exception.
determinism a device cannot give throws instead of quietly running without it.
on one row or the row above it and both produce a picture.
refused rather than run: a graph without its weights still parses, still
declares every shape, and answers from nothing.
runIntowith the measured saving beside it, and the honest caveat that itdoes not scale with the model.
Every signature was read off the generated code or the source rather than
recalled. Two were wrong on the first pass and are fixed: the exception prints
on "image"rather thanat image, andfromSourcetakes aFloat32List.What was removed
Installation loses two sentences about which versions predate the attestation
workflow. The roadmap's five paragraphs of shipped tiers become a table, and
1.0.0keeps its paragraph. Neither was wrong; both sat between a reader andwhat they came for.
Also corrects the analyze and format commands, which said
.where CI scopes topackages/. Run as written they fail on the Flutter example.Net: 239 added, 43 removed.