apache/mxnet

Documentation Bug: mxnet.test_utils.check_numeric_gradient has inconsistent document

Open

#19.003 aperta il 24 ago 2020

Vedi su GitHub
 (5 commenti) (0 reazioni) (0 assegnatari)C++ (6711 fork)batch import
BugUnclear Error/Docgood first issuev1.x

Metriche repository

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

Descrizione

Description

This is a documentation bug. The parameter of API mxnet.test_utils.check_numeric_gradient is not consistent between signature and Parameter section. There is a parameter check_eps in the Parameter section, but it is not in the signature.

Link to document: https://mxnet.apache.org/versions/1.6/api/python/docs/api/mxnet/test_utils/index.html#mxnet.test_utils.check_numeric_gradient

image

Error Message

None

To Reproduce

None

Environment

We recommend using our script for collecting the diagnositc information. Run the following command and paste the outputs below:

curl --retry 10 -s https://raw.githubusercontent.com/dmlc/gluon-nlp/master/tools/diagnose.py | python

# paste outputs here

OS: ubuntu 18.04 Python: 3.7.6 pip: 20.0.2 numpy: 1.18.5 mxnet: 1.6.0

Guida contributor

Direzione di ricerca
Confrontare la firma dell'API e la sezione Parametri nella documentazione di mxnet.test utils.check numeric gradient. Aggiungere il parametro mancante 'check eps' alla firma della funzione o rimuoverlo dalla sezione Parametri per garantire la coerenza.
Tech stack
python
Dominio
machine learningai
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90