Document `destructure` handling shared parameters differently to ComponentArrays.jl
- Dominant language
- Julia
- Stars
- 96
- Forks
- 30
- PR merge metrics
- No merged PRs in 30d
Description
This came up here:
https://discourse.julialang.org/t/on-the-future-of-flux-destructure-and-sciml-integration/104760/4
Maybe the idea that ComponentArrays.jl treats shared arrays as independent should be mentioned as an important difference, perhaps at the end of this section:
https://fluxml.ai/Optimisers.jl/dev/#Obtaining-a-flat-parameter-vector
Edit, example here:
https://github.com/FluxML/Flux.jl/issues/2405#issuecomment-2015447460
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the “Obtaining a flat parameter vector” section in the Optimisers.jl documentation, then read the linked Discourse discussion and Flux.jl example. Document how destructure handles shared arrays differently from ComponentArrays.jl, with the difference and its implications clearly stated in that section.
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