Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Documentaion bug: mxnet.test_utils.assert_almost_equal_with_err doesn't accept threshold as an input #18999

Open
DNXie opened this issue Aug 24, 2020 · 2 comments

Comments

@DNXie
Copy link

DNXie commented Aug 24, 2020

Description

This is a documentation bug. The Parameter section of the documentation of mxnet.test_utils.assert_almost_equal_with_err stated the parameter threshold. But it is not in the siganture and not accepted by the API, and passing it throws exception.

image

Link to the doc: https://mxnet.apache.org/versions/1.6/api/python/docs/api/mxnet/test_utils/index.html#mxnet.test_utils.assert_almost_equal_with_err

Error Message

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: assert_almost_equal_with_err() got an unexpected keyword argument 'threshold'

To Reproduce

import mxnet
import numpy as np
a = np.ndarray(shape=(2,2), dtype=float)
b = np.ndarray(shape=(2,2), dtype=float)
mxnet.test_utils.assert_almost_equal_with_err(a,b,threshold=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

@szha
Copy link
Member

szha commented Aug 24, 2020

ekdnam added a commit to ekdnam/incubator-mxnet that referenced this issue Sep 1, 2020
threshold is not a parameter. issue: apache#18999
@ekdnam ekdnam mentioned this issue Sep 1, 2020
6 tasks
szha added a commit that referenced this issue Sep 2, 2020
* set_lower_bound(1) so that stride is not zero

in issue: #18942, an error was occurring where strides became zero. to solve the issue, the lower bounds of stride1 and stride2 have been set to 1.

* small typo

'use_unifrom' changed to 'use_uniform'

* add tests to check lower bound

checking that stride1 and stride2 are be greater than zero

* Update test_operator.py

* documentation error

name is not a parameter. issue: #19001

* data is the parameter, not input

solves issue: #19000

* fix docs

threshold is not a parameter. issue: #18999

* fix docs

context 'ctx' is not a parameter. issue: #18990

* fix indentation

issue: #18988

Co-authored-by: Sheng Zha <szha@users.noreply.github.com>
@vijaya-lakshmi-venkatraman

Hello,
I see a PR merged for this issue.
Is this still open?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants