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

[DOC] Fix numpy op doc #16504

Merged
merged 5 commits into from
Oct 18, 2019
Merged

[DOC] Fix numpy op doc #16504

merged 5 commits into from
Oct 18, 2019

Conversation

nuj7
Copy link
Contributor

@nuj7 nuj7 commented Oct 16, 2019

Description

docfix

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 https://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

@nuj7 nuj7 requested a review from szha as a code owner October 16, 2019 07:05
@nuj7
Copy link
Contributor Author

nuj7 commented Oct 16, 2019

@haojin2

Copy link
Contributor

@reminisce reminisce left a comment

Choose a reason for hiding this comment

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

With the latest master branch, do we have more ops whose doc is missing using this script?
https://gist.github.com/reminisce/2cb8d4fca5786dce41d4e22faaca6f95

python/mxnet/_numpy_op_doc.py Outdated Show resolved Hide resolved
python/mxnet/_numpy_op_doc.py Outdated Show resolved Hide resolved
python/mxnet/_numpy_op_doc.py Outdated Show resolved Hide resolved
python/mxnet/_numpy_op_doc.py Outdated Show resolved Hide resolved
python/mxnet/_numpy_op_doc.py Outdated Show resolved Hide resolved
@nuj7
Copy link
Contributor Author

nuj7 commented Oct 16, 2019

Some ops prefixed with _npx still miss doc.

@reminisce
Copy link
Contributor

Ok, we can ignore ops with npx prefix for now.

@reminisce reminisce merged commit 63fbfb1 into apache:master Oct 18, 2019
@nuj7 nuj7 deleted the docfix branch October 21, 2019 02:29
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants