FluxML/Zygote.jl

Add devdocs for important internal functions

Open

#1274 aperta il 31 lug 2022

Vedi su GitHub
 (2 commenti) (2 reazioni) (0 assegnatari)Julia (220 fork)batch import
good first issuehelp wantedup for grabs

Metriche repository

Star
 (1568 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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:

Guida contributor

Direzione di ricerca
Inizia comprendendo lo scopo di funzioni come `accum` e `accum param` dal commento collegato e dai file sorgente. Concentrati sulla documentazione di una funzione alla volta, iniziando con quelle più semplici come `accum` e `literal getproperty`. Usa il codice esistente in `src/compiler/` come riferimento per l'uso corretto e il comportamento. Assicurati che la documentazione spieghi cosa fa ciascuna funzione, i suoi argomenti e il suo ruolo nella pipeline di differenziazione automatica.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
3-5 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
basic Julia syntaxunderstanding of automatic differentiationreading codebase structure
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60