apache/mxnet

Documentation bug: isinf has signature-description inconsistency

Open

#19.000 geöffnet am 24. Aug. 2020

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (20.808 Stars) (6.711 Forks)batch import
BugUnclear Error/Docgood first issue

Beschreibung

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

Contributor Guide

Tech Stack
python
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90
Research-Richtung
The issue is a documentation inconsistency for the functions isinf, isfinite, and isnan in mxnet.ndarray.contrib. The documentation states that there is a parameter `input`, but the actual implementation does not accept it. To fix, locate the documentation source files (likely in the docs/ directory as .rst files) and correct the parameter list. Confirmation that the functions accept the array directly (e.g., mxnet.nd.array([1])) without the `input` keyword should be verified by testing.