From 92fba466c5d9c68fbc7e36fa56929e21ebe48367 Mon Sep 17 00:00:00 2001 From: zhupengyang Date: Tue, 28 Jul 2020 09:32:35 +0800 Subject: [PATCH] refine ones_like doc (#2303) --- doc/fluid/api/tensor/ones_like.rst | 10 +++-- doc/fluid/api_cn/tensor_cn/ones_like_cn.rst | 42 +++++++++++---------- 2 files changed, 30 insertions(+), 22 deletions(-) diff --git a/doc/fluid/api/tensor/ones_like.rst b/doc/fluid/api/tensor/ones_like.rst index 4e1ae1407..47ecd764f 100644 --- a/doc/fluid/api/tensor/ones_like.rst +++ b/doc/fluid/api/tensor/ones_like.rst @@ -1,7 +1,11 @@ -.. _api_tensor_cn_ones_like: +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +.. _api_tensor_ones_like: ones_like -------------------------------- -:doc_source: paddle.fluid.layers.ones_like +--------- +.. autofunction:: paddle.tensor.ones_like + :noindex: diff --git a/doc/fluid/api_cn/tensor_cn/ones_like_cn.rst b/doc/fluid/api_cn/tensor_cn/ones_like_cn.rst index 6eebf69eb..33b189c7a 100644 --- a/doc/fluid/api_cn/tensor_cn/ones_like_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/ones_like_cn.rst @@ -3,33 +3,37 @@ ones_like ------------------------------- -.. py:function:: paddle.ones_like(input, dtype=None, device=None, name=None) +.. py:function:: paddle.ones_like(x, dtype=None, name=None) :alias_main: paddle.ones_like -:alias: paddle.ones_like,paddle.tensor.ones_like,paddle.tensor.creation.ones_like -:update_api: paddle.fluid.layers.ones_like +:alias: paddle.tensor.ones_like, paddle.tensor.creation.ones_like +该OP返回一个和 ``x`` 具有相同形状的数值都为1的Tensor,数据类型为 ``dtype`` 或者和 ``x`` 相同。 - - -该OP创建一个和input具有相同的形状和数据类型的全1Tensor。 - -参数: - - **input** (Variable) – 指定输入为一个多维的Tensor,数据类型可以是bool,float32,float64,int32,int64。 - - **dtype** (np.dtype|core.VarDesc.VarType|str, 可选)- 输出变量的数据类型。若参数为空,则输出变量的数据类型和输入变量相同,默认值为None。 - - **device** (str,可选) – 选择在哪个设备运行该操作,可选值包括None,'cpu'和'gpu'。如果 ``device`` 为None,则将选择运行Paddle程序的设备,默认为None。 - - **name** (str,可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。 +参数 +:::::::::: + - **x** (Tensor) – 输入的Tensor,数据类型可以是bool,float16, float32,float64,int32,int64。输出Tensor的形状和 ``x`` 相同。如果 ``dtype`` 为None,则输出Tensor的数据类型与 ``x`` 相同。 + - **dtype** (str|np.dtype|core.VarDesc.VarType, 可选) - 输出Tensor的数据类型,支持bool,float16, float32,float64,int32,int64。当该参数值为None时, 输出Tensor的数据类型与 ``x`` 相同。默认值为None. + - **name** (str, 可选) - 输出的名字。一般无需设置,默认值为None。该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` 。 -返回:返回一个存储结果的Tensor。 +返回 +:::::::::: + Tensor:和 ``x`` 具有相同形状的数值都为1的Tensor,数据类型为 ``dtype`` 或者和 ``x`` 相同。 -返回类型:Variable +抛出异常 +:::::::::: + - ``TypeError`` - 如果 ``dtype`` 不是bool、float16、float32、float64、int32、int64。 -**代码示例**: +代码示例 +:::::::::: .. code-block:: python import paddle - import paddle.fluid as fluid - x = fluid.data(name='x', dtype='float32', shape=[3]) - data = paddle.ones_like(x) # data=[1.0, 1.0, 1.0] - data1 = paddle.ones_like(input=x, device="gpu") # data1=[1.0, 1.0. 1.0] + import numpy as np + + paddle.enable_imperative() + + x = paddle.imperative.to_variable(np.array([1,2,3], dtype='float32')) + out1 = paddle.ones_like(x) # [1., 1., 1.] + out2 = paddle.ones_like(x, dtype='int32') # [1, 1, 1] -- GitLab