未验证 提交 3f6ce24b 编写于 作者: W wangchaochaohu 提交者: GitHub

Eye op chinese doc refine for API 2.0 (#2293)

上级 237a348f
......@@ -11,18 +11,22 @@ eye
该OP用来构建单位矩阵,或一个批次的单位矩阵
该OP用来构建二维张量,或一个批次的二维张量
参数:
- **num_rows** (int) - 每一个批矩阵的行数,数据类型为非负int32。
- **num_columns** (int) - 每一个批矩阵的列数,数据类型为非负int32。若为None,则默认等于num_rows。
- **batch_shape** (list(int)) - 如若提供,则返回向量的主批次维度将为batch_shape。
- **dtype** (string) - 返回张量的数据类型,可为int32,int64,float16,float32,float64
- **num_rows** (int) - 该批次二维张量的行数,数据类型为非负int32。
- **num_columns** (int, 可选) - 该批次二维张量的列数,数据类型为非负int32。若为None,则默认等于num_rows。
- **batch_shape** (list(int), 可选) - 如若提供,则返回向量的主批次维度将为batch_shape。
- **dtype** (np.dtype|core.VarDesc.VarType|str,可选) - 返回张量的数据类型,可为int32,int64,float16,float32,float64,默认数据类型为float32
返回:shape为batch_shape + [num_rows, num_columns]的张量。
返回类型:Variable(Tensor|LoDTensor)数据类型为int32,int64,float16,float32,float64的Tensor或者LoDTensor。
抛出异常:
- ``TypeError``: - 如果 ``dtype`` 的类型不是float16, float32, float64, int32, int64其中之一。
- ``TypeError``: - 如果 ``num_columns`` 不是非负整数或者 ``num_rows`` 不是非负整数。
**代码示例**:
.. code-block:: python
......
......@@ -3,35 +3,37 @@
eye
-------------------------------
.. py:function:: paddle.tensor.eye(num_rows, num_columns=None, out=None, dtype='float32', stop_gradient=True, name=None)
.. py:function:: paddle.tensor.eye(num_rows, num_columns=None, dtype=None, name=None)
该OP用来构建单位矩阵
该OP用来构建二维张量(主对角线元素为1,其他元素为0)
参数:
- **num_rows** (int) - 生成单位矩阵的行数,数据类型为非负int32。
- **num_columns** (int) - 生成单位矩阵的列数,数据类型为非负int32。若为None,则默认等于num_rows。
- **out** (Variable, 可选) - 指定算子输出结果的LoDTensor/Tensor,可以是程序中已经创建的任何Variable。默认值为None,此时将创建新的Variable来保存输出结果。
- **dtype** (string, 可选) - 返回张量的数据类型,可为int32,int64,float16,float32,float64。
- **stop_gradient** (bool, 可选) - 是否对此OP停止计算梯度,默认值为False。
- **num_rows** (int) - 生成二维张量的行数,数据类型为非负int32。
- **num_columns** (int,可选) - 生成二维张量的列数,数据类型为非负int32。若为None,则默认等于num_rows。
- **dtype** (np.dtype|core.VarDesc.VarType|str, 可选) - 返回张量的数据类型,可为float16,float32,float64, int32, int64。若为None, 则默认等于float32。
- **name** (str, 可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。
返回:shape为 [num_rows, num_columns]的张量。
返回类型:Variable(Tensor|LoDTensor)数据类型为int32,int64,float16,float32,float64的Tensor或者LoDTensor。
返回类型:Variable(Tensor),数据类型为dtype指定的类型。
抛出异常:
- ``TypeError``: - 如果 ``dtype`` 的类型不是float16, float32, float64, int32, int64其中之一。
- ``TypeError``: - 如果 ``num_columns`` 不是非负整数或者 ``num_rows`` 不是非负整数。
**代码示例**:
.. code-block:: python
import paddle
paddle.enable_imperative()
data = paddle.eye(3, dtype='int32') # paddle.eye 等价于 paddle.tensor.eye
# [[1, 0, 0]
# [0, 1, 0]
# [0, 0, 1]]
# [[1 0 0]
# [0 1 0]
# [0 0 1]]
data = paddle.eye(2, 3, dtype='int32')
# [[1, 0, 0]
# [0, 1, 0]]
# [[1 0 0]
# [0 1 0]]
......
......@@ -11,21 +11,21 @@ full
该OP创建一个和具有相同的形状和数据类型的Tensor,其中元素值均为fill_value
该OP创建形状大小为shape并且数据类型为dtype的张量,其中元素值均为 ``fill_value``
参数:
- **shape** (list|tuple|Variable) – 指定创建Tensor的形状(shape), 数据类型为int32 或者int64。
- **fill_value** (bool|float|int|Variable) - 用于初始化输出Tensor的常量数据的值。注意:该参数不可超过输出变量数据类型的表示范围。
- **dtype** (np.dtype|core.VarDesc.VarType|str, 可选)- 输出变量的数据类型。若参数为空,则输出变量的数据类型和输入变量相同,默认值为None。
- **shape** (list|tuple|Variable) – 指定创建张量的形状(shape), 数据类型为int32 或者int64。
- **fill_value** (bool|float|int|Variable) - 用于初始化输出张量的常量数据的值。注意:该参数不可超过输出变量数据类型的表示范围。
- **dtype** (np.dtype|core.VarDesc.VarType|str, 可选)- 输出变量的数据类型。若为None,则输出变量的数据类型和输入变量相同,默认值为None。
- **name** (str,可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。
返回:返回一个存储结果的Tensor。
返回:返回一个存储结果的Tensor,数据类型和dtype相同
返回类型:Variable
抛出异常:
- ``TypeError`` - 如果 ``dtype`` 的类型不是bool, float16, float32, float64, int32, int64其中之一。
- ``TypeError`` - 如果 ``shape`` 的类型不是list或tuple或Varibable。
- ``TypeError``: - 如果 ``dtype`` 的类型不是bool, float16, float32, float64, int32, int64其中之一。
- ``TypeError``: - 如果 ``shape`` 的类型不是list或tuple或Variable。
**代码示例**:
......@@ -49,7 +49,7 @@ full
# [[True True]
# [True True]]
# attr value is an Variable Tensor.
# attr fill_value is an Variable Tensor.
val = paddle.fill_constant([1], "float32", 2.0)
data5 = paddle.full(shape=[2,1], fill_value=val, dtype='float32') i
# [[2.0]
......
......@@ -8,21 +8,21 @@ full_like
:alias_main: paddle.full_like
:alias: paddle.full_like,paddle.tensor.full_like,paddle.tensor.creation.full_like
该OP创建一个和input具有相同的形状和数据类型的Tensor,其中元素值均为fill_value
该OP创建一个和x具有相同的形状和数据类型的张量,其中元素值均为 ``fill_value``
参数:
- **x** (Variable) – 指定输入为一个多维的Tensor,数据类型可以是bool,float16,float32,float64,int32,int64。
- **fill_value** (bool|float|int) - 用于初始化输出Tensor的常量数据的值。注意:该参数不可超过输出变量数据类型的表示范围。
- **x** (Variable) – 输入张量, 输出张量和x具有相同的形状,x的数据类型可以是bool,float16,float32,float64,int32,int64。
- **fill_value** (bool|float|int) - 用于初始化输出张量的常量数据的值。注意:该参数不可超过输出变量数据类型的表示范围。
- **dtype** (np.dtype|core.VarDesc.VarType|str, 可选)- 输出变量的数据类型。若参数为None,则输出变量的数据类型和输入变量相同,默认值为None。
- **name** (str,可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。
返回:返回一个存储结果的Tensor。
返回:返回一个存储结果的Tensor,数据类型和dtype相同
返回类型:Variable
抛出异常:
- ``TypeError`` - 当dtype不是bool、float16、float32、float64、int32、int64其中之一。
- ``TypeError`` - 如果 ``shape`` 的类型不是list或tuple或Varibable。
- ``TypeError``: - 当dtype不是bool、float16、float32、float64、int32、int64其中之一。
- ``TypeError``: - 如果 ``shape`` 的类型不是list或tuple或Varibable。
**代码示例**:
......
......@@ -34,6 +34,8 @@ ones
import paddle
paddle.enable_imperative()
#default dtype for ones OP
data1 = paddle.ones(shape=[3, 2])
# [[1. 1.]
# [1. 1.]
......@@ -41,6 +43,8 @@ ones
data2 = paddle.ones(shape=[2, 2], dtype='int32')
# [[1 1]
# [1 1]]
#attr shape is a Variable Tensor
shape = paddle.fill_constant(shape=[2], dtype='int32', value=2)
data3 = paddle.ones(shape=shape, dtype='int32')
# [[1 1]
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册