cannot find documentation for some python api

[zchrissirhcz]

Description

I read MXNet's module API tutorial and confused to some Python API's usage. On the official python api url I can find many documentations but some are not find.

Environment info (Required)

the environment is not required. I search the python API on your official website.

Build info (Required if built from source)

The build info is not required. I search the python API on your official website.

Error Message:

There is not error message since no code run.

Steps to reproduce

1. Go to https://mxnet.incubator.apache.org/tutorials/basic/module.html
2. Find some functions that don't know their concrete argument meaning
3. For example, mx.sym.Convolution can be found by typing mxnet.symbol.Convolution; However, mx.test_utils can never be found.

Hoping the documentation can be complete, thanks.

[frankfliu]

Hi @zchrissirhcz thanks for the question, @sandeep-krishnamurthy requesting this be labeled under Question

[frankfliu]

For questions, please submit on MXNet discussion forum (https://discuss.mxnet.io), where it will get a wider audience and allow other to learn as well.
@sandeep-krishnamurthy to close this issue now in favor of the discussion forum issue you will file, please feel free to re-open if closed in error.
Thanks!

[sandeep-krishnamurthy]

@aaronmarkham - Can you please help?

[ThomasDelteil]

@zchrissirhcz a few modules are indeed not in the API documentation as top-level packages as they should, for example the mxnet.viz and mxnet.test_utils. This is something we need to be fixed IMO, @aaronmarkham ?
@indhub can you remove the question tag and add a [Bug]/[FeatureRequest] tag?
We should also try to handle better the shorthand versions of the modules in our API docs: e.g sym->symbol viz->vizualisation nd->ndarray

[aaronmarkham]

I'm not sure why this is the case. My guess is that it is probably doxygen config. I can tackle it first thing next week. Can you assign the issue to me?

[sojiadeshina]

hi @aaronmarkham, what's the status of this? any updates?

[aaronmarkham]

Hi @sad- I looked at it last week and didn't find the part of the configuration that would adjust this.
I found a bunch of other problems in the docs build pipeline and cleared those up first: #11916
I'm going to continue the investigation and cleanup though. I'm hoping to get this figured out ASAP.