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

[MXNET-386] API Docs Generation #10991

Merged
merged 22 commits into from
May 31, 2018
Merged

Conversation

lanking520
Copy link
Member

@lanking520 lanking520 commented May 17, 2018

Description

API docs generation (Write file). Create a file (an abstract class) that can be inherited to the API classes.
@nswamy @yzhliu

Checklist

Essentials

  • API file generator
  • Maven build integration
  • Current API integration
  • Operational and test checking
  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

@lanking520 lanking520 changed the title [MXNET-386][WIP] API Docs Generation [MXNET-386] API Docs Generation May 18, 2018
@lanking520
Copy link
Member Author

Add 1 line change in Sync with this PR: #11021

@nswamy nswamy merged commit 9854583 into apache:master May 31, 2018
@lanking520 lanking520 deleted the autocomplete-symbol branch June 1, 2018 05:02
zheng-da pushed a commit to zheng-da/incubator-mxnet that referenced this pull request Jun 28, 2018
XinYao1994 pushed a commit to XinYao1994/incubator-mxnet that referenced this pull request Aug 29, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants