docs: improve onboarding docs and add Debug for Gradients#3
Merged
Conversation
- Add Getting Started section to README with Cargo.toml dependency lines for both tidu and chainrules (resolves critical onboarding blocker) - Add conceptual overview to lib.rs explaining the low-level AD model and the companion chainrules crate - Add inline comments to all rustdoc examples explaining record_op's third parameter (output_tangent) and pullback vs pullback_with_seed - Document that pullback() requires scalar loss and pullback_with_seed() is needed for non-scalar outputs - Document record_op parameters and leaf-only gradient storage - Add HVP conceptual intro explaining forward-over-reverse mode - Implement Debug for Gradients<V> where V::Tangent: Debug 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
Cargo.tomldependency lines for bothtiduandchainrules(critical onboarding blocker: new users' first build failed)lib.rsexplaining the low-level tape/rule/pullback model and the companionchainrulescraterecord_op's third parameter,pullback()vspullback_with_seed(), and HVPDebugforGradients<V>whereV::Tangent: Debug(enables idiomaticunwrap_err())Findings from a simulated new-user onboarding test across all 4 features.
Test plan
cargo fmt --allpassescargo clippy --workspacepasses (only pre-existing warning)cargo nextest run --release --workspace— 60/60 passcargo test --doc --release --workspace— 24/24 pass (1 ignored)🤖 Generated with Claude Code