apache/mxnet

Documentation Bug: mxnet.test_utils.check_numeric_gradient has inconsistent document

Open

#19,003 opened on 2020年8月24日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)C++ (20,808 stars) (6,711 forks)batch import
BugUnclear Error/Docgood first issuev1.x

説明

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

コントリビューターガイド

技術スタック
python
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Pythonbasic understanding of mxnet
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85
調査方針
The issue is a mismatch between the signature and parameter documentation of `mxnet.test utils.check numeric gradient`. The parameter `check eps` is documented but missing from the signature. To fix, locate the source file for the documentation (likely in the Python docstring of the function in the mxnet repository, e.g., `python/mxnet/test utils.py`) and add `check eps` to the function signature or remove it from the parameter list. Confirm consistency with the actual API implementation.