ones_cn.rst 1.5 KB
Newer Older
1 2
.. _cn_api_tensor_ones:

T
tianshuo78520a 已提交
3 4
ones
-------------------------------
5

W
wangchaochaohu 已提交
6
.. py:function:: paddle.ones(shape, dtype=None)
7

S
swtkiwi 已提交
8 9 10 11 12 13
:alias_main: paddle.ones
:alias: paddle.ones,paddle.tensor.ones,paddle.tensor.creation.ones
:update_api: paddle.fluid.layers.ones



14 15 16 17

该OP创建形状为 ``shape`` 、数据类型为 ``dtype`` 且值全为1的Tensor。

参数:
W
wangchaochaohu 已提交
18 19 20
    - **shape** (tuple|list|Variable) - 输出Tensor的形状,数据类型为int32或者int64。
    - **dtype** (np.dtype|core.VarDesc.VarType|str, 可选) - 输出Tensor的数据类型,数据类型必须为float16、float32、float64、int32或int64。如果dtype为None,默认数据类型为float32。
    - **name** (str,可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。
21 22 23 24 25

返回:值全为1的Tensor,数据类型和 ``dtype`` 定义的类型一致。

返回类型:Variable

W
wangchaochaohu 已提交
26 27 28 29
抛出异常:
    - ``TypeError`` - 当dtype不是float16、float32、float64、int32或int64中的一个的时候
    - ``TypeError`` - 当shape 不是tuple、list、或者Variable的时候。

30 31 32 33 34
**代码示例**:

.. code-block:: python

    import paddle
W
wangchaochaohu 已提交
35 36
    
    paddle.enable_imperative()
37 38
    
    #default dtype for ones OP
W
wangchaochaohu 已提交
39 40 41 42 43 44 45
    data1 = paddle.ones(shape=[3, 2]) 
    # [[1. 1.]
    #  [1. 1.]
    #  [1. 1.]]
    data2 = paddle.ones(shape=[2, 2], dtype='int32') 
    # [[1 1]
    #  [1 1]]
46 47

    #attr shape is a Variable Tensor
W
wangchaochaohu 已提交
48 49 50 51
    shape = paddle.fill_constant(shape=[2], dtype='int32', value=2)
    data3 = paddle.ones(shape=shape, dtype='int32') 
    # [[1 1]
    #  [1 1]]
52