未验证 提交 d2a0a2fc 编写于 作者: L Leo Chen 提交者: GitHub

update api doc, test=develop (#2074)

上级 8ba38e07
......@@ -19,8 +19,6 @@ import types
import os
import contextlib
import paddle.fluid as fluid
import paddle.tensor as tensor
import paddle.nn as nn
import paddle.complex as complex
#import paddle.framework as framework
......
......@@ -3,7 +3,7 @@
BCELoss
-------------------------------
.. py:function:: paddle.nn.BCELoss(input, label, weight=None, reduction='mean')
.. py:function:: paddle.fluid.dygraph.BCELoss(input, label, weight=None, reduction='mean')
该接口用于创建一个BCELoss的可调用类,用于计算输入和标签之间的二值交叉熵损失值。二值交叉熵损失函数公式如下:
......@@ -55,7 +55,7 @@ BCELoss
import paddle
input = fluid.data(name="input", shape=[3, 1], dtype='float32')
label = fluid.data(name="label", shape=[3, 1], dtype='float32')
bce_loss = paddle.nn.loss.BCELoss()
bce_loss = fluid.dygraph.BCELoss()
output = bce_loss(input, label)
place = fluid.CPUPlace()
exe = fluid.Executor(place)
......
......@@ -42,7 +42,7 @@ t
import paddle
import paddle.fluid as fluid
x = fluid.data(name='x', shape=[2, 3], dtype='float32')
x_transposed = fluid.layers.t(x) # paddle.t 等价于 paddle.tensor.t
x_transposed = fluid.layers.t(x)
print(x_transposed.shape)
#(3L, 2L)
.. _cn_api_tensor_trace:
trace
-------------------------------
**版本升级,文档正在开发中**
.. py:function:: fluid.layers.trace(input, offset=0, dim1=0, dim2=1)
该 OP 计算输入 Tensor 在指定平面上的对角线元素之和,并输出相应的计算结果。
如果输入是 2D Tensor,则返回对角线元素之和。
如果输入的维度大于 2D,则返回一个由对角线元素之和组成的数组,其中对角线从由 dim1 和 dim2 指定的二维平面中获得。默认由输入的前两维组成获得对角线的 2D 平面。
参数 ``offset`` 确定从指定的二维平面中获取对角线的位置:
- 如果 offset = 0,则取主对角线。
- 如果 offset > 0,则取主对角线右上的对角线。
- 如果 offset < 0,则取主对角线左下的对角线。
参数:
- **input** (Variable)- 输入变量,至少为 2D 数组,支持数据类型为 float32,float64,int32,int64。
- **offset** (int ,可选)- 从指定的二维平面中获取对角线的位置,默认值为 0,既主对角线。
- **dim1** (int , 可选)- 获取对角线的二维平面的第一维,默认值为 0。
- **dim2** (int , 可选)- 获取对角线的二维平面的第二维,默认值为 1。
返回: 指定二维平面的对角线元素之和。数据类型和输入数据类型一致。
返回类型: 变量(Variable)
**代码示例**
.. code-block:: python
import paddle.fluid as fluid
import paddle.fluid.dygraph as dg
import numpy as np
case1 = np.random.randn(2, 3).astype('float32')
case2 = np.random.randn(3, 10, 10).astype('float32')
case3 = np.random.randn(3, 10, 5, 10).astype('float32')
with dg.guard():
case1 = dg.to_variable(case1)
case2 = dg.to_variable(case2)
case3 = dg.to_variable(case3)
data1 = fluid.layers.trace(case1) # data1.shape = [1]
data2 = fluid.layers.trace(case2, offset=1, dim1=1, dim2=2) # data2.shape = [3]
data3 = fluid.layers.trace(case3, offset=-3, dim1=1, dim2=-1) # data2.shape = [3, 5]
=======================
paddle.tensor
=======================
.. toctree::
:maxdepth: 1
tensor_cn/addcmul_cn.rst
tensor_cn/add_cn.rst
tensor_cn/addmm_cn.rst
tensor_cn/allclose_cn.rst
tensor_cn/arange_cn.rst
tensor_cn/argmax_cn.rst
tensor_cn/atan_cn.rst
tensor_cn/bmm_cn.rst
tensor_cn/cholesky_cn.rst
tensor_cn/clamp_cn.rst
tensor_cn/concat_cn.rst
tensor_cn/cross_cn.rst
tensor_cn/dist_cn.rst
tensor_cn/div_cn.rst
tensor_cn/dot_cn.rst
tensor_cn/einsum_cn.rst
tensor_cn/elementwise_equal_cn.rst
tensor_cn/elementwise_sum_cn.rst
tensor_cn/equal_cn.rst
tensor_cn/erf_cn.rst
tensor_cn/eye_cn.rst
tensor_cn/flip_cn.rst
tensor_cn/full_cn.rst
tensor_cn/full_like_cn.rst
tensor_cn/gather_cn.rst
tensor_cn/index_select_cn.rst
tensor_cn/inverse_cn.rst
tensor_cn/isnan_cn.rst
tensor_cn/kron_cn.rst
tensor_cn/linspace_cn.rst
tensor_cn/log1p_cn.rst
tensor_cn/logsumexp_cn.rst
tensor_cn/math_cn.rst
tensor_cn/matmul_cn.rst
tensor_cn/max_cn.rst
tensor_cn/meshgrid_cn.rst
tensor_cn/min_cn.rst
tensor_cn/mm_cn.rst
tensor_cn/mul_cn.rst
tensor_cn/nonzero_cn.rst
tensor_cn/norm_cn.rst
tensor_cn/ones_cn.rst
tensor_cn/ones_like_cn.rst
tensor_cn/pow_cn.rst
tensor_cn/rand_cn.rst
tensor_cn/randint_cn.rst
tensor_cn/randn_cn.rst
tensor_cn/randperm_cn.rst
tensor_cn/roll_cn.rst
tensor_cn/sin_cn.rst
tensor_cn/sort_cn.rst
tensor_cn/split_cn.rst
tensor_cn/sqrt_cn.rst
tensor_cn/squeeze_cn.rst
tensor_cn/stack_cn.rst
tensor_cn/std_cn.rst
tensor_cn/sum_cn.rst
tensor_cn/tanh_cn.rst
tensor_cn/t_cn.rst
tensor_cn/tensordot_cn.rst
tensor_cn/trace_cn.rst
tensor_cn/transpose_cn.rst
tensor_cn/tril_cn.rst
tensor_cn/triu_cn.rst
tensor_cn/unbind_cn.rst
tensor_cn/unsqueeze_cn.rst
tensor_cn/var_cn.rst
tensor_cn/where_cn.rst
tensor_cn/zeros_cn.rst
tensor_cn/zeros_like_cn.rst
\ No newline at end of file
.. _cn_api_tensor_trace:
trace
-------------------------------
.. py:function:: fluid.layers.trace(input, offset=0, dim1=0, dim2=1)
该 OP 计算输入 Tensor 在指定平面上的对角线元素之和,并输出相应的计算结果。
如果输入是 2D Tensor,则返回对角线元素之和。
如果输入的维度大于 2D,则返回一个由对角线元素之和组成的数组,其中对角线从由 dim1 和 dim2 指定的二维平面中获得。默认由输入的前两维组成获得对角线的 2D 平面。
参数 ``offset`` 确定从指定的二维平面中获取对角线的位置:
- 如果 offset = 0,则取主对角线。
- 如果 offset > 0,则取主对角线右上的对角线。
- 如果 offset < 0,则取主对角线左下的对角线。
参数:
- **input** (Variable)- 输入变量,至少为 2D 数组,支持数据类型为 float32,float64,int32,int64。
- **offset** (int ,可选)- 从指定的二维平面中获取对角线的位置,默认值为 0,既主对角线。
- **dim1** (int , 可选)- 获取对角线的二维平面的第一维,默认值为 0。
- **dim2** (int , 可选)- 获取对角线的二维平面的第二维,默认值为 1。
返回: 指定二维平面的对角线元素之和。数据类型和输入数据类型一致。
返回类型: 变量(Variable)
**代码示例**
.. code-block:: python
import paddle.fluid as fluid
import paddle.fluid.dygraph as dg
import numpy as np
case1 = np.random.randn(2, 3).astype('float32')
case2 = np.random.randn(3, 10, 10).astype('float32')
case3 = np.random.randn(3, 10, 5, 10).astype('float32')
with dg.guard():
case1 = dg.to_variable(case1)
case2 = dg.to_variable(case2)
case3 = dg.to_variable(case3)
data1 = fluid.layers.trace(case1) # data1.shape = [1]
data2 = fluid.layers.trace(case2, offset=1, dim1=1, dim2=2) # data2.shape = [3]
data3 = fluid.layers.trace(case3, offset=-3, dim1=1, dim2=-1) # data2.shape = [3, 5]
.. _cn_api_tensor_where:
where
-------------------------------
.. py:function:: paddle.where(condition, x, y, name=None)
该OP返回一个根据输入 ``condition``, 选择 ``x`` 或 ``y`` 的元素组成的多维 ``Tensor`` :
.. math::
Out_i =
\left\{
\begin{aligned}
&X_i, & & if \ cond_i \ is \ True \\
&Y_i, & & if \ cond_i \ is \ False \\
\end{aligned}
\right.
参数:
- **condition** (Variable)- 选择 ``x`` 或 ``y`` 元素的条件 。
- **x** (Variable)- 多维 ``Tensor`` ,数据类型为 ``float32`` 或 ``float64`` 或 ``int32`` 或 ``int64`` 。
- **y** (Variable)- 多维 ``Tensor`` ,数据类型为 ``float32`` 或 ``float64`` 或 ``int32`` 或 ``int64`` 。
- **name** (str,可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。
返回:数据类型与 ``x`` 相同的 ``Tensor`` 。
返回类型:Variable。
**代码示例:**
.. code-block:: python
import paddle
import numpy as np
import paddle.fluid as fluid
x_i = np.array([0.9383, 0.1983, 3.2, 1.2]).astype("float32")
y_i = np.array([1.0, 1.0, 1.0, 1.0]).astype("float32")
with fluid.dygraph.guard():
x = fluid.dygraph.to_variable(x_i)
y = fluid.dygraph.to_variable(y_i)
out = paddle.where(x>1, x, y)
print(out.numpy())
#out: [1.0, 1.0, 3.2, 1.2]
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册