apache/mxnet

Documentation Bug: mxnet.test_utils.check_numeric_gradient has inconsistent document

Open

#19,003 建立於 2020年8月24日

在 GitHub 查看
 (5 留言) (0 反應) (0 負責人)C++ (20,808 star) (6,711 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.