Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/api/paddle/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,7 @@ tensor 创建相关
" :ref:`paddle.eye <cn_api_paddle_eye>` ", "构建二维 Tensor(主对角线元素为 1,其他元素为 0)"
" :ref:`paddle.full <cn_api_paddle_full>` ", "创建形状大小为 shape 并且数据类型为 dtype 的 Tensor"
" :ref:`paddle.full_like <cn_api_paddle_full_like>` ", "创建一个和 x 具有相同的形状并且数据类型为 dtype 的 Tensor"
" :ref:`paddle.kaiser_window <cn_api_paddle_kaiser_window>` ", "计算 Kaiser 窗"
" :ref:`paddle.linspace <cn_api_paddle_linspace>` ", "返回一个 Tensor,Tensor 的值为在区间 start 和 stop 上均匀间隔的 num 个值,输出 Tensor 的长度为 num"
" :ref:`paddle.meshgrid <cn_api_paddle_meshgrid>` ", "对每个 Tensor 做扩充操作"
" :ref:`paddle.numel <cn_api_paddle_numel>` ", "返回一个长度为 1 并且元素值为输入 x 元素个数的 Tensor"
Expand Down Expand Up @@ -627,6 +628,7 @@ framework 相关
" :ref:`paddle.get_rng_state <cn_api_paddle_get_rng_state>` ", "获取指定设备的随机数生成器的所有随机状态。"
" :ref:`paddle.grad <cn_api_paddle_grad>` ", "对于每个 inputs ,计算所有 outputs 相对于其的梯度和"
" :ref:`paddle.in_dynamic_mode <cn_api_paddle_in_dynamic_mode>` ", "查看 paddle 当前是否在动态图模式中运行"
" :ref:`paddle.inference_mode <cn_api_paddle_inference_mode>` ", "创建启用或禁用推理模式的上下文"
" :ref:`paddle.LazyGuard <cn_api_paddle_LazyGuard>` ", "用于设置模型(继承自 ``paddle.nn.Layer`` ) 中参数延迟初始化的上下文管理器"
" :ref:`paddle.load <cn_api_paddle_load>` ", "从指定路径载入可以在 paddle 中使用的对象实例"
" :ref:`paddle.no_grad <cn_api_paddle_no_grad>` ", "创建一个上下文来禁用动态图梯度计算"
Expand Down
100 changes: 99 additions & 1 deletion docs/api/paddle/distribution/Distribution_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Distribution
-------------------------------

.. py:class:: paddle.distribution.Distribution()
.. py:class:: paddle.distribution.Distribution(batch_shape=(), event_shape=(), validate_args=None)

概率分布的抽象基类,在具体的分布中实现具体功能。

Expand All @@ -14,7 +14,55 @@ Distribution
布 ``batch_shape=param.shape[:-1]``,其中 param 表示分布参数,支持 broadcast 语义。
- **event_shape** - 多元概率分布维数形状。一元分布 ``event_shape=()``,多元分布
``event_shape=param.shape[-1:]``,其中 param 表示分布参数,支持 broadcast 语义。
- **validate_args** (bool|None,可选) - 是否启用参数校验。默认值为 None。

属性
:::::::::

arg_constraints
'''''''''

返回该概率分布参数需要满足的约束条件。

**返回**

dict,分布参数与其约束条件的映射。

support
'''''''''

返回表示该概率分布支持集的约束对象。

**返回**

Constraint|None,表示支持集的约束对象。

mean
'''''''''

概率分布的均值。

**返回**

Tensor,均值。

mode
'''''''''

概率分布的众数。

**返回**

Tensor,众数。

variance
'''''''''

概率分布的方差。

**返回**

Tensor,方差。

方法
:::::::::
Expand All @@ -37,6 +85,15 @@ rsample(shape=[])

- **shape** (Sequence[int],可选) - 重参数化采样的样本维度。

sample_n(n)
''''''''''

从分布中生成 ``n`` 个样本。

**参数**

- **n** (int) - 采样数量。

entropy()
'''''''''

Expand All @@ -51,6 +108,38 @@ log_prob(value)

- **value** (Tensor) - 输入 Tensor。

cdf(value)
''''''''''

计算 ``value`` 处的累计概率密度函数或累计概率质量函数值。

**参数**

- **value** (Tensor) - 输入 Tensor。

icdf(value)
''''''''''

计算 ``value`` 处的逆累计概率密度函数或逆累计概率质量函数值。

**参数**

- **value** (Tensor) - 输入 Tensor。

enumerate_support(expand=True)
''''''''''''''''''''''''''''''

返回离散概率分布支持集中的所有取值。

**参数**

- **expand** (bool,可选) - 是否扩展结果 Tensor。默认值为 True。

perplexity()
''''''''''''

返回该概率分布的困惑度。

probs(value)
'''''''''

Expand All @@ -68,3 +157,12 @@ kl_divergence(other)
**参数**

- **other** (Distribution) - Distribution 的实例。

set_default_validate_args(value)
''''''''''''''''''''''''''''''''

设置是否默认启用参数校验。

**参数**

- **value** (bool) - 是否默认启用参数校验。
13 changes: 12 additions & 1 deletion docs/api/paddle/distribution/MultivariateNormal_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
MultivariateNormal
-------------------------------

.. py:class:: paddle.distribution.MultivariateNormal(loc, covariance_matrix=None, precision_matrix=None, scale_tril=None)
.. py:class:: paddle.distribution.MultivariateNormal(loc, covariance_matrix=None, precision_matrix=None, scale_tril=None, validate_args=None)


MultivariateNormal 是一种定义在实数域上的多元连续型概率分布,参数 :attr:`loc` 表示均值,以及需要传入以下任意一种矩阵描述其方差:
Expand Down Expand Up @@ -33,6 +33,8 @@ MultivariateNormal 是一种定义在实数域上的多元连续型概率分布

- **scale_tril** (Tensor,可选) - 是 MultivariateNormal 协方差矩阵的柯列斯基分解的下三角矩阵。:attr:`scale_tril` 的数据类型会被转换为与 :attr:`loc` 相同的类型。默认值为 None。

- **validate_args** (bool|None,可选) - 是否对输入参数进行校验。默认值为 None。


代码示例
:::::::::
Expand Down Expand Up @@ -60,6 +62,15 @@ MultivariateNormal 分布的方差

Tensor,方差

mode
'''''''''

MultivariateNormal 分布的众数

**返回**

Tensor,众数

方法
:::::::::

Expand Down
3 changes: 2 additions & 1 deletion docs/api/paddle/distribution/Normal_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Normal
-------------------------------

.. py:class:: paddle.distribution.Normal(loc, scale, name=None)
.. py:class:: paddle.distribution.Normal(loc, scale, validate_args=None, name=None)


正态分布
Expand Down Expand Up @@ -35,6 +35,7 @@ Normal

- **loc** (int|float|complex|list|tuple|numpy.ndarray|Tensor) - 正态分布平均值。数据类型为 float32、float64、complex64 或 complex128。
- **scale** (int|float|list|tuple|numpy.ndarray|Tensor) - 正态分布标准差。数据类型为 float32 或 float64。
- **validate_args** (bool|None,可选) - 是否对输入参数进行校验。默认值为 None。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

代码示例
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/iinfo_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ iinfo

参数
:::::::::
- **dtype** (paddle.dtype|str) - 输入的数据类型,可以是:paddle.uint8、 paddle.int8、 paddle.int16、 paddle.int32、 paddle.int64 或这些类型的字符串形式。别名 ``type``。
- **dtype** (paddle.dtype|str) - 输入的数据类型,可以是:paddle.uint8、 paddle.uint16、 paddle.uint32、 paddle.uint64、 paddle.int8、 paddle.int16、 paddle.int32、 paddle.int64 或这些类型的字符串形式。别名 ``type``。

返回
:::::::::
Expand Down
24 changes: 24 additions & 0 deletions docs/api/paddle/inference_mode_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _cn_api_paddle_inference_mode:

inference_mode
-------------------------------

.. py:class:: paddle.inference_mode(mode=True)



创建一个上下文管理器或装饰器,用于启用或禁用推理模式。

在该模式下,每次计算的结果都将具有 ``stop_gradient=True``。当 ``mode=False`` 时,将启用梯度计算。

也可以用作一个装饰器。

参数
::::::::::::

- **mode** (bool,可选) - 是否启用推理模式。默认值为 True。

代码示例
::::::::::::

COPY-FROM: paddle.inference_mode
35 changes: 35 additions & 0 deletions docs/api/paddle/kaiser_window_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. _cn_api_paddle_kaiser_window:

kaiser_window
-------------------------------

.. py:function:: paddle.kaiser_window(window_length, periodic=True, beta=12.0, *, dtype='float32', layout=None, device=None, pin_memory=False, requires_grad=False, out=None)

计算 Kaiser 窗。

参数
::::::::::::

- **window_length** (int) - 返回窗的长度,必须为正数。
- **periodic** (bool,可选) - 若为 True,则返回适用于周期函数的窗;若为 False,则返回对称窗。默认值为 True。
- **beta** (float,可选) - 窗函数的形状参数。默认值为 12.0。

关键字参数
::::::::::::

- **dtype** (str,可选) - 返回 Tensor 的数据类型。默认值为 ``'float32'``。
- **layout** (str,可选) - 仅为与 PyTorch API 保持一致而保留,在 Paddle 中会被忽略。默认值为 None。
- **device** (PlaceLike|None,可选) - 返回 Tensor 所在的设备。若为 None,则使用当前设备。默认值为 None。
- **pin_memory** (bool,可选) - 是否将返回 Tensor 分配在锁页内存中,仅对 CPU Tensor 生效。默认值为 False。
- **requires_grad** (bool,可选) - 是否为返回 Tensor 记录自动求导。默认值为 False。
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::::

Tensor:形状为 ``(window_length,)`` 的一维 Tensor,包含 Kaiser 窗。

代码示例
::::::::::::

COPY-FROM: paddle.kaiser_window
10 changes: 9 additions & 1 deletion docs/api/paddle/nn/BatchNorm1D_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
BatchNorm1D
-------------------------------

.. py:class:: paddle.nn.BatchNorm1D(num_features, momentum=0.9, epsilon=1e-05, weight_attr=None, bias_attr=None, data_format='NCL', use_global_stats=None, name=None)
.. py:class:: paddle.nn.BatchNorm1D(num_features, momentum=0.9, epsilon=1e-05, weight_attr=None, bias_attr=None, data_format='NCL', use_global_stats=None, name=None, *, affine=True, device=None, dtype=None)


构建 ``BatchNorm1D`` 类的一个可调用对象,具体用法参照 ``代码示例``。可以处理 2D 或者 3D 的 Tensor,实现了批归一化层(Batch Normalization Layer)的功能,可用作卷积和全连接操作的批归一化函数,根据当前批次数据按通道计算的均值和方差进行归一化。更多详情请参考:`Batch Normalization: Accelerating Deep Network Training by Reducing Internal Covariate Shift <https://arxiv.org/pdf/1502.03167.pdf>`_
Expand Down Expand Up @@ -40,13 +40,21 @@ BatchNorm1D

- **num_features** (int) - 指明输入 ``Tensor`` 的通道数量。
- **epsilon** (float,可选) - 为了数值稳定加在分母上的值。默认值:1e-05。
``别名: eps``
- **momentum** (float,可选) - 此值用于计算 ``moving_mean`` 和 ``moving_var``。默认值:0.9。更新公式如上所示。
- **weight_attr** (ParamAttr|bool,可选) - 指定权重参数属性的对象。如果为 False,则表示每个通道的伸缩固定为 1,不可改变。默认值为 None,表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。
- **bias_attr** (ParamAttr|bool,可选) - 指定偏置参数属性的对象。如果为 False,则表示每一个通道的偏移固定为 0,不可改变。默认值为 None,表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。
- **data_format** (str,可选) - 指定输入数据格式,数据格式可以为 ``"NC"``、``"NCL"`` 或者 ``"NLC"``,其中 N 是批大小,C 是通道数,L 是特征长度。默认值为 ``"NCL"``。
- **use_global_stats** (bool|None,可选) – 指示是否使用全局均值和方差。若设置为 False,则使用一个 mini-batch 的统计数据。若设置为 True 时,将使用全局统计数据。若设置为 None,则会在测试阶段使用全局统计数据,在训练阶段使用一个 mini-batch 的统计数据。默认值为 None。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::

- **affine** (bool,可选) - 该模块是否具有可学习的仿射参数(weight 和 bias)。如果设置为 False,将不会创建可学习的参数,无论 ``weight_attr`` 和 ``bias_attr`` 如何设置。默认值:True。
- **device** (PlaceLike,可选) - 参数所在的设备。默认值为 None。
- **dtype** (DTypeLike,可选) - 参数的数据类型。默认值为 None。


返回
::::::::::::
Expand Down
10 changes: 9 additions & 1 deletion docs/api/paddle/nn/BatchNorm2D_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
BatchNorm2D
-------------------------------

.. py:class:: paddle.nn.BatchNorm2D(num_features, momentum=0.9, epsilon=1e-05, weight_attr=None, bias_attr=None, data_format='NCHW', use_global_stats=None, name=None)
.. py:class:: paddle.nn.BatchNorm2D(num_features, momentum=0.9, epsilon=1e-05, weight_attr=None, bias_attr=None, data_format='NCHW', use_global_stats=None, name=None, *, affine=True, device=None, dtype=None)


构建 ``BatchNorm2D`` 类的一个可调用对象,具体用法参照 ``代码示例``。可以处理 4D 的 Tensor,实现了批归一化层(Batch Normalization Layer)的功能,可用作卷积和全连接操作的批归一化函数,根据当前批次数据按通道计算的均值和方差进行归一化。更多详情请参考:`Batch Normalization: Accelerating Deep Network Training by Reducing Internal Covariate Shift <https://arxiv.org/pdf/1502.03167.pdf>`_
Expand Down Expand Up @@ -40,13 +40,21 @@ BatchNorm2D

- **num_features** (int) - 指明输入 ``Tensor`` 的通道数量。
- **epsilon** (float,可选) - 为了数值稳定加在分母上的值。默认值:1e-05。
``别名: eps``
- **momentum** (float,可选) - 此值用于计算 ``moving_mean`` 和 ``moving_var``。默认值:0.9。更新公式如上所示。
- **weight_attr** (ParamAttr|bool,可选) - 指定权重参数属性的对象。如果为 False,则表示每个通道的伸缩固定为 1,不可改变。默认值为 None,表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。
- **bias_attr** (ParamAttr|bool,可选) - 指定偏置参数属性的对象。如果为 False,则表示每一个通道的偏移固定为 0,不可改变。默认值为 None,表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。
- **data_format** (str,可选) - 指定输入数据格式,数据格式可以为 ``"NCHW"`` 或 ``"NHWC"``,其中 N 是批大小,C 是通道数,H 是特征高度,W 是特征宽度。默认值为 ``"NCHW"``。
- **use_global_stats** (bool|None,可选) – 指示是否使用全局均值和方差。若设置为 False,则使用一个 mini-batch 的统计数据。若设置为 True 时,将使用全局统计数据。若设置为 None,则会在测试阶段使用全局统计数据,在训练阶段使用一个 mini-batch 的统计数据。默认值为 None。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::

- **affine** (bool,可选) - 该模块是否具有可学习的仿射参数(weight 和 bias)。如果设置为 False,将不会创建可学习的参数,无论 ``weight_attr`` 和 ``bias_attr`` 如何设置。默认值:True。
- **device** (PlaceLike,可选) - 参数所在的设备。默认值为 None。
- **dtype** (DTypeLike,可选) - 参数的数据类型。默认值为 None。


返回
::::::::::::
Expand Down
10 changes: 9 additions & 1 deletion docs/api/paddle/nn/BatchNorm3D_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
BatchNorm3D
-------------------------------

.. py:class:: paddle.nn.BatchNorm3D(num_features, momentum=0.9, epsilon=1e-05, weight_attr=None, bias_attr=None, data_format='NCDHW', use_global_stats=None, name=None)
.. py:class:: paddle.nn.BatchNorm3D(num_features, momentum=0.9, epsilon=1e-05, weight_attr=None, bias_attr=None, data_format='NCDHW', use_global_stats=None, name=None, *, affine=True, device=None, dtype=None)


构建 ``BatchNorm3D`` 类的一个可调用对象,具体用法参照 ``代码示例``。可以处理 4D 的 Tensor,实现了批归一化层(Batch Normalization Layer)的功能,可用作卷积和全连接操作的批归一化函数,根据当前批次数据按通道计算的均值和方差进行归一化。更多详情请参考:`Batch Normalization: Accelerating Deep Network Training by Reducing Internal Covariate Shift <https://arxiv.org/pdf/1502.03167.pdf>`_
Expand Down Expand Up @@ -40,13 +40,21 @@ BatchNorm3D

- **num_features** (int) - 指明输入 ``Tensor`` 的通道数量。
- **epsilon** (float,可选) - 为了数值稳定加在分母上的值。默认值:1e-05。
``别名: eps``
- **momentum** (float,可选) - 此值用于计算 ``moving_mean`` 和 ``moving_var``。默认值:0.9。更新公式如上所示。
- **weight_attr** (ParamAttr|bool,可选) - 指定权重参数属性的对象。如果为 False,则表示每个通道的伸缩固定为 1,不可改变。默认值为 None,表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。
- **bias_attr** (ParamAttr|bool,可选) - 指定偏置参数属性的对象。如果为 False,则表示每一个通道的偏移固定为 0,不可改变。默认值为 None,表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。
- **data_format** (str,可选) - 指定输入数据格式,数据格式可以为 ``"NCDHW"`` 或 ``"NDHWC"``,其中 N 是批大小,C 是通道数,D 是特征深度,H 是特征高度,W 是特征宽度。默认值为 ``"NCDHW"``。
- **use_global_stats** (bool|None,可选) – 指示是否使用全局均值和方差。若设置为 False,则使用一个 mini-batch 的统计数据。若设置为 True 时,将使用全局统计数据。若设置为 None,则会在测试阶段使用全局统计数据,在训练阶段使用一个 mini-batch 的统计数据。默认值为 None。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::

- **affine** (bool,可选) - 该模块是否具有可学习的仿射参数(weight 和 bias)。如果设置为 False,将不会创建可学习的参数,无论 ``weight_attr`` 和 ``bias_attr`` 如何设置。默认值:True。
- **device** (PlaceLike,可选) - 参数所在的设备。默认值为 None。
- **dtype** (DTypeLike,可选) - 参数的数据类型。默认值为 None。


返回
::::::::::::
Expand Down
3 changes: 2 additions & 1 deletion docs/api/paddle/nn/Hardswish_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Hardswish
-------------------------------

.. py:class:: paddle.nn.Hardswish(name=None)
.. py:class:: paddle.nn.Hardswish(inplace=False, name=None)

Hardswish 激活函数。创建一个 ``Hardswish`` 类的可调用对象。在 MobileNetV3 架构中被提出,相较于 :ref:`cn_api_paddle_nn_Swish` 函数,具有数值稳定性好,计算速度快等优点,具体原理请参考:`Searching for MobileNetV3 <https://arxiv.org/pdf/1905.02244.pdf>`_ 。

Expand All @@ -22,6 +22,7 @@ Hardswish 激活函数。创建一个 ``Hardswish`` 类的可调用对象。在

参数
::::::::::
- **inplace** (bool,可选) - 是否使用 inplace 操作。默认值为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

形状
Expand Down
Loading