RFC: Example Rule "Gallery" to showcase CRC best practices?

[doddgray]

RFC: Example Rule "Gallery" to showcase CRC best practices?

[oxinabox]

Perhaps we can do this in a way that just retrieves and shows the right code loaded from straight from github?

[doddgray]

That would be great. If you'd be open to that kind of addition I can look around for examples and try to get a pull request together. That would go to ChainRules.jl right?

[mcabbott]

It's a bit of a moving target, as we try to figure out the best practice. So I guess that pointing out which bits of ChainRules's source to look at might be better than writing code specifically about this, less likely to end up outdated? Perhaps the docs can guide you a bit as to what the various parts are doing, or (for instance) how the simplest version would work, before optimisations / care about 2nd derivatives adds complication.

[oxinabox]

That would be great. If you'd be open to that kind of addition I can look around for examples and try to get a pull request together. That would go to ChainRules.jl right?

Docs go in ChainRulesCore.jl (this repo)

I think the code for live loading should like like this code in the CROG.jl docs
Something like:

````@eval
using Download
using Markdown
Markdown.parse("""
```julia
$(read(Download.download("https://github.com/JuliaDiff/ChainRules.jl/blob/main/src/rulesets/LinearAlgebra/structured.jl#L210-L215"), String))
```
""")
````

One issue with this, as I think @mcabbott is pointing out is that as files change those line numbers might move