apache / mxnet

Lightweight, Portable, Flexible Distributed/Mobile Deep Learning with Dynamic, Mutation-aware Dataflow Dep Scheduler; for Python, R, Julia, Scala, Go, Javascript and more
https://mxnet.apache.org
Apache License 2.0
20.77k stars 6.79k forks source link

Documentation bug: isinf has signature-description inconsistency #19000

Open DNXie opened 4 years ago

DNXie commented 4 years ago

Description

There is a signature-description inconsistency in the document of the following 3 APIs. The Parameter section stated that there should be a parameter input, but it is not accepted by the API.

image

Error Message

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

To Reproduce

(If you developed your own code, please provide a short script that reproduces the error. For existing examples, please provide link.)

import mxnet
mxnet.ndarray.contrib.isinf(input=mxnet.nd.array([1]))

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 commented 4 years ago

Looks like a typo that slipped through. The place that needs fix is at: https://github.com/apache/incubator-mxnet/blob/3c4ac19daa3e645d918692b864ea19640f7e0314/python/mxnet/ndarray/contrib.py#L531-L532

vijaya-lakshmi-venkatraman commented 2 years ago

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