FluxML/Zygote.jl

Add devdocs for important internal functions

Open

#1.274 geöffnet am 31. Juli 2022

Auf GitHub ansehen
 (2 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Julia (220 Forks)batch import
good first issuehelp wantedup for grabs

Repository-Metriken

Stars
 (1.568 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Research-Richtung
Beginnen Sie damit, den Zweck von Funktionen wie `accum` und `accum param` aus dem verlinkten Kommentar und den Quelldateien zu verstehen. Konzentrieren Sie sich darauf, jeweils eine Funktion zu dokumentieren, beginnend mit einfacheren wie `accum` und `literal getproperty`. Verwenden Sie den vorhandenen Code in `src/compiler/` als Referenz für die korrekte Verwendung und das Verhalten. Stellen Sie sicher, dass die Dokumentation erklärt, was jede Funktion tut, ihre Argumente und ihre Rolle im automatischen Differenzierungspipeline.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
basic Julia syntaxunderstanding of automatic differentiationreading codebase structure
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60