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

The C++ API documentation available on website does not contain information about operators in op.h #13920

Closed
leleamol opened this issue Jan 17, 2019 · 3 comments

Comments

@leleamol
Copy link
Contributor

Note: Providing complete information in the most concise form is the best way to get help. This issue template serves as the checklist for essential information to most of the technical issues and bug reports. For non-technical issues and feature requests, feel free to present the information in what you believe is the best form.

For Q & A and discussion, please start a discussion thread at https://discuss.mxnet.io

Description

The https://mxnet.incubator.apache.org/versions/master/doxygen/files.html does not contain "op.h" that contains documentation for operators.

Environment info (Required)

Package used (Python/R/Scala/Julia):
Referred to the C++ documentation on mxnet.io website.

The op.h is generated when MXNet is built with USE_CPP_PACKAGE=1. We might not be setting this flag when generating the doxygen files for the website. @aaronmarkham

@piyushghai
Copy link
Contributor

@leleamol Thanks for reporting this issue. I'm labelling it so that other community members can help resolve it.

@mxnet-label-bot [Website, Doc]

@piyushghai
Copy link
Contributor

@mxnet-label-bot Add [Website, Doc]

@aaronmarkham
Copy link
Contributor

I'm seeing a lot of errors in v1.3.x.

Generating XML output for namespace mxnet::cpp
/home/ubuntu/incubator-mxnet/docs/build_version_doc/apache-mxnet/v1.3.x/cpp-package/include/mxnet-cpp/op.h:931: warning: Found unknown command `\breif'
/home/ubuntu/incubator-mxnet/docs/build_version_doc/apache-mxnet/v1.3.x/cpp-package/include/mxnet-cpp/op.h:1021: warning: Found unknown command `\breif'
/home/ubuntu/incubator-mxnet/docs/build_version_doc/apache-mxnet/v1.3.x/cpp-package/include/mxnet-cpp/op.h:1245: warning: Found unknown command `\breif'
/home/ubuntu/incubator-mxnet/docs/build_version_doc/apache-mxnet/v1.3.x/cpp-package/include/mxnet-cpp/op.h:1598: warning: Found unknown command `\breif'
... lots more... plus these...
/home/ubuntu/incubator-mxnet/docs/build_version_doc/apache-mxnet/v1.3.x/cpp-package/include/mxnet-cpp/op.h:841: warning: Found unknown command `\prime'
/home/ubuntu/incubator-mxnet/docs/build_version_doc/apache-mxnet/v1.3.x/cpp-package/include/mxnet-cpp/op.h:842: warning: Found unknown command `\end'
/home/ubuntu/incubator-mxnet/docs/build_version_doc/apache-mxnet/v1.3.x/cpp-package/include/mxnet-cpp/op.h:880: warning: Found unknown command `\breif'
/home/ubuntu/incubator-mxnet/docs/build_version_doc/apache-mxnet/v1.3.x/cpp-package/include/mxnet-cpp/op.h:889: warning: Found unknown command `\begin'
...
/home/ubuntu/incubator-mxnet/docs/build_version_doc/apache-mxnet/v1.3.x/cpp-package/include/mxnet-cpp/op.h:6962: warning: Found unknown command `\mathrm'

Were there functional changes to op.h, or would it be possible to push the recent docs fixes back to the older branches?

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

No branches or pull requests

4 participants