JuliaDiff / JuliaDiff/ChainRulesCore.jl
Document how to define own ProjectTo's
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 267
- Forks
- 66
- PR merge metrics
- No merged PRs in 30d
Description
We do not have documentation on how to define a ProjectTo of your own.
Only on how to use them
I think NamedDims.jl has a good example:
https://github.com/invenia/NamedDims.jl/blob/10a2c7e2fa398527f2e261982c593029470ef5c2/src/chainrules.jl#L12-L21
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked NamedDims.jl example in src/chainrules.jl, then inspect the existing ChainRulesCore.jl documentation on using ProjectTo. Document how users can define their own ProjectTo, using the example as a reference; done means the new documentation explains the definition process rather than only usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100