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

[numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians #15370

Merged

haojin2 merged 13 commits into apache:numpy from mikemwx:wenxu-doc-fix

Jul 3, 2019

Contributor

mikemwx commented Jun 26, 2019 •

edited

Description

Add the docs for the above mentioned operators.

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

three unary operators are registered to npi namespace, and wrapped in corresponding files
mean is registered into npi namespace, and wrapped to have same signature as in numpy
website building looks normal
unittests for operators still pass

Comments

Thank @reminisce , @haojin2 for reviewing

mikemwx requested a review from szha as a code owner

June 26, 2019 08:08

reminisce reviewed

View reviewed changes

Contributor

reminisce left a comment

Some comments on a few operators. Please make similar changes on other operators if necessary.

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/ndarray/numpy/_op.py Outdated Show resolved Hide resolved

python/mxnet/_numpy_op_doc.py Show resolved Hide resolved

python/mxnet/_numpy_op_doc.py Outdated Show resolved Hide resolved

python/mxnet/ndarray/numpy/_op.py Outdated Show resolved Hide resolved

python/mxnet/ndarray/numpy/_op.py Show resolved Hide resolved

haojin2 added the Numpy label

haojin2 reviewed

View reviewed changes

python/mxnet/_numpy_op_doc.py Outdated Show resolved Hide resolved

mikemwx force-pushed the wenxu-doc-fix branch from 7bd42e2 to 79c9a82 Compare

June 28, 2019 06:18

gyshi reviewed

View reviewed changes

python/mxnet/ndarray/numpy/_op.py Show resolved Hide resolved

haojin2 reviewed

View reviewed changes

python/mxnet/numpy/multiarray.py Outdated Show resolved Hide resolved

haojin2 reviewed

View reviewed changes

python/mxnet/numpy/multiarray.py Show resolved Hide resolved

haojin2 reviewed

View reviewed changes

python/mxnet/symbol/numpy/_symbol.py Show resolved Hide resolved

haojin2 reviewed

View reviewed changes

python/mxnet/ndarray/numpy/_op.py Show resolved Hide resolved

haojin2 reviewed

View reviewed changes

Contributor

haojin2 left a comment

Please address the comments.

tingying2020 reviewed

View reviewed changes

python/mxnet/_numpy_op_doc.py Show resolved Hide resolved

python/mxnet/ndarray/numpy/_op.py Show resolved Hide resolved

python/mxnet/symbol/numpy/_symbol.py Show resolved Hide resolved

haojin2 added the Doc label

Mike Mao added 12 commits

July 3, 2019 05:19


          Doc fix for split, stack, transpose, mean, rint, radians, log2.

f79e6b0


          Minor syntax fix

cf7cd3b


          Add some disable=line-too-long to pass pylint test

5830eb4


          Add Notes following the guide of example PR by Mu Li

688e266


          Minor syntax fix

aed44dd


          Fix a non-ascii character

1d7b744


          Fix issues mentioned in review by @reminisce

4fa139f


          Register mean into npi namespace and wrap it to have same sigatrue as

5f3bd5a

standard numpy


          Add mean to __all__ list

09e1f4d


          Note the imcompatibility of broacasting to output

89fca68


          Specify out must have the same type

185781d


          Minor syntax fix

f995ccc

mikemwx force-pushed the wenxu-doc-fix branch 2 times, most recently from 6144a73 to 5895519 Compare

July 3, 2019 05:55


          Clearify the out in symbol is only a dummy variable

f242715

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

mikemwx force-pushed the wenxu-doc-fix branch from 46687f2 to f242715 Compare

July 3, 2019 08:10

haojin2 approved these changes

View reviewed changes

Contributor

haojin2 left a comment

LGTM, will merge soon

haojin2 merged commit 44e5b25 into apache:numpy

gyshi pushed a commit to gyshi/incubator-mxnet that referenced this pull request


          [numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians (

361c73e

apache#15370)

* Doc fix for split, stack, transpose, mean, rint, radians, log2.

* Minor syntax fix

* Add some disable=line-too-long to pass pylint test

* Add Notes following the guide of example PR by Mu Li

* Minor syntax fix

* Fix a non-ascii character

* Fix issues mentioned in review by @reminisce

* Register mean into npi namespace and wrap it to have same sigatrue as
standard numpy

* Add mean to __all__ list

* Note the imcompatibility of broacasting to output

* Specify out must have the same type

* Minor syntax fix

* Clearify the `out` in symbol is only a dummy variable

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

gyshi pushed a commit to gyshi/incubator-mxnet that referenced this pull request


          [numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians (

86ebee7

apache#15370)

* Doc fix for split, stack, transpose, mean, rint, radians, log2.

* Minor syntax fix

* Add some disable=line-too-long to pass pylint test

* Add Notes following the guide of example PR by Mu Li

* Minor syntax fix

* Fix a non-ascii character

* Fix issues mentioned in review by @reminisce

* Register mean into npi namespace and wrap it to have same sigatrue as
standard numpy

* Add mean to __all__ list

* Note the imcompatibility of broacasting to output

* Specify out must have the same type

* Minor syntax fix

* Clearify the `out` in symbol is only a dummy variable

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

gyshi pushed a commit to gyshi/incubator-mxnet that referenced this pull request


          [numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians (

8e96b10

apache#15370)

* Doc fix for split, stack, transpose, mean, rint, radians, log2.

* Minor syntax fix

* Add some disable=line-too-long to pass pylint test

* Add Notes following the guide of example PR by Mu Li

* Minor syntax fix

* Fix a non-ascii character

* Fix issues mentioned in review by @reminisce

* Register mean into npi namespace and wrap it to have same sigatrue as
standard numpy

* Add mean to __all__ list

* Note the imcompatibility of broacasting to output

* Specify out must have the same type

* Minor syntax fix

* Clearify the `out` in symbol is only a dummy variable

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

gyshi pushed a commit to gyshi/incubator-mxnet that referenced this pull request


          [numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians (

8c78e6f

apache#15370)

* Doc fix for split, stack, transpose, mean, rint, radians, log2.

* Minor syntax fix

* Add some disable=line-too-long to pass pylint test

* Add Notes following the guide of example PR by Mu Li

* Minor syntax fix

* Fix a non-ascii character

* Fix issues mentioned in review by @reminisce

* Register mean into npi namespace and wrap it to have same sigatrue as
standard numpy

* Add mean to __all__ list

* Note the imcompatibility of broacasting to output

* Specify out must have the same type

* Minor syntax fix

* Clearify the `out` in symbol is only a dummy variable

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

gyshi pushed a commit to gyshi/incubator-mxnet that referenced this pull request


          [numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians (

0b33429

apache#15370)

* Doc fix for split, stack, transpose, mean, rint, radians, log2.

* Minor syntax fix

* Add some disable=line-too-long to pass pylint test

* Add Notes following the guide of example PR by Mu Li

* Minor syntax fix

* Fix a non-ascii character

* Fix issues mentioned in review by @reminisce

* Register mean into npi namespace and wrap it to have same sigatrue as
standard numpy

* Add mean to __all__ list

* Note the imcompatibility of broacasting to output

* Specify out must have the same type

* Minor syntax fix

* Clearify the `out` in symbol is only a dummy variable

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

reminisce pushed a commit to reminisce/mxnet that referenced this pull request


          [numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians (

3410cae

apache#15370)

* Doc fix for split, stack, transpose, mean, rint, radians, log2.

* Minor syntax fix

* Add some disable=line-too-long to pass pylint test

* Add Notes following the guide of example PR by Mu Li

* Minor syntax fix

* Fix a non-ascii character

* Fix issues mentioned in review by @reminisce

* Register mean into npi namespace and wrap it to have same sigatrue as
standard numpy

* Add mean to __all__ list

* Note the imcompatibility of broacasting to output

* Specify out must have the same type

* Minor syntax fix

* Clearify the `out` in symbol is only a dummy variable

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

haojin2 pushed a commit that referenced this pull request


          [numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians (

30b036e

#15370)

* Doc fix for split, stack, transpose, mean, rint, radians, log2.

* Minor syntax fix

* Add some disable=line-too-long to pass pylint test

* Add Notes following the guide of example PR by Mu Li

* Minor syntax fix

* Fix a non-ascii character

* Fix issues mentioned in review by @reminisce

* Register mean into npi namespace and wrap it to have same sigatrue as
standard numpy

* Add mean to __all__ list

* Note the imcompatibility of broacasting to output

* Specify out must have the same type

* Minor syntax fix

* Clearify the `out` in symbol is only a dummy variable

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

haojin2 pushed a commit that referenced this pull request


          [numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians (

4f1fca8

#15370)

* Doc fix for split, stack, transpose, mean, rint, radians, log2.

* Minor syntax fix

* Add some disable=line-too-long to pass pylint test

* Add Notes following the guide of example PR by Mu Li

* Minor syntax fix

* Fix a non-ascii character

* Fix issues mentioned in review by @reminisce

* Register mean into npi namespace and wrap it to have same sigatrue as
standard numpy

* Add mean to __all__ list

* Note the imcompatibility of broacasting to output

* Specify out must have the same type

* Minor syntax fix

* Clearify the `out` in symbol is only a dummy variable

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

haojin2 pushed a commit to haojin2/incubator-mxnet that referenced this pull request


          [numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians (

c2ac31e

apache#15370)

* Doc fix for split, stack, transpose, mean, rint, radians, log2.

* Minor syntax fix

* Add some disable=line-too-long to pass pylint test

* Add Notes following the guide of example PR by Mu Li

* Minor syntax fix

* Fix a non-ascii character

* Fix issues mentioned in review by @reminisce

* Register mean into npi namespace and wrap it to have same sigatrue as
standard numpy

* Add mean to __all__ list

* Note the imcompatibility of broacasting to output

* Specify out must have the same type

* Minor syntax fix

* Clearify the `out` in symbol is only a dummy variable

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

haojin2 pushed a commit that referenced this pull request


          [numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians (

60f7523

#15370)

* Doc fix for split, stack, transpose, mean, rint, radians, log2.

* Minor syntax fix

* Add some disable=line-too-long to pass pylint test

* Add Notes following the guide of example PR by Mu Li

* Minor syntax fix

* Fix a non-ascii character

* Fix issues mentioned in review by @reminisce

* Register mean into npi namespace and wrap it to have same sigatrue as
standard numpy

* Add mean to __all__ list

* Note the imcompatibility of broacasting to output

* Specify out must have the same type

* Minor syntax fix

* Clearify the `out` in symbol is only a dummy variable

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

haojin2 pushed a commit that referenced this pull request


          [numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians (

d7256c4

#15370)

* Doc fix for split, stack, transpose, mean, rint, radians, log2.

* Minor syntax fix

* Add some disable=line-too-long to pass pylint test

* Add Notes following the guide of example PR by Mu Li

* Minor syntax fix

* Fix a non-ascii character

* Fix issues mentioned in review by @reminisce

* Register mean into npi namespace and wrap it to have same sigatrue as
standard numpy

* Add mean to __all__ list

* Note the imcompatibility of broacasting to output

* Specify out must have the same type

* Minor syntax fix

* Clearify the `out` in symbol is only a dummy variable

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

haojin2 pushed a commit that referenced this pull request


          [numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians (

ae00c51

#15370)

* Doc fix for split, stack, transpose, mean, rint, radians, log2.

* Minor syntax fix

* Add some disable=line-too-long to pass pylint test

* Add Notes following the guide of example PR by Mu Li

* Minor syntax fix

* Fix a non-ascii character

* Fix issues mentioned in review by @reminisce

* Register mean into npi namespace and wrap it to have same sigatrue as
standard numpy

* Add mean to __all__ list

* Note the imcompatibility of broacasting to output

* Specify out must have the same type

* Minor syntax fix

* Clearify the `out` in symbol is only a dummy variable

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

reminisce pushed a commit to reminisce/mxnet that referenced this pull request


          [numpy][doc-fix] mean, transpose, stack, split, log2, rint and radians (

c013ce3

apache#15370)

* Doc fix for split, stack, transpose, mean, rint, radians, log2.

* Minor syntax fix

* Add some disable=line-too-long to pass pylint test

* Add Notes following the guide of example PR by Mu Li

* Minor syntax fix

* Fix a non-ascii character

* Fix issues mentioned in review by @reminisce

* Register mean into npi namespace and wrap it to have same sigatrue as
standard numpy

* Add mean to __all__ list

* Note the imcompatibility of broacasting to output

* Specify out must have the same type

* Minor syntax fix

* Clearify the `out` in symbol is only a dummy variable

Fix the mess due to pull rebase

Correct the wrong return statement in multiarray

Again, syntax fix

Syntax fix one more time

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

Reviewers

reminisce reminisce left review comments

tingying2020 tingying2020 left review comments

gyshi gyshi left review comments

haojin2 haojin2 approved these changes

szha Awaiting requested review from szha