-
Notifications
You must be signed in to change notification settings - Fork 89
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doc updates for ChainRulesCore 0.5 #152
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great 👏
Co-Authored-By: Nick Robinson <[email protected]>
Co-Authored-By: Nick Robinson <[email protected]>
Co-Authored-By: Nick Robinson <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Firstly, I agree with @nickrobinson251 that this is fantastic work. In no particular order:
- Looks like the
Why does frule and rrule return the function evaluation
section of the FAQ still requires updating. - Also, how would you feel about changing all references to autodiff / automatic differentiation to AD / algorithmic differentiation?
- In the "On writing good
rrule
andfrule
" bit, we should consider modifying the recommendations forZero()
orOne()
. In particular, removing any mention ofOne
because it's not generally appropriate or helpful. Additionally, the "Write Tests" section should probably be entitled "Write Tests using FiniteDifferences". Similarly, the "CAS Systems are your friends" should have some reference to them not being helpful when writing tests for derivatives.
These are valid points, but beyond he scope of this PR. Open an issue? |
Co-Authored-By: willtebbutt <[email protected]> Co-Authored-By: Nick Robinson <[email protected]>
Co-Authored-By: Nick Robinson <[email protected]>
New docs,
major change is about the pushforward now fused into the
frule
.