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

gluon docfix #13631

Merged
merged 1 commit into from
Dec 29, 2018
Merged

gluon docfix #13631

merged 1 commit into from
Dec 29, 2018

Conversation

vdantu
Copy link
Contributor

@vdantu vdantu commented Dec 13, 2018

Description

(Brief description on what this PR is about)
Fixes #13263

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

@vdantu vdantu requested a review from szha as a code owner December 13, 2018 01:50
@vdantu
Copy link
Contributor Author

vdantu commented Dec 13, 2018

@yzhliu : Please let me know if you find issues with this doc string.

@roywei
Copy link
Member

roywei commented Dec 14, 2018

@mxnet-label-bot add[Doc, pr-awaiting-review]

@marcoabreu marcoabreu added Doc pr-awaiting-review PR is waiting for code review labels Dec 14, 2018
Copy link
Contributor

@ChaiBapchya ChaiBapchya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@sandeep-krishnamurthy sandeep-krishnamurthy merged commit 9fbd7dd into apache:master Dec 29, 2018
rondogency pushed a commit to rondogency/incubator-mxnet that referenced this pull request Jan 9, 2019
haohuanw pushed a commit to haohuanw/incubator-mxnet that referenced this pull request Jun 23, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Doc pr-awaiting-review PR is waiting for code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc]Doc's little error
6 participants