Skip to content
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

Merged
merged 8 commits into from
Jan 20, 2020
Merged

Doc updates for ChainRulesCore 0.5 #152

merged 8 commits into from
Jan 20, 2020

Conversation

oxinabox
Copy link
Member

New docs,
major change is about the pushforward now fused into the frule.

@nickrobinson251
Copy link
Contributor

view at http://www.juliadiff.org/ChainRules.jl/preview-PR152/

Copy link
Contributor

@nickrobinson251 nickrobinson251 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great 👏

docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
oxinabox and others added 2 commits January 18, 2020 12:23
Co-Authored-By: Nick Robinson <[email protected]>
Co-Authored-By: Nick Robinson <[email protected]>
Copy link
Member

@willtebbutt willtebbutt left a 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 and frule " bit, we should consider modifying the recommendations for Zero() or One(). In particular, removing any mention of One 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.

docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Outdated Show resolved Hide resolved
docs/src/index.md Show resolved Hide resolved
docs/src/index.md Show resolved Hide resolved
@oxinabox
Copy link
Member Author

Also, how would you feel about changing all references to autodiff / automatic differentiation to AD / algorithmic differentiation?
In the "On writing good rrule and frule " bit, we should consider modifying the recommendations for Zero() or One(). In particular, removing any mention of One 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?

@willtebbutt willtebbutt mentioned this pull request Jan 18, 2020
oxinabox and others added 2 commits January 20, 2020 12:53
Co-Authored-By: willtebbutt <[email protected]>
Co-Authored-By: Nick Robinson <[email protected]>
@oxinabox oxinabox merged commit 31c739c into master Jan 20, 2020
@nickrobinson251 nickrobinson251 deleted the ox/newcoredocs branch January 20, 2020 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants