Skip to content

Conversation

@oxinabox
Copy link
Member

@oxinabox oxinabox commented Sep 12, 2019

Preview: http://www.juliadiff.org/ChainRules.jl/preview-PR103/


Old OP:

This will describe the post JuliaDiff/ChainRulesCore.jl#30
world, so we won't merge this til after that then.

But reading this will help reviewers of that PR and
#91

@oxinabox oxinabox changed the title [WIP] introdocs + instructions on writing good rules introdocs + demo + instructions on writing good rules Sep 13, 2019
@oxinabox
Copy link
Member Author

We can break this up later into multiple pages in the docs.
But this is an improvment on the status quo now.

When reviewing this remember you can render in the github markdown renderer.
THough it displays julias !!! blocks wrong.

image

After reviewing this PR.
please carry forth and review
#91 and maybe even #30

@willtebbutt
Copy link
Member

Is this ready for review, or are you still actively working on it?

@mattBrzezinski mattBrzezinski self-assigned this Sep 13, 2019
@oxinabox
Copy link
Member Author

Is this ready for review, or are you still actively working on it?

This is ready for review.
It will be merged after #91
because it decribes that world,
but it should be read by people before reviewing #91

@mattBrzezinski
Copy link
Member

One generic comment, can we collapse a lot of these lines together. It seems like you typed this up in Latex and pasted it into a .MD, so a lot of the formatting is off.

If you don't mind, I can push changes for that just let me know!

using Zygote
Zygote.gradient(foo, x)
# (-2.0638950738662625,)
```
Copy link
Member Author

Choose a reason for hiding this comment

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

@wesselb @willtebbutt can have Nabla example?
I tried but failed to get Nabla to do this.

@oxinabox
Copy link
Member Author

One generic comment, can we collapse a lot of these lines together. It seems like you typed this up in Latex and pasted it into a .MD, so a lot of the formatting is off.

Nope, I wrote it directly in markdown.
(with the Atom extension for julia so i could type unicode directly).

I just like to break-lines more than I should.
(I do kinda like at least 1 line break per sentence and it makes git work better)

Copy link
Member

@simeonschaub simeonschaub left a comment

Choose a reason for hiding this comment

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

Great work, this will definitely be appreciated! Should we also reference this in a CONTRIBUTING file?

- `Δx` is the input to a propagator, (i.e a _seed_ for a _pullback_; or a _perturbation_ for a _pushforward_)
- `∂x` is the output of a propagator
- `dx` could be anything, including a pullback. It really should show up outside of tests.
- `` is a derivative moving forward.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- `` is a derivative moving forward.
- `` is the intermediary partial derivative used for forward-mode.

- `∂x` is the output of a propagator
- `dx` could be anything, including a pullback. It really should show up outside of tests.
- `` is a derivative moving forward.
- `` is a dderivative moving backward.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- `` is a dderivative moving backward.
- `` is the intermediary sensitivity used for reverse-mode.

oxinabox and others added 3 commits September 23, 2019 19:12
oxinabox and others added 2 commits September 23, 2019 20:19
@oxinabox
Copy link
Member Author

oxinabox commented Sep 24, 2019

This should be about the last of it.
Hopefully merging tomorrow
I am tempted to say any further suggestions can come as follow up PRs.

@oxinabox
Copy link
Member Author

merging in 1 hour.

@oxinabox oxinabox merged commit ad16dab into master Sep 25, 2019
@ararslan ararslan deleted the ox/introdocs branch September 25, 2019 19:00
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.