docs: improve public API documentation for human readability#5
Merged
Conversation
- README: add Quick Example and Architecture diagram showing type relationships (Tape → TrackedValue → Gradients, DualValue) - TrackedValue: explain struct purpose, detach (stop gradient flow), new (detached constant), node_id (gradient lookup), tangent (HVP) - Tape: expand docs on leaf, leaf_with_tangent, placeholder (two-phase recording), tracked_existing (rehydrating handles), attach_rule, free_graph (lifecycle), hvp (requirements and workflow) - Gradients: document leaf-only semantics and lookup pattern - PullbackPlan: explain build-once-execute-many pattern with example Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.
Summary
detach(stop gradient flow),new(detached constant),node_id(gradient lookup),tangent(HVP direction)leaf,leaf_with_tangent,placeholder(two-phase recording),tracked_existing,attach_rule,free_graph(lifecycle),hvp(requirements)Test plan
cargo fmt --all— cleancargo clippy --workspace— only pre-existing warningcargo nextest run --release --workspace— 60/60 passcargo test --doc --release --workspace— 24/24 pass🤖 Generated with Claude Code