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

Documentation Bug: Format issue in mxnet.util.use_np document #18988

Closed
DNXie opened this issue Aug 23, 2020 · 7 comments
Closed

Documentation Bug: Format issue in mxnet.util.use_np document #18988

DNXie opened this issue Aug 23, 2020 · 7 comments
Labels
Bug good first issue Unclear Error/Doc

Comments

@DNXie
Copy link

DNXie commented Aug 23, 2020 •
edited

Description

This is a documentation bug. There is a format issue in mxnet.util.use_np document Parameter section. and NumPy-array semantics. is not a parameter.

image

Error Message

None

To Reproduce

Link to the buggy document: https://mxnet.apache.org/versions/1.6/api/python/docs/api/mxnet/util/index.html#mxnet.util.use_np

Steps to reproduce

(Paste the commands you ran that produced the error.)

What have you tried to solve it?

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 25, 2020

The problem is the wrong doc string and indentation here:
https://github.com/apache/incubator-mxnet/blob/3c4ac19daa3e645d918692b864ea19640f7e0314/python/mxnet/util.py#L541-L542

A proper documentation format looks like this:
https://github.com/apache/incubator-mxnet/blob/3c4ac19daa3e645d918692b864ea19640f7e0314/python/mxnet/util.py#L773-L776

ekdnam added a commit to ekdnam/incubator-mxnet that referenced this issue Sep 1, 2020
@ekdnam
fix indentation
0efe217 
issue: apache#18988
@ekdnam ekdnam mentioned this issue Sep 1, 2020
Merged
6 tasks
szha added a commit that referenced this issue Sep 2, 2020
@ekdnam @szha
Resolve minor docs issues (#19062)
ddfd9e4 
* 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
Copy link

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

@DNXie
Copy link
Author

DNXie commented Apr 13, 2022 •
edited

@vijaya-lakshmi-venkatraman I don't think the issue is fixed. At least the document has not been updated.

@vijaya-lakshmi-venkatraman
Copy link

@DNXie I am looking at the master version and dont see the second bullet point anymore however the description seems to be incomplete

Am I looking at the right version & the right place?

@DNXie
Copy link
Author

DNXie commented Sep 15, 2022

@vijaya-lakshmi-venkatraman
Hi, it is fixed in the the master version. But in the 1.6 document, it still exists. Should we consider this as fixed?

@vijaya-lakshmi-venkatraman
Copy link

@DNXie Isn't master the current live version? Do you prefer to have it fixed in 1.6 branch as well?

@DNXie
Copy link
Author

DNXie commented Nov 7, 2022

@vijaya-lakshmi-venkatraman It looks good now. I will close the issue.

@DNXie DNXie closed this as completed Nov 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Bug good first issue Unclear Error/Doc
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@szha @DNXie @vijaya-lakshmi-venkatraman