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

var, std docs (#2422)

上级 d2c01dfa
......@@ -108,6 +108,7 @@ paddle.tensor
tensor/squeeze.rst
tensor/stack.rst
tensor/stanh.rst
tensor/std.rst
tensor/stat.rst
tensor/strided_slice.rst
tensor/sum.rst
......@@ -119,6 +120,7 @@ paddle.tensor
tensor/unique_with_counts.rst
tensor/unsqueeze.rst
tensor/unstack.rst
tensor/var.rst
tensor/where.rst
tensor/zeros.rst
tensor/zeros_like.rst
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY!
.. _api_tensor_std:
std
---------
.. autofunction:: paddle.tensor.std
:noindex:
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY!
.. _api_tensor_var:
var
---------
.. autofunction:: paddle.tensor.var
:noindex:
.. _cn_api_tensor_cn_std:
std
-------------------------------
.. py:function:: paddle.std(input, axis=None, keepdim=False, unbiased=True, out=None, name=None)
:alias_main: paddle.std
:alias: paddle.std,paddle.tensor.std,paddle.tensor.stat.std
.. py:function:: paddle.std(x, axis=None, unbiased=True, keepdim=False, name=None)
根据指定的axis计算input的标准差。
沿给定的轴 ``axis`` 计算 ``x`` 中元素的标准差。
参数
- **input** (Variable) - 数据类型为float32,float64。要计算标准差的输入。
- **axis** (list|int, 可选) - 根据axis计算标准差。如果设为 `None`,计算 :attr:`input` 的所有元素的标准差并返回shape为[1]的单个结果。如果不是 `None`, 则设定的axis的值必须在 :math:`[-rank(input), rank(input))` 范围内。 如果 :math:`axis[i] < 0`, 则要计算的axis是 :math:`rank(input) + axis[i]`
- **keepdim** (bool, 可选) - 是否在输出中保留减小的维度。如 keep_dim 为False,输出张量的维度将比输入张量小, 为True时则维度相同。默认值:False。
- **unbiased** (bool, 可选) - 是否使用无偏估计来计算标准差。使用 :math:`N` 来代表在axis上的维度,如果 unbiased 为True, 则在计算中使用 :math:`N - 1` 作为除数。为False时将使用 :math:`N` 作为除数。默认值:True。
- **out** (Variable, 可选) - 如果out不是None, 则将标准差结果存储在out中。默认值:None。
- **name** (str,可选) – 具体用法请参见 :ref:`cn_api_guide_Name` ,一般无需设置,默认值:None
参数
::::::::::
- x (Tensor) - 输入的Tensor,数据类型为:float32、float64
- axis (int|list|tuple, 可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是int、list(int)、tuple(int)。如果 ``axis`` 包含多个维度,则沿着 ``axis`` 中的所有轴进行计算。``axis`` 或者其中的元素值应该在范围[-D, D)内,D是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于0,则等价于 :math:`axis + D` 。如果 ``axis`` 是None,则对 ``x`` 的全部元素计算标准差。默认值为None。
- unbiased (bool, 可选) - 是否使用无偏估计来计算标准差。使用 :math:`N` 来代表在 axis 上的维度,如果 ``unbiased`` 为True, 则在计算中使用 :math:`N - 1` 作为除数。为 False 时将使用 :math:`N` 作为除数。默认值为True。
- keepdim (bool, 可选) - 是否在输出Tensor中保留减小的维度。如果 ``keepdim`` 为True,则输出Tensor和 ``x`` 具有相同的维度(减少的维度除外,减少的维度的大小为1)。否则,输出Tensor的形状会在 ``axis`` 上进行squeeze操作。默认值为False。
- name (str, 可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name`
返回
::::::::::
``Tensor`` ,沿着 ``axis`` 进行标准差计算的结果,数据类型和 ``x`` 相同。
返回: 计算出来的标准差。
返回类型: Variable(Tensor) ,数据类型和 :attr:`input` 相同。如果 :attr:`out = None`, 返回包含标准差的新Variable , 否则的话返回 :attr:`out` 的引用。
**代码示例**
代码示例
::::::::::
.. code-block:: python
import paddle
import paddle.fluid as fluid
# x is a Tensor variable with following elements:
# [[0.2, 0.3, 0.5, 0.9]
# [0.1, 0.2, 0.6, 0.7]]
# Each example is followed by the corresponding output tensor.
x = fluid.data(name='x', shape=[2, 4], dtype='float32')
paddle.std(x) # [0.28252685]
paddle.std(x, axis=[0]) # [0.0707107, 0.07071075, 0.07071064, 0.1414217]
paddle.std(x, axis=[-1]) # [0.30956957, 0.29439208]
\ No newline at end of file
import numpy as np
paddle.disable_static()
x = np.array([[1.0, 2.0, 3.0], [1.0, 4.0, 5.0]])
x = paddle.to_tensor(x)
out1 = paddle.std(x)
# [1.63299316]
out2 = paddle.std(x, axis=1)
# [1. 2.081666]
.. _cn_api_tensor_cn_var:
var
-------------------------------
.. py:function:: paddle.var(input, axis=None, keepdim=False, unbiased=True, out=None, name=None)
:alias_main: paddle.var
:alias: paddle.var,paddle.tensor.var,paddle.tensor.stat.var
.. py:function:: paddle.var(x, axis=None, unbiased=True, keepdim=False, name=None)
沿给定的轴 axis 计算输入变量所有元素的方差。
沿给定的轴 ``axis`` 计算 ``x`` 中元素的方差。
参数:
- **input** (Variable) - 要计算方差的输入变量,支持的数据类型为 float32 或 float64。
- **axis** (list|int, 可选) - 给定的轴。如果设为 `None`,计算 :attr:`input` 的所有元素的方差并返回形状为 [1] 的单个结果。如果非 `None`, 则给定的 axis 的值必须在 :math:`[-rank(input), rank(input))` 范围内。 如果 :math:`axis[i] < 0`, 则实际的 axis 是 :math:`rank(input) + axis[i]`
- **keepdim** (bool, 可选) - 是否在输出中保留被规约的维度。如 keep_dim 为False,输出张量的维度将比输入张量小, 为True时则维度相同。默认值:False。
- **unbiased** (bool, 可选) - 是否使用无偏估计来计算方差。使用 :math:`N` 来代表在 axis 上的维度,如果 unbiased 为True, 则在计算中使用 :math:`N - 1` 作为除数。为 False 时将使用 :math:`N` 作为除数。默认值:True。
- **out** (Variable, 可选) - 如果out不是None, 则将方差结果存储在 out 中。默认值:None。
- **name** (str,可选) – 具体用法请参见 :ref:`cn_api_guide_Name` ,一般无需设置,默认值:None
参数
::::::::::
- x (Tensor) - 输入的Tensor,数据类型为:float32、float64
- axis (int|list|tuple, 可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是int、list(int)、tuple(int)。如果 ``axis`` 包含多个维度,则沿着 ``axis`` 中的所有轴进行计算。``axis`` 或者其中的元素值应该在范围[-D, D)内,D是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于0,则等价于 :math:`axis + D` 。如果 ``axis`` 是None,则对 ``x`` 的全部元素计算方差。默认值为None。
- unbiased (bool, 可选) - 是否使用无偏估计来计算方差。使用 :math:`N` 来代表在 axis 上的维度,如果 ``unbiased`` 为True, 则在计算中使用 :math:`N - 1` 作为除数。为 False 时将使用 :math:`N` 作为除数。默认值为True。
- keepdim (bool, 可选) - 是否在输出Tensor中保留减小的维度。如果 ``keepdim`` 为True,则输出Tensor和 ``x`` 具有相同的维度(减少的维度除外,减少的维度的大小为1)。否则,输出Tensor的形状会在 ``axis`` 上进行squeeze操作。默认值为False。
- name (str, 可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name`
返回
::::::::::
``Tensor`` ,沿着 ``axis`` 进行方差计算的结果,数据类型和 ``x`` 相同。
返回: 计算出来的方差。
代码示例
::::::::::
返回类型: Variable(Tensor) ,数据类型和 :attr:`input` 相同。如果 :attr:`out = None`, 返回包含方差的新 Variable , 否则返回 :attr:`out` 的引用。
.. code-block:: python
**代码示例**
import paddle
import numpy as np
.. code-block:: python
paddle.disable_static()
import numpy as np
import paddle
import paddle.fluid.dygraph as dg
a = np.array([[1.0, 2.0], [3.0, 4.0]]).astype("float32")
with dg.guard():
data = dg.to_variable(a)
variance = paddle.var(data, axis=[1])
print(variance.numpy())
# [0.5 0.5]
x = np.array([[1.0, 2.0, 3.0], [1.0, 4.0, 5.0]])
x = paddle.to_tensor(x)
out1 = paddle.var(x)
# [2.66666667]
out2 = paddle.var(x, axis=1)
# [1. 4.33333333]
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册