diff --git a/docs/api/paddle/std_cn.rst b/docs/api/paddle/std_cn.rst index c0481cd8d64..9255bcc0160 100644 --- a/docs/api/paddle/std_cn.rst +++ b/docs/api/paddle/std_cn.rst @@ -3,17 +3,29 @@ std ------------------------------- -.. py:function:: paddle.std(x, axis=None, unbiased=True, keepdim=False, name=None) +.. py:function:: paddle.std(x, axis=None, unbiased=None, keepdim=False, name=None, *, correction=1, out=None) 沿给定的轴 ``axis`` 计算 ``x`` 中元素的标准差。 +.. note:: + 别名支持: 参数名 ``input`` 可替代 ``x`` ,参数名 ``dim`` 可替代 ``axis``。如 ``input=tensor_x`` 等价于 ``x=tensor_x``, ``dim=1`` 等价于 ``axis=1``。 + 参数 :::::::::: - **x** (Tensor) - 输入的 Tensor,数据类型为:float16、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。 + 别名: ``input`` + - **axis** (int|list|tuple,可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int、list(int)、tuple(int)。 + 别名: ``dim`` + + - 如果 ``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` 作为除数。默认值为 None。 - **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。如果 ``keepdim`` 为 True,则输出 Tensor 和 ``x`` 具有相同的维度(减少的维度除外,减少的维度的大小为 1)。否则,输出 Tensor 的形状会在 ``axis`` 上进行 squeeze 操作。默认值为 False。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 + - **correction** (int|float,可选) - 样本数量与样本自由度之间的差异。该参数为仅关键字参数,默认值为 1(贝塞尔校正)。若已设置 ``unbiased`` 为 True,则 ``correction`` 为 1,无需手动设置。 + - **out** (Tensor,可选)- 输出的结果。该参数为仅关键字参数,默认值为 None。 返回 :::::::::: diff --git a/docs/api/paddle/var_cn.rst b/docs/api/paddle/var_cn.rst index b63c7e5e301..0fd8f51fc11 100644 --- a/docs/api/paddle/var_cn.rst +++ b/docs/api/paddle/var_cn.rst @@ -3,7 +3,7 @@ var ------------------------------- -.. py:function:: paddle.var(x, axis=None, unbiased=True, keepdim=False, name=None, *, correction=1, out=None) +.. py:function:: paddle.var(x, axis=None, unbiased=None, keepdim=False, name=None, *, correction=1, out=None) 沿给定的轴 ``axis`` 计算 ``x`` 中元素的方差。 @@ -12,21 +12,20 @@ var 参数 :::::::::: - - **x** (Tensor) - 输入的 Tensor,数据类型为:float16、float32、float64。 - 别名: ``input`` - - **axis** (int|list|tuple,可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int、list(int)、tuple(int)。 - ``别名:dim`` - - - 如果 ``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 的维度将比输入 Tensor 小一维,默认值为 False。 - 别名: ``dim`` - - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 - - **correction** (int|float,可选) - 样本数量与样本自由度之间的差异。该参数为仅关键字参数,默认值为 1(贝塞尔校正)。 - - **out** (Tensor,可选)- 输出的结果。该参数为仅关键字参数,默认值为 None。 + - **x** (Tensor) - 输入的 Tensor,数据类型为:float16、float32、float64。 + 别名: ``input`` + - **axis** (int|list|tuple,可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int、list(int)、tuple(int)。 + 别名: ``dim`` + + - 如果 ``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` 作为除数。默认值为 None。 + - **keepdim** (bool,可选) - 是否在输出 Tensor 中保留输入的维度。除非 keepdim 为 True,否则输出 Tensor 的维度将比输入 Tensor 小一维,默认值为 False。 + - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 + - **correction** (int|float,可选) - 样本数量与样本自由度之间的差异。该参数为仅关键字参数,默认值为 1(贝塞尔校正)。若已设置 ``unbiased`` 为 True,则 ``correction`` 为 1,无需手动设置。 + - **out** (Tensor,可选)- 输出的结果。该参数为仅关键字参数,默认值为 None。 返回 :::::::::: diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.Tensor.std.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.Tensor.std.md deleted file mode 100644 index 5ea0d0ca2c4..00000000000 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.Tensor.std.md +++ /dev/null @@ -1,21 +0,0 @@ -## [ 仅参数名不一致 ]torch.Tensor.std -### [torch.Tensor.std](https://pytorch.org/docs/stable/generated/torch.Tensor.std.html?highlight=torch+tensor+std#torch.Tensor.std) -```python -torch.Tensor.std(dim=None, unbiased=True, keepdim=False, *, correction=1) -``` - -### [paddle.Tensor.std](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/Tensor_cn.html#std-axis-none-unbiased-true-keepdim-false-name-none) -```python -paddle.Tensor.std(axis=None, unbiased=True, keepdim=False, name=None) -``` - -两者功能一致,仅参数名不一致,具体如下: - -### 参数映射 - -| PyTorch | PaddlePaddle | 备注 | -| ---------- | ------------ | ------- | -| dim | axis | 指定对 Tensor 进行计算的轴,仅参数名不一致。 | -| unbiased | unbiased | torch v1.x 中 correction 参数名称,表示是否为无偏估计,从 v2.0 开始弃用。| -| correction | unbiased | 是否使用无偏估计来计算标准差。PyTorch 支持 int 类型,Paddle 支持 bool/int 类型。仅参数名不一致。| -| keepdim | keepdim | 是否在输出 Tensor 中保留减小的维度。 | diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.std.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.std.md deleted file mode 100644 index dd46e40f696..00000000000 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.std.md +++ /dev/null @@ -1,49 +0,0 @@ -## [ torch 参数更多 ]torch.std -### [torch.std](https://pytorch.org/docs/stable/generated/torch.std.html) -```python -torch.std(input, dim=None, unbiased=True, keepdim=False, *, correction=1, out=None) -``` - -### [paddle.std](https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/std_cn.html#std) -```python -paddle.std(x, axis=None, unbiased=True, keepdim=False, name=None) -``` - -PyTorch 相比 Paddle 支持更多其他参数,具体如下: - -### 参数映射 - -| PyTorch | PaddlePaddle | 备注 | -| ---------- | ------------ | -- | -| input | x | 输入张量,仅参数名不一致。 | -| dim | axis | 指定对 x 进行计算的轴,仅参数名不一致。 | -| unbiased | unbiased | 是否使用无偏估计来计算标准差。 | -| keepdim | keepdim | 是否在输出 Tensor 中保留减小的维度。 | -| correction | - | 样本尺寸与其自由度的差异,Paddle 无此参数,需要转写。 | -| out | - | 表示输出的 Tensor ,Paddle 无此参数,需要转写。 | - -### 转写示例 -#### correction -```python -# PyTorch -torch.std(x, dim, correction=0) - -# Paddle -paddle.std(x, dim, unbiased=False) - - -# PyTorch -torch.std(x, dim, correction=1) - -# Paddle -paddle.std(x, dim, unbiased=True) -``` - -#### out -```python -# PyTorch -torch.std(x, out=y) - -# Paddle -paddle.assign(paddle.std(x), y) -```