This repository was archived by the owner on Nov 17, 2023. It is now read-only.
edit ndarray API docs #5806
Merged
edit ndarray API docs #5806
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nswamy
suggested changes
Apr 13, 2017
| @@ -81,7 +69,7 @@ MXNET_OPERATOR_REGISTER_REDUCE_BACKWARD(_backward_nansum) | |||
| .set_attr<FCompute>("FCompute<cpu>", ReduceAxesBackwardUseInOut<cpu, mshadow_op::nansum_grad>); | |||
|
|
|||
| MXNET_OPERATOR_REGISTER_REDUCE(nanprod) | |||
| .describe(R"code(Compute the product of array elements over given axes with ``NaN`` ignored | |||
| .describe(R"code(Compute the product of array elements over given axes treating Not a Numbers ``NaNs`` as zero. | |||
|
|
|||
| Refer to ``prod`` for more details. | |||
There was a problem hiding this comment.
you can remove these, since the parameters now have good description.
There was a problem hiding this comment.
what do you mean?
| "scalar array with shape `(1,)`. If axis is int, " | ||
| "a reduction is performed on a particular axis. " | ||
| "If axis is a tuple of ints, a reduction is performed " | ||
| "on all the axes specified in the tuple."); |
There was a problem hiding this comment.
Can you find a way to make these different options appear on a new line.
There was a problem hiding this comment.
There is no easy way to spilt a new line.
There was a problem hiding this comment.
you can put \n in the string.
| @@ -34,11 +39,12 @@ struct ReduceAxisParam : public dmlc::Parameter<ReduceAxisParam> { | |||
| bool keepdims; | |||
| DMLC_DECLARE_PARAMETER(ReduceAxisParam) { | |||
| DMLC_DECLARE_FIELD(axis).set_default(dmlc::optional<int>()) | |||
| .describe("int or None. The axis to perform the reduction. " | |||
| .describe("The axis along which to perform the reduction. " | |||
| "Negative values means indexing from right to left. " | |||
There was a problem hiding this comment.
Do you need to mention this ? i do not see this mentioned for other parameters that have this behavior
There was a problem hiding this comment.
what do you mean?
added 2 commits
April 14, 2017 10:26
zackchase
reviewed
Apr 14, 2017
There was a problem hiding this comment.
Please review the comments. Some things to watch out for - don't make single nouns (or noun phrases) into sentences. For example "Weight decay." should not be a sentence.
Also be careful with types:
before "shape : int or tuple of int"
you changed to: "shape : int or sequence of ints"
This is wrong. The type specification is a formal type specification and must be reverted. Please review the numpy HOW_TO_DOCUMENT for reference on how to deal with the formal type specification.
python/mxnet/ndarray.py
Outdated
| @@ -953,7 +953,7 @@ def ones(shape, ctx=None, dtype=mx_real_t): | |||
|
|
|||
| Parameters | |||
| ---------- | |||
| shape : int or tuple of int | |||
| shape : int or sequence of ints | |||
There was a problem hiding this comment.
I believe this is not correct. "tuple of int" is a formal type specification. The word "sequence" is not the correct Python type and should be "int" not "ints".
There was a problem hiding this comment.
Actually I took the numpy.ones as reference.
https://docs.scipy.org/doc/numpy/reference/generated/numpy.ones.html
The sequence should represents both list, tuple.
| @@ -27,18 +27,20 @@ struct SGDParam : public dmlc::Parameter<SGDParam> { | |||
| float clip_gradient; | |||
| DMLC_DECLARE_PARAMETER(SGDParam) { | |||
| DMLC_DECLARE_FIELD(lr) | |||
| .describe("learning_rate"); | |||
| .describe("Learning rate"); | |||
There was a problem hiding this comment.
is the the correct use of .describe() ? Should it take the formal variable name or a common language string?
There was a problem hiding this comment.
they use .describe to document other parameters.
src/operator/optimizer_op-inl.h
Outdated
| DMLC_DECLARE_FIELD(wd) | ||
| .set_default(0.0f) | ||
| .describe("weight decay"); | ||
| .describe("Weight decay. " | ||
| "It is a regularization term that penalzies big weights, " |
There was a problem hiding this comment.
Why is "Weight decay" its own sentence? Also "weight decay" is not "a term". Weight decay is the name of the technique. Also it is not "proportional" (which mean linear) in the magnitude of the weight. It scales with the square of the weight.
Change to:
"Weight decay augments the objective function with a regularization term that penalizes large weights. The penalty scales with the square of the magnitude of each weight."
There was a problem hiding this comment.
Good suggestion! Thanks!
src/operator/optimizer_op-inl.h
Outdated
| DMLC_DECLARE_FIELD(rescale_grad) | ||
| .set_default(1.0f) | ||
| .describe("rescale gradient as grad = rescale_grad*grad."); | ||
| .describe("Rescale gradient. grad = rescale_grad*grad."); |
There was a problem hiding this comment.
Cannot have an equation as a sentence. Fix to:
- .describe("Rescale gradient to grad = rescale_grad*grad.");
src/operator/optimizer_op-inl.h
Outdated
| .describe("weight decay"); | ||
| .describe("Weight decay. " | ||
| "It is a regularization term that penalzies big weights, " | ||
| "which causes weight to decay in proportion to its size."); |
There was a problem hiding this comment.
Change to:
"Weight decay augments the objective function with a regularization term that penalizes large weights. The penalty scales with the square of the magnitude of each weight."
src/operator/optimizer_op-inl.h
Outdated
| DMLC_DECLARE_FIELD(epsilon).set_default(1e-8f) | ||
| .describe("A small constant for numerical stability."); | ||
| DMLC_DECLARE_FIELD(wd).set_default(0.0f) | ||
| .describe("Weight decay. " |
There was a problem hiding this comment.
Same as above:
Change to:
"Weight decay augments the objective function with a regularization term that penalizes large weights. The penalty scales with the square of the magnitude of each weight."
src/operator/optimizer_op-inl.h
Outdated
| DMLC_DECLARE_FIELD(epsilon).set_default(1e-8f) | ||
| .describe("A small constant for numerical stability."); | ||
| DMLC_DECLARE_FIELD(wd).set_default(0.0f) | ||
| .describe("Weight decay. " |
There was a problem hiding this comment.
Change to:
"Weight decay augments the objective function with a regularization term that penalizes large weights. The penalty scales with the square of the magnitude of each weight."
src/operator/optimizer_op.cc
Outdated
| .describe("Updater function for sgd optimizer") | ||
| .describe(R"code(Momentum update function for Stochastic Gradient Descent (SDG) optimizer. | ||
|
|
||
| Momentum update has better converge rates on neural networks. Mathematically it looks |
There was a problem hiding this comment.
Change "converge rates" to "convergence rates"
| .describe(R"code(Compute the sum of array elements over given axes with ``NaN`` ignored | ||
|
|
||
| Refer to ``sum`` for more details. | ||
| .describe(R"code(Compute the sum of array elements over given axes treating Not a Numbers ``NaNs`` as zeros. |
There was a problem hiding this comment.
the "s" cannot be inside the double backticks. Just put "treating each NaN as a zero."
| .describe(R"code(Compute the product of array elements over given axes with ``NaN`` ignored | ||
|
|
||
| Refer to ``prod`` for more details. | ||
| .describe(R"code(Compute the product of array elements over given axes treating Not a Numbers ``NaNs`` as ones. |
added 2 commits
April 14, 2017 15:05
|
Numpy documentation is inconsistent. Please refer to
https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
If sequence is acceptable as a general word for {list, tuple} then I have
no problem. But should say "sequence of int" not "sequence of ints" to be
consistent with the *general* numpy style.
…On Fri, Apr 14, 2017 at 1:25 PM, Jiajie (George) Chen < ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In python/mxnet/ndarray.py
<#5806 (comment)>:
> @@ -953,7 +953,7 @@ def ones(shape, ctx=None, dtype=mx_real_t):
Parameters
----------
- shape : int or tuple of int
+ shape : int or sequence of ints
Actually I took the numpy.ones as reference.
https://docs.scipy.org/doc/numpy/reference/generated/numpy.ones.html
The sequence should represents both list, tuple.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#5806 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/ACR4zk4EaFp2aosjZtB01FAA_dtC2qwtks5rv9ZMgaJpZM4M8Ak5>
.
|
nswamy
suggested changes
Apr 17, 2017
src/operator/tensor/matrix_op.cc
Outdated
| elements:: | ||
|
|
||
| x = [[ 1, 2], | ||
| [ 3, 4]] | ||
|
|
||
| repeat(x, repeats=2) = [ 1., 1., 2., 2., 3., 3., 4., 4.] | ||
|
|
||
| We can also choose a particular axis to repeat, in which a negative axis is | ||
| interpreted counting from the backward:: | ||
| The parameter axis specifies the axis along which to perform repeat:: |
There was a problem hiding this comment.
The parameter axis specifies the axis along which to repeat::
| [ 3., 4.], | ||
| [ 3., 4.]] | ||
|
|
||
| repeat(x, repeats=2, axis=-1) = [[ 1., 1., 2., 2.], |
There was a problem hiding this comment.
you can say that the axis parameter supports negative indexing and remove this example
There was a problem hiding this comment.
I have said that in the parameter axis explanation.
There was a problem hiding this comment.
I think having a example for the negative indexing case might help understanding. what do you think? does it look redundant?
piiswrong
reviewed
Apr 18, 2017
| "Negative values means indexing from right to left. " | ||
| "If is `None`, a global reduction will be performed."); | ||
| "``Requires axis to be set as int, because global reduction " | ||
| "is not supported yet.``"); |
There was a problem hiding this comment.
This is used for multiple ops. Are all of them not supporting None?
There was a problem hiding this comment.
I think this is for argmax,argmin and pick operator and these 3 don't support None yet.
There was a problem hiding this comment.
yes, it is only for argmax, argmin, and pick. These three does not support global reduction.
|
what's the status on this @piiswrong ? |
|
@zackchase waiting for approval. If you think this is ready to be merged I'll merge it |
madjam
approved these changes
Apr 24, 2017
cjolivier01
pushed a commit
to cjolivier01/mxnet
that referenced
this pull request
Apr 26, 2017
* edit docs in broadcast_reduce_op * edit docs in broadcast_reduce_op * minor change * lint fix * fix * mx.nd.ones * mx.nd.repeat * mx.nd.reverse * add example in repeat * optimizer update * fix nanprod * fix optimizer_op api doc * fix reduce_op api doc * fix nd.ones api doc * mx.nd.repeat doc change * Update broadcast_reduce_op.h
piiswrong
pushed a commit
that referenced
this pull request
May 16, 2017
…at64 as well as operator gtest framework (#5936) * Batch Norm rewrite without mshadow as well as operator gtest framework * performance testing * lint fixes * use CUDNN for this test * remove superfluous omp define * Fix file names in comments * build, run, clean gtest works (although a test is failing) * CR comments * Adjust timing tests for more strenuous sample * Remove temp resource allocation * DeviceTensor3 added, forEachFast not yet converted * DeviceTensor3 version working * DeviceTensor3 working * . * Fix for use_global_stats * fixed bug with testing suite for double (Float64) * python unit tests working for batchnorm * python unit tests * Update documentation for mxnet.initializer.Mixed (#5937) * Update documentation for SVMOutput. (#5931) * Update documentation for SVMOutput. * Update doc for SVMOutput - fix formatting. * Adding install instruction for Ubuntu-CPU-Python (#5885) * edit ndarray API docs (#5806) * edit docs in broadcast_reduce_op * edit docs in broadcast_reduce_op * minor change * lint fix * fix * mx.nd.ones * mx.nd.repeat * mx.nd.reverse * add example in repeat * optimizer update * fix nanprod * fix optimizer_op api doc * fix reduce_op api doc * fix nd.ones api doc * mx.nd.repeat doc change * Update broadcast_reduce_op.h * Symbol docs fixes (#5930) * symbol docs minor formatting changes * deepcopy, infer_shape, infer_shape_partial docs modified * Few more small fixes * arithmetic functions fixes * some more modifications * changes after review * small change * grad function note added * More API Doc Edits (#5886) * edit activation doc * doc l2_normalization * edit MakeLoss doc * edit blockgrad doc * blockgrad fileline fix * edit MakeLoss doc cont. * doc change 'tensor' to 'multidimensional array' * l2normalization doc improve * makeloss doc improve, blockgrad doc improve * fix doc in activation, l2_normalization, make_loss * fix minor grammar * use .describe to avoid build failure. * Update documentation for mxnet.image.imdecode (#5957) * Update documentation for mxnet.image.imdecode * Update documentation for mxnet.image.imdecode (clarify that we need OpenCV and not the CV2 Python library) * Fix script by adding path to Dockerfile (#5958) * Clean install script * Add test for pip installations * Remove debug statements & comments * Make test runnable as script and from framework * Fix path to Dockerfiles * Putting failing cases at the end * Update doc for Custom operator. (#5875) * Update doc for Custom operator. * Update doc for Custom operator. * Fix formating in doc for Custom operator. * Fix formating in doc for Custom operator. * Minor change to ndarray.Custom documentation. * Minor edit in doc for Custom operator. * Minor change to doc for Custom operator. Data is 'NDArray-or-Symbol'. * Minor formatting change for Custom operator documentation. * For Custom operator doc, move example into ndarray_doc.py. * Minor change in Custom operator documentation * Improve the doc of pick + Update dmlc-core (#5946) * Add PickParam to fix the docstring and the initial value for axis * Update dmlc-core * Update dmlc-core * Image docs modified (#5973) * imageIter doc modified * edited imageiter * ADD missing Libri_sample.json, FIX minor bugs in speech_recognition example (#5962) * [KVStore] Add support for other data types (#5818) * Fix kvstore type * Fix lint * Parse inputs to DataDesc * Make module support dtype * Fix lint * Add default dtype in Comm * Fix lint * Revert rename * [cpp-package] Add C++ basic tutorial and build instruction (#5971) * Add C++ basic tutorial and build instruction * Remove binaries * Fix lint * Avoid sign-compare * Update documentation for mxnet.metric.np (#5977) * Getting rid of identity (#5935) * Activation ops (#5938) * [Ops] Add op: 'relu' * Add op: 'sigmoid' * Introduce 'kernel_launch_op' * Add tests and describe; move it to elemwise_unary_op * Fix GPU version * Convert caffe AbsVal to mx.symbol.abs in caffe converter (#5984) * Correction to LSTMCell docstring (#5986) * [Module] fix input_grads order (#5980) * fix input_grads order + update dmlc-core * set label to be optional * update env_var doc (#5964) * Adjusting make, Callback removed * batch norm gpu testing * Batch Norm rewrite without mshadow as well as operator gtest framework * performance testing * lint fixes * use CUDNN for this test * remove superfluous omp define * Fix file names in comments * build, run, clean gtest works (although a test is failing) * CR comments * Adjust timing tests for more strenuous sample * Remove temp resource allocation * rearrange source into cc and cu files * lint fixes * Trigger build * Use latest mshadow * temporarily revert channel position parameter field * Add more tests for batchnorm * Add more tests for batchnorm * test_operator_gpu working for all types * Compiles after AccReal * Compiles after AccReal * All tests working * All tests working * build, run, clean gtest works (although a test is failing) * vc++ requires explicit int type for omp for loop * Repair cpp-package * signed/unsigned fixed in cuda file * lint fixes in tests and cpp-package directories * more lint * use IsWriting() helper * Fall-through for unsupported MKL shapes/types * Fall-through for unsupported MKL shapes/types * cleaner mkl_off approach * Warning only whem MKL is requested * Warning only whem MKL is requested * lint * .. * python problem fixed * python problem fixed * Merge branch 'batchnorm' into batchnorm_pr # Conflicts: # src/operator/batch_norm.cc # src/operator/batch_norm.cu # tests/cpp/operator/batchnorm_test.cc * lint fix * lint fix * lint fix * lint fix * lint fix * Fix visual c++ compile problem * . * . * All unit tests pass again * lint fix * fix strange compile errors in CUDNN batchnorm header * FInish using flags instead of bools * lint * Fix timing pass count for forward pass * Fix R script install roxygen problem * code formatting, addition of doc strings is causing IDE to add spaces before the calls * removed commented * cr comments * Change back to compilable code * For CPU mode, store as invstd * move testing code around a little * lint fix * Use AccReal in some places to avoid fp16 problems * Fix minor invstd problem in cuda version * remove unused scale param * add permutation unit test, handle cudnn doesn't like 3D * . * lint * . * Remove mkl_off * lint fix and time cudnn when enabled
saurabh3949
pushed a commit
to saurabh3949/mxnet
that referenced
this pull request
May 23, 2017
…at64 as well as operator gtest framework (apache#5936) * Batch Norm rewrite without mshadow as well as operator gtest framework * performance testing * lint fixes * use CUDNN for this test * remove superfluous omp define * Fix file names in comments * build, run, clean gtest works (although a test is failing) * CR comments * Adjust timing tests for more strenuous sample * Remove temp resource allocation * DeviceTensor3 added, forEachFast not yet converted * DeviceTensor3 version working * DeviceTensor3 working * . * Fix for use_global_stats * fixed bug with testing suite for double (Float64) * python unit tests working for batchnorm * python unit tests * Update documentation for mxnet.initializer.Mixed (apache#5937) * Update documentation for SVMOutput. (apache#5931) * Update documentation for SVMOutput. * Update doc for SVMOutput - fix formatting. * Adding install instruction for Ubuntu-CPU-Python (apache#5885) * edit ndarray API docs (apache#5806) * edit docs in broadcast_reduce_op * edit docs in broadcast_reduce_op * minor change * lint fix * fix * mx.nd.ones * mx.nd.repeat * mx.nd.reverse * add example in repeat * optimizer update * fix nanprod * fix optimizer_op api doc * fix reduce_op api doc * fix nd.ones api doc * mx.nd.repeat doc change * Update broadcast_reduce_op.h * Symbol docs fixes (apache#5930) * symbol docs minor formatting changes * deepcopy, infer_shape, infer_shape_partial docs modified * Few more small fixes * arithmetic functions fixes * some more modifications * changes after review * small change * grad function note added * More API Doc Edits (apache#5886) * edit activation doc * doc l2_normalization * edit MakeLoss doc * edit blockgrad doc * blockgrad fileline fix * edit MakeLoss doc cont. * doc change 'tensor' to 'multidimensional array' * l2normalization doc improve * makeloss doc improve, blockgrad doc improve * fix doc in activation, l2_normalization, make_loss * fix minor grammar * use .describe to avoid build failure. * Update documentation for mxnet.image.imdecode (apache#5957) * Update documentation for mxnet.image.imdecode * Update documentation for mxnet.image.imdecode (clarify that we need OpenCV and not the CV2 Python library) * Fix script by adding path to Dockerfile (apache#5958) * Clean install script * Add test for pip installations * Remove debug statements & comments * Make test runnable as script and from framework * Fix path to Dockerfiles * Putting failing cases at the end * Update doc for Custom operator. (apache#5875) * Update doc for Custom operator. * Update doc for Custom operator. * Fix formating in doc for Custom operator. * Fix formating in doc for Custom operator. * Minor change to ndarray.Custom documentation. * Minor edit in doc for Custom operator. * Minor change to doc for Custom operator. Data is 'NDArray-or-Symbol'. * Minor formatting change for Custom operator documentation. * For Custom operator doc, move example into ndarray_doc.py. * Minor change in Custom operator documentation * Improve the doc of pick + Update dmlc-core (apache#5946) * Add PickParam to fix the docstring and the initial value for axis * Update dmlc-core * Update dmlc-core * Image docs modified (apache#5973) * imageIter doc modified * edited imageiter * ADD missing Libri_sample.json, FIX minor bugs in speech_recognition example (apache#5962) * [KVStore] Add support for other data types (apache#5818) * Fix kvstore type * Fix lint * Parse inputs to DataDesc * Make module support dtype * Fix lint * Add default dtype in Comm * Fix lint * Revert rename * [cpp-package] Add C++ basic tutorial and build instruction (apache#5971) * Add C++ basic tutorial and build instruction * Remove binaries * Fix lint * Avoid sign-compare * Update documentation for mxnet.metric.np (apache#5977) * Getting rid of identity (apache#5935) * Activation ops (apache#5938) * [Ops] Add op: 'relu' * Add op: 'sigmoid' * Introduce 'kernel_launch_op' * Add tests and describe; move it to elemwise_unary_op * Fix GPU version * Convert caffe AbsVal to mx.symbol.abs in caffe converter (apache#5984) * Correction to LSTMCell docstring (apache#5986) * [Module] fix input_grads order (apache#5980) * fix input_grads order + update dmlc-core * set label to be optional * update env_var doc (apache#5964) * Adjusting make, Callback removed * batch norm gpu testing * Batch Norm rewrite without mshadow as well as operator gtest framework * performance testing * lint fixes * use CUDNN for this test * remove superfluous omp define * Fix file names in comments * build, run, clean gtest works (although a test is failing) * CR comments * Adjust timing tests for more strenuous sample * Remove temp resource allocation * rearrange source into cc and cu files * lint fixes * Trigger build * Use latest mshadow * temporarily revert channel position parameter field * Add more tests for batchnorm * Add more tests for batchnorm * test_operator_gpu working for all types * Compiles after AccReal * Compiles after AccReal * All tests working * All tests working * build, run, clean gtest works (although a test is failing) * vc++ requires explicit int type for omp for loop * Repair cpp-package * signed/unsigned fixed in cuda file * lint fixes in tests and cpp-package directories * more lint * use IsWriting() helper * Fall-through for unsupported MKL shapes/types * Fall-through for unsupported MKL shapes/types * cleaner mkl_off approach * Warning only whem MKL is requested * Warning only whem MKL is requested * lint * .. * python problem fixed * python problem fixed * Merge branch 'batchnorm' into batchnorm_pr # Conflicts: # src/operator/batch_norm.cc # src/operator/batch_norm.cu # tests/cpp/operator/batchnorm_test.cc * lint fix * lint fix * lint fix * lint fix * lint fix * Fix visual c++ compile problem * . * . * All unit tests pass again * lint fix * fix strange compile errors in CUDNN batchnorm header * FInish using flags instead of bools * lint * Fix timing pass count for forward pass * Fix R script install roxygen problem * code formatting, addition of doc strings is causing IDE to add spaces before the calls * removed commented * cr comments * Change back to compilable code * For CPU mode, store as invstd * move testing code around a little * lint fix * Use AccReal in some places to avoid fp16 problems * Fix minor invstd problem in cuda version * remove unused scale param * add permutation unit test, handle cudnn doesn't like 3D * . * lint * . * Remove mkl_off * lint fix and time cudnn when enabled
Guneet-Dhillon
pushed a commit
to Guneet-Dhillon/mxnet
that referenced
this pull request
Sep 13, 2017
* edit docs in broadcast_reduce_op * edit docs in broadcast_reduce_op * minor change * lint fix * fix * mx.nd.ones * mx.nd.repeat * mx.nd.reverse * add example in repeat * optimizer update * fix nanprod * fix optimizer_op api doc * fix reduce_op api doc * fix nd.ones api doc * mx.nd.repeat doc change * Update broadcast_reduce_op.h
Guneet-Dhillon
pushed a commit
to Guneet-Dhillon/mxnet
that referenced
this pull request
Sep 13, 2017
…at64 as well as operator gtest framework (apache#5936) * Batch Norm rewrite without mshadow as well as operator gtest framework * performance testing * lint fixes * use CUDNN for this test * remove superfluous omp define * Fix file names in comments * build, run, clean gtest works (although a test is failing) * CR comments * Adjust timing tests for more strenuous sample * Remove temp resource allocation * DeviceTensor3 added, forEachFast not yet converted * DeviceTensor3 version working * DeviceTensor3 working * . * Fix for use_global_stats * fixed bug with testing suite for double (Float64) * python unit tests working for batchnorm * python unit tests * Update documentation for mxnet.initializer.Mixed (apache#5937) * Update documentation for SVMOutput. (apache#5931) * Update documentation for SVMOutput. * Update doc for SVMOutput - fix formatting. * Adding install instruction for Ubuntu-CPU-Python (apache#5885) * edit ndarray API docs (apache#5806) * edit docs in broadcast_reduce_op * edit docs in broadcast_reduce_op * minor change * lint fix * fix * mx.nd.ones * mx.nd.repeat * mx.nd.reverse * add example in repeat * optimizer update * fix nanprod * fix optimizer_op api doc * fix reduce_op api doc * fix nd.ones api doc * mx.nd.repeat doc change * Update broadcast_reduce_op.h * Symbol docs fixes (apache#5930) * symbol docs minor formatting changes * deepcopy, infer_shape, infer_shape_partial docs modified * Few more small fixes * arithmetic functions fixes * some more modifications * changes after review * small change * grad function note added * More API Doc Edits (apache#5886) * edit activation doc * doc l2_normalization * edit MakeLoss doc * edit blockgrad doc * blockgrad fileline fix * edit MakeLoss doc cont. * doc change 'tensor' to 'multidimensional array' * l2normalization doc improve * makeloss doc improve, blockgrad doc improve * fix doc in activation, l2_normalization, make_loss * fix minor grammar * use .describe to avoid build failure. * Update documentation for mxnet.image.imdecode (apache#5957) * Update documentation for mxnet.image.imdecode * Update documentation for mxnet.image.imdecode (clarify that we need OpenCV and not the CV2 Python library) * Fix script by adding path to Dockerfile (apache#5958) * Clean install script * Add test for pip installations * Remove debug statements & comments * Make test runnable as script and from framework * Fix path to Dockerfiles * Putting failing cases at the end * Update doc for Custom operator. (apache#5875) * Update doc for Custom operator. * Update doc for Custom operator. * Fix formating in doc for Custom operator. * Fix formating in doc for Custom operator. * Minor change to ndarray.Custom documentation. * Minor edit in doc for Custom operator. * Minor change to doc for Custom operator. Data is 'NDArray-or-Symbol'. * Minor formatting change for Custom operator documentation. * For Custom operator doc, move example into ndarray_doc.py. * Minor change in Custom operator documentation * Improve the doc of pick + Update dmlc-core (apache#5946) * Add PickParam to fix the docstring and the initial value for axis * Update dmlc-core * Update dmlc-core * Image docs modified (apache#5973) * imageIter doc modified * edited imageiter * ADD missing Libri_sample.json, FIX minor bugs in speech_recognition example (apache#5962) * [KVStore] Add support for other data types (apache#5818) * Fix kvstore type * Fix lint * Parse inputs to DataDesc * Make module support dtype * Fix lint * Add default dtype in Comm * Fix lint * Revert rename * [cpp-package] Add C++ basic tutorial and build instruction (apache#5971) * Add C++ basic tutorial and build instruction * Remove binaries * Fix lint * Avoid sign-compare * Update documentation for mxnet.metric.np (apache#5977) * Getting rid of identity (apache#5935) * Activation ops (apache#5938) * [Ops] Add op: 'relu' * Add op: 'sigmoid' * Introduce 'kernel_launch_op' * Add tests and describe; move it to elemwise_unary_op * Fix GPU version * Convert caffe AbsVal to mx.symbol.abs in caffe converter (apache#5984) * Correction to LSTMCell docstring (apache#5986) * [Module] fix input_grads order (apache#5980) * fix input_grads order + update dmlc-core * set label to be optional * update env_var doc (apache#5964) * Adjusting make, Callback removed * batch norm gpu testing * Batch Norm rewrite without mshadow as well as operator gtest framework * performance testing * lint fixes * use CUDNN for this test * remove superfluous omp define * Fix file names in comments * build, run, clean gtest works (although a test is failing) * CR comments * Adjust timing tests for more strenuous sample * Remove temp resource allocation * rearrange source into cc and cu files * lint fixes * Trigger build * Use latest mshadow * temporarily revert channel position parameter field * Add more tests for batchnorm * Add more tests for batchnorm * test_operator_gpu working for all types * Compiles after AccReal * Compiles after AccReal * All tests working * All tests working * build, run, clean gtest works (although a test is failing) * vc++ requires explicit int type for omp for loop * Repair cpp-package * signed/unsigned fixed in cuda file * lint fixes in tests and cpp-package directories * more lint * use IsWriting() helper * Fall-through for unsupported MKL shapes/types * Fall-through for unsupported MKL shapes/types * cleaner mkl_off approach * Warning only whem MKL is requested * Warning only whem MKL is requested * lint * .. * python problem fixed * python problem fixed * Merge branch 'batchnorm' into batchnorm_pr # Conflicts: # src/operator/batch_norm.cc # src/operator/batch_norm.cu # tests/cpp/operator/batchnorm_test.cc * lint fix * lint fix * lint fix * lint fix * lint fix * Fix visual c++ compile problem * . * . * All unit tests pass again * lint fix * fix strange compile errors in CUDNN batchnorm header * FInish using flags instead of bools * lint * Fix timing pass count for forward pass * Fix R script install roxygen problem * code formatting, addition of doc strings is causing IDE to add spaces before the calls * removed commented * cr comments * Change back to compilable code * For CPU mode, store as invstd * move testing code around a little * lint fix * Use AccReal in some places to avoid fp16 problems * Fix minor invstd problem in cuda version * remove unused scale param * add permutation unit test, handle cudnn doesn't like 3D * . * lint * . * Remove mkl_off * lint fix and time cudnn when enabled
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Edited some math function -- reduce function docs.
Minor Edits
Edited some Array manipulation routines
Edited some optimizer update function
@mli, @zackchase, @Roshrini, @madjam, @nswamy