Optimizer classes lack clear documentation of expected Tensor interface
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 1/5
- Tempo stimato
- Meno di un'ora
- Idoneità per principianti
- 88/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- python
- Ambito
- ai, documentation, machine-learning
Direzione di ricerca
Apri leanpass/optim.py e aggiungi docstring di classe/metodo per SGD e Adam. Specifica che params deve esporre .data e .grad, che i gradienti si accumulano in param.grad e se weight_decay è L2 o disaccoppiato. Fatto quando queste interfacce e semantiche sono esplicite nelle docstring.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
File: leanpass/optim.py
Both SGD and Adam in leanpass/optim.py assume the passed params are objects with .data and .grad attributes, but this is not documented. Users may pass raw NumPy arrays or other objects and encounter obscure attribute errors. Add docstrings that explicitly state the required interface, mention that gradients are accumulated in param.grad, and clarify the semantics of weight_decay (L2 vs decoupled).
Filed automatically by ai-issue-scan.
- Lingua principale
- Python
- Stelle
- 16
- Fork
- 1
- Merge medio
- 2g 8h
- PR unite (30g)
- 5
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di Terminay/leanpass
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
-
performance
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
Tutte le issue di Terminay/leanpass
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
zach-blumenfeld/aip#13 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 80/100
nathanmarlor/foxess_modbus#1287 ·
I maintainer di solito rispondono entro 4 giorni
-
bug good first issue help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
OpenLakeForge/openlakeforge#498 ·
I maintainer di solito rispondono entro 1 giorno
-
good first issue hacktoberfest help wanted python
Difficoltà 2/5 1-3 ore Idoneità per principianti 73/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 69/100
pollen-robotics/reachy_mini#1493 ·
I maintainer di solito rispondono entro 1 giorno