Update doc for mxnet.ndarray.elemwise_add#5898
Update doc for mxnet.ndarray.elemwise_add#5898piiswrong merged 3 commits intoapache:masterfrom indhub:doc/elemwiseadd
Conversation
|
|
||
| Example:: | ||
|
|
||
| >>> x = mx.nd.array([1, 2, 3, 4]) |
There was a problem hiding this comment.
@mli Are we making all examples python specific or is there plans to add example for other languages? How do we separate them?
There was a problem hiding this comment.
we should not add python examples in .cc file.
There was a problem hiding this comment.
@mli @piiswrong : I don't see this operator defined in the Python files. Any idea how to keep the description in the cc file and add the example elsewhere specific to Python?
There was a problem hiding this comment.
@indhub, python specific examples should go to ndarray_doc.py. Also this does not have to be specific to Python.
zackchase
left a comment
zackchase
left a comment
There was a problem hiding this comment.
Not much language stuff to look at. Can @piiswrong or @mli double check examples before merging?
| (4L, 3L, 2L) | ||
| """ | ||
|
|
||
| class elemwise_addDoc(NDArrayDoc): |
There was a problem hiding this comment.
Would it make sense to add this example in the C++ documentation without the python-ness?.
I feel this is a simple example and does not have be repeated in every language binding.
There was a problem hiding this comment.
I'm not sure how to write this example in a language neutral way. Is there any other function that has a language neutral example that I can use as reference?
There was a problem hiding this comment.
Moved example into ndarray_doc.py
zackchase
left a comment
zackchase
left a comment
There was a problem hiding this comment.
Looks good here. I didn't spot any language issues. Resolve w @nswamy which examples to present and then @piiswrong - let's merge?
|
|
||
| >>> x = mx.nd.array([1, 2, 3, 4]) | ||
| >>> y = mx.nd.array([1.1, 2.1, 3.1, 4.1]) | ||
| >>> mx.nd.elemwise_add(x, y).asnumpy() |
There was a problem hiding this comment.
x + y also works. Should we document that?
There was a problem hiding this comment.
Does x+y internally call elemwise_add?
|
please fix lint |
* Update doc for mxnet.ndarray.elemwise_add * Update doc for elemwise_add. Move python examples into python file. * Change pylintrc to disable invalid-name check.
6 participants
@mli, @zackchase, @madjam, @nswamy, @Roshrini, @jiajiechen
Please review and merge.