FluxML/Zygote.jl

Add devdocs for important internal functions

Open

#1,274 opened on Jul 31, 2022

View on GitHub
 (2 comments) (2 reactions) (0 assignees)Julia (1,568 stars) (220 forks)batch import
good first issuehelp wantedup for grabs

Description

These may be as simple as a couple lines of comments, but as noted in https://github.com/FluxML/Zygote.jl/issues/1243#issuecomment-1200400917 they would be good to have:

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Julia syntaxunderstanding of automatic differentiationreading codebase structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Start by understanding the purpose of functions like `accum` and `accum param` from the linked comment and source files. Focus on documenting one function at a time, beginning with simpler ones like `accum` and `literal getproperty`. Use the existing code in `src/compiler/` as reference for correct usage and behavior. Ensure the documentation explains what each function does, its arguments, and its role in the automatic differentiation pipeline.