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

[MXNET-341] Added General Info to API Docs for Python and Gluon #10622

Merged
merged 1 commit into from
May 3, 2018

Conversation

thomelane
Copy link
Contributor

Description

With the aim to removing the main navigation link to Gluon, these changes are to provide extra context around Module vs Gluon and rehome the information.

Gluon link in main navigation is out of place, and only provides links to a basic about page and an external website (which is unintuitive from a user perspective). Suitable location would be API docs, and this can then be linked to from other pages such as FAQ.

Changes:

  1. Moved content from Gluon/About (http://mxnet.incubator.apache.org/gluon/index.html) to API/Python/Gluon (http://mxnet.incubator.apache.org/api/python/gluon/gluon.html)
  2. Added Module vs Gluon description to API/Python (http://mxnet.incubator.apache.org/api/python/index.html)

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • 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

Changes

  • Feature1, tests, (and when applicable, API doc)
  • Feature2, tests, (and when applicable, API doc)

Comments

  • If this change is a backward incompatible change, why must this change be made.
  • Interesting edge cases to note here

@thomelane thomelane requested a review from szha as a code owner April 20, 2018 00:39
@thomelane
Copy link
Contributor Author

@thomelane thomelane changed the title Added to API Docs for Python and Gluon [MXNET-341] Added General Info to API Docs for Python and Gluon Apr 20, 2018
@thomelane
Copy link
Contributor Author

@aaronmarkham what's the latest with changes of gluon homepage? good to merge this?

@aaronmarkham
Copy link
Contributor

GTG! Ship it!

@thomelane
Copy link
Contributor Author

@aaronmarkham @indhub can either of you merge this pr?

@aaronmarkham
Copy link
Contributor

I can't... maybe @szha or @eric-haibin-lin can.

@szha szha merged commit 4e68b3b into apache:master May 3, 2018
anirudh2290 pushed a commit to anirudh2290/mxnet that referenced this pull request May 7, 2018
jinhuang415 pushed a commit to jinhuang415/incubator-mxnet that referenced this pull request May 29, 2018
rahul003 pushed a commit to rahul003/mxnet that referenced this pull request Jun 4, 2018
zheng-da pushed a commit to zheng-da/incubator-mxnet that referenced this pull request Jun 28, 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.

3 participants