未验证 提交 7f7af560 编写于 作者: Z zhupengyang 提交者: GitHub

update arange doc (#2280)

上级 84a32a5e
......@@ -3,33 +3,32 @@
range
-------------------------------
.. py:function:: paddle.fluid.layers.range(start, end, step, dtype)
.. py:function:: paddle.fluid.layers.range(start, end, step, dtype, name=None)
注意:推荐使用 paddle.arange
该OP以步长 ``step`` 均匀分隔给定数值区间[``start``, ``end``),并返回分隔结果。
该API根据step均匀分隔给定数值区间[start, end),并返回该分隔结果。
当 ``dtype`` 表示浮点类型时,为了避免浮点计算误差,建议给 ``end`` 加上一个极小值epsilon,使边界可以更加明确。
参数:
- **start** (float32 | float64 | int32 | int64 | Variable) - 区间起点,且区间包括此值, 当类型是Variable时,是shape为 `[1]` 的1-D Tensor。
- **end** (float32 | float64 | int32 | int64 | Variable) - 区间终点,通常区间不包括此值。但当step不是整数,且浮点数取整会影响输出的长度时例外。
- **step** (float32 | float64 | int32 | int64 | Variable) - 均匀分割的步长。
- **dtype** (str | core.VarDesc.VarType) - 输出Tensor的数据类型,可为 `'float32'`, `'float64'`, `'int32'`, `'int64'` 。
返回:均匀分割给定数值区间后得到的1-D Tensor, 数据类型为输入 `dtype` 。
- **start** (float|int|Variable) - 区间起点(且区间包括此值)。当 ``start`` 类型是Variable时,是形状为[1]且数据类型为int32、int64、float32、float64的Tensor。
- **end** (float|int|Variable) - 区间终点(且通常区间不包括此值)。当 ``end`` 类型是Variable时,是形状为[1]且数据类型为int32、int64、float32、float64的Tensor。
- **step** (float|int|Variable) - 均匀分割的步长。当 ``step`` 类型是Variable时,是形状为[1]且数据类型为int32、int64、float32、float64的Tensor。
- **dtype** (str|np.dtype|core.VarDesc.VarType) - 输出Tensor的数据类型,支持int32、int64、float32、float64。
- **name** (str, 可选) - 输出的名字。一般无需设置,默认值为None。该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` 。
返回类型:Variable
返回:
Variable:以步长 ``step`` 均匀分割给定数值区间[``start``, ``end``)后得到的1-D Tensor, 数据类型为 ``dtype`` 。
抛出异常:
- ``TypeError`` - 如果 ``dtype`` 不是float32、float64、int32、int64。
**代码示例**
代码示例
.. code-block:: python
import paddle.fluid as fluid
data = fluid.layers.range(0, 10, 2, 'int32')
# [0, 2, 4, 6, 8]
......@@ -3,33 +3,53 @@
arange
-------------------------------
.. py:function:: paddle.tensor.arange(start, end, step=1, dtype=None, name=None)
.. py:function:: paddle.arange(start=0, end=None, step=1, dtype=None, name=None)
:alias_main: paddle.arange
:alias: paddle.arange,paddle.tensor.arange,paddle.tensor.creation.arange
:update_api: paddle.fluid.layers.range
:alias: paddle.tensor.arange, paddle.tensor.creation.arange
API根据step均匀分隔给定数值区间[start, end),并返回该分隔结果。
OP以步长 ``step`` 均匀分隔给定数值区间[``start``, ``end``),并返回分隔结果。
**参数**:
- **start** (float32 | float64 | int32 | int64 | Variable) - 区间起点,且区间包括此值, 当类型是Variable时,是shape为 [1] 的1-D Tensor。
- **end** (float32 | float64 | int32 | int64 | Variable) - 区间终点,通常区间不包括此值。但当step不是整数,且浮点数取整会影响输出的长度时例外。
- **step** (float32 | float64 | int32 | int64 | Variable) - 均匀分割的步长。
- **dtype** (str | core.VarDesc.VarType) - 输出Tensor的数据类型,可为 'float32', 'float64', 'int32', 'int64' 。
当 ``dtype`` 表示浮点类型时,为了避免浮点计算误差,建议给 ``end`` 加上一个极小值epsilon,使边界可以更加明确。
**返回**:均匀分割给定数值区间后得到的1-D Tensor, 数据类型为输入 dtype 。
参数
::::::::::
- **start** (float|int|Variable) - 区间起点(且区间包括此值)。当 ``start`` 类型是Variable时,是形状为[1]且数据类型为int32、int64、float32、float64的Tensor。如果仅指定 ``start`` ,而 ``end`` 为None,则区间为[0, ``start``)。默认值为0。
- **end** (float|int|Variable, 可选) - 区间终点(且通常区间不包括此值)。当 ``end`` 类型是Variable时,是形状为[1]且数据类型为int32、int64、float32、float64的Tensor。默认值为None。
- **step** (float|int|Variable, 可选) - 均匀分割的步长。当 ``step`` 类型是Variable时,是形状为[1]且数据类型为int32、int64、float32、float64的Tensor。默认值为1。
- **dtype** (str|np.dtype|core.VarDesc.VarType, 可选) - 输出Tensor的数据类型,支持int32、int64、float32、float64。当该参数值为None时, 输出Tensor的数据类型为int64。默认值为None.
- **name** (str, 可选) - 输出的名字。一般无需设置,默认值为None。该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` 。
**返回类型**:Variable
返回
::::::::::
Tensor: ``step`` 均匀分割给定数值区间[``start``, ``end``)后得到的1-D Tensor, 数据类型为 ``dtype`` 。
**代码示例**
抛出异常
::::::::::
- ``TypeError`` - 如果 ``dtype`` 不是int32、int64、float32、float64。
代码示例
::::::::::
.. code-block:: python
import paddle
import paddle.fluid as fluid
with fluid.dygraph.guard():
x = paddle.arange(0, 6, 2)
# x: [0, 2, 4]
# x dtype: float32
import paddle
import numpy as np
paddle.enable_imperative()
out1 = paddle.arange(5)
# [0, 1, 2, 3, 4]
out2 = paddle.arange(3, 9, 2.0)
# [3, 5, 7]
# use 4.999 instead of 5.0 to avoid floating point rounding errors
out3 = paddle.arange(4.999, dtype='float32')
# [0., 1., 2., 3., 4.]
start_var = paddle.imperative.to_variable(np.array([3]))
out4 = paddle.arange(start_var, 7)
# [3, 4, 5, 6]
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册