JuliaDiff / JuliaDiff/ChainRulesCore.jl
Make clear in docs you may need to `unthunk` the return from a pullback
Open
Nobody has claimed this yet.
documentation
good first issue
- Dominant language
- Julia
- Stars
- 267
- Forks
- 66
- PR merge metrics
- No merged PRs in 30d
Description
e.g. "things should be unthunked before being passed to pullbacks"
- We show this in the "using ChainRules directly" example [edit: not anymore]
- And it makes sense once you think about it
- But i'd never thought about it til it was pointed out (https://github.com/JuliaDiff/ChainRules.jl/pull/175#discussion_r416521562)... so maybe the docs should explicitly point it out (afaict they don't).
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 with the “using ChainRules directly” example linked in the issue and check the current documentation location, since the issue notes that example may have changed. Add an explicit note that pullback returns should be unthunked before being passed to pullbacks; done means the guidance is visible and accurate in the relevant docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100