You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by jx...@apache.org on 2018/05/11 22:52:10 UTC
[incubator-mxnet] branch master updated: Fix eye doc (#10908)
This is an automated email from the ASF dual-hosted git repository.
jxie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git
The following commit(s) were added to refs/heads/master by this push:
new 0fcf191 Fix eye doc (#10908)
0fcf191 is described below
commit 0fcf191760303fd000fd756baab30553d45e6ce8
Author: Ziyue Huang <zy...@gmail.com>
AuthorDate: Sat May 12 06:52:04 2018 +0800
Fix eye doc (#10908)
* fix eye doc
* fix
---
python/mxnet/ndarray/ndarray.py | 3 +++
python/mxnet/symbol/symbol.py | 5 +++--
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/python/mxnet/ndarray/ndarray.py b/python/mxnet/ndarray/ndarray.py
index 007b3c8..f017d7e 100644
--- a/python/mxnet/ndarray/ndarray.py
+++ b/python/mxnet/ndarray/ndarray.py
@@ -3674,6 +3674,7 @@ def zeros(shape, ctx=None, dtype=None, **kwargs):
def eye(N, M=0, k=0, ctx=None, dtype=None, **kwargs):
"""Return a 2-D array with ones on the diagonal and zeros elsewhere.
+
Parameters
----------
N: int
@@ -3688,10 +3689,12 @@ def eye(N, M=0, k=0, ctx=None, dtype=None, **kwargs):
An optional device context (default is the current default context)
dtype: str or numpy.dtype, optional
An optional value type (default is `float32`)
+
Returns
-------
NDArray
A created array
+
Examples
--------
>>> mx.nd.eye(2)
diff --git a/python/mxnet/symbol/symbol.py b/python/mxnet/symbol/symbol.py
index 49023db..b113ddc 100644
--- a/python/mxnet/symbol/symbol.py
+++ b/python/mxnet/symbol/symbol.py
@@ -2746,8 +2746,8 @@ def hypot(left, right):
raise TypeError('types (%s, %s) not supported' % (str(type(left)), str(type(right))))
def eye(N, M=0, k=0, dtype=None, **kwargs):
- """Returns a new symbol of 2-D shpae, filled with ones on the diagonal
- and zeros elsewhere.
+ """Returns a new symbol of 2-D shpae, filled with ones on the diagonal and zeros elsewhere.
+
Parameters
----------
N: int
@@ -2760,6 +2760,7 @@ def eye(N, M=0, k=0, dtype=None, **kwargs):
and a negative value to a lower diagonal.
dtype : str or numpy.dtype, optional
The value type of the inner value, default to ``np.float32``.
+
Returns
-------
out : Symbol
--
To stop receiving notification emails like this one, please contact
jxie@apache.org.