Add api note

This commit is contained in:
liuyang_655 2022-03-10 04:27:27 -05:00
parent d2c23394d8
commit 562d78f94c
3 changed files with 26 additions and 0 deletions

View File

@ -59,6 +59,9 @@ Array Generation
mindspore.numpy.ones
mindspore.numpy.ones_like
mindspore.numpy.pad
mindspore.numpy.rand
mindspore.numpy.randint
mindspore.numpy.randn
mindspore.numpy.trace
mindspore.numpy.tri
mindspore.numpy.tril

View File

@ -334,6 +334,7 @@ functional算子是经过初始化后的Primitive可以直接作为函数使
:nosignatures:
:template: classtemplate.rst
mindspore.ops.arange
mindspore.ops.batch_dot
mindspore.ops.clip_by_global_norm
mindspore.ops.clip_by_value

View File

@ -0,0 +1,22 @@
mindspore.ops.arange
===============================
.. py:function:: mindspore.ops.arange(start=0, stop=None, step=1, rtype=None)
根据给定的范围返回指定均匀间隔的数据。
**参数:**
- **start** (Union[int, float]) - 指定范围的起始值范围包含该值。类型为int或float。
- **stop** (Union[int, float]) - 指定范围的结束值范围不包含该值。类型为int或float。
- **step** (Union[int, float]) - 指定取值的间隔。类型为int或float。
- **rtype** (Union[mindspore.dtypestr]) - 指定返回数据的类型,如果不指定,则会根据 `start``stop``step` 的值推断类型。
**返回:**
Tensor值是均匀间隔的数据类型为给定或推断的结果。
**异常:**
- **TypeError** - `start``stop``step` 的类型不是int或float。
- **ValueError** - `start` 的值大于等于 `stop`