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

Wrong documentation in Optimization API #13429

Closed
anirudhacharya opened this issue Nov 27, 2018 · 5 comments · Fixed by #15185
Closed

Wrong documentation in Optimization API #13429

anirudhacharya opened this issue Nov 27, 2018 · 5 comments · Fixed by #15185
Assignees

Comments

@anirudhacharya
Copy link
Member

NDAbs should not show under Optimization API

screen shot 2018-11-27 at 3 38 05 pm

@aaronmarkham

@anirudhacharya
Copy link
Member Author

anirudhacharya commented Nov 27, 2018

@mxnet-label-bot add [Doc, Bug]

@aaronmarkham
Copy link
Contributor

Note: NDAbs also does not appear on the beta site at all... which is interesting...

The source is here:
https://github.com/apache/incubator-mxnet/blob/master/python/mxnet/optimizer/optimizer.py#L28
Or more likely:
https://github.com/apache/incubator-mxnet/blob/master/python/mxnet/optimizer/optimizer.py#L39

It does not appear in the autosummary and is not listed in the docs for a signature to be provided.
https://mxnet.incubator.apache.org/api/python/optimization/optimization.html?highlight=ndabs#the-mxnet-optimizer-package
In the API Reference section, automodule is generating all members of optimizer, so this must be where it is coming from.
Using this may fix it:

:exclude-members: NDAbs

But we also need to see why this doesn't appear on beta.

@anirudhacharya
Copy link
Member Author

@aaronmarkham are we tracking this on the beta site github repo?

@aaronmarkham
Copy link
Contributor

So where should NDabs be? I only see it mentioned twice in the code as some way to call abs. Is there a good reason for that? Why not just import it as abs so Sphinx doesn't try to include it... or set it up so Sphinx can document it?

@anirudhacharya
Copy link
Member Author

@aaronmarkham NDabs should be under NDArray API.

I only see it mentioned twice in the code as some way to call abs. Is there a good reason for that?

I am not sure of this.

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

Successfully merging a pull request may close this issue.

3 participants