mxnet
mxnet copied to clipboard
Documentation Bug: mxnet.test_utils.check_numeric_gradient has inconsistent document
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
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
@DNXie awesome job hunting down all these problems in the documentation! this will really help us improve the doc quality. Keep them coming!
On master branch, this was fixed in https://github.com/apache/incubator-mxnet/pull/18694/files#diff-75daced0edcfaf1e48f3dd43aebe4f01L982.
The problem still exists on v1.x, which needs to be corrected: in https://github.com/apache/incubator-mxnet/blob/dfefe879997a1208f1f01e58635c61e86eed1d6a/python/mxnet/test_utils.py#L1185-L1186
I will work on the v1.x issue and will update the documentation.
Hello, Is this still open?
It's been over a year since this issue was last tracked down. I'm guessing it's still open. Can anyone confirm? cc: @szha