!42405 add api cn docs

Merge pull request !42405 from 李林杰/code_docs_0920_add_cn_docs_master
This commit is contained in:
i-robot 2022-09-21 06:42:34 +00:00 committed by Gitee
commit 21b342b5fa
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
3 changed files with 102 additions and 0 deletions

View File

@ -0,0 +1,49 @@
mindspore.ops.AdamWeightDecay
=============================
.. py:class:: mindspore.ops.AdamWeightDecay(use_locking=False)
通过具有权重衰减的自适应矩估计算法AdamWeightDecay更新梯度。
Adam算法在 `Adam随机优化方法 <https://arxiv.org/abs/1412.6980>`_ 中提出。
AdamWeightDecay是Adam算法的变体`解耦权重衰变正则化 <https://arxiv.org/abs/1711.05101>`_ 中提出的。
更新公式如下:
.. math::
\begin{array}{ll} \\
m = \beta_1 * m + (1 - \beta_1) * g \\
v = \beta_2 * v + (1 - \beta_2) * g * g \\
update = \frac{m}{\sqrt{v} + \epsilon} \\
update =
\begin{cases}
update + weight\_decay * w
& \text{ if } weight\_decay > 0 \\
update
& \text{ otherwise }
\end{cases} \\
w = w - lr * update
\end{array}
:math:`m` 代表第一个矩向量,:math:`v` 代表第二个矩向量,:math:`g` 代表 `gradient` :math:`\beta_1\beta_2` 代表 `beta1``beta2` :math:`lr` 代表 `learning_rate` :math:`w` 代表 `var` :math:`decay` 代表 `weight_decay` :math:`\epsilon` 代表 `epsilon`
参数:
- **use_locking** (bool) - 是否对参数更新加锁保护。如果为True`var``m``v` 张量的更新将受到锁的保护。如果为False则结果不可预测。默认值False。
输入:
- **var** (Parameter) - 需要更新的权重。shape为 :math:`(N,*)` 其中 :math:`*` 表示任何数量的附加维度数据类型可以是float16或float32。
- **m** (Parameter) - 更新公式中的第一个动量矩阵它的shape应该和 `var` 一致数据类型可以是float16或float32。
- **v** (Parameter) - 更新公式中的第二个动量矩阵shape和数据类型与 `m` 相同。
- **lr** (float) - 更新公式中的 :math:`l` 。其论文建议值为 :math:`10^{-8}` 数据类型应为float32。
- **beta1** (float) - 第一个动量矩阵的指数衰减率数据类型应为float32。论文建议的值是 :math:`0.9`
- **beta2** (float) - 第二个动量矩阵的指数衰减率数据类型应为float32。论文建议的值是 :math:`0.999`
- **epsilon** (float) - 添加到分母中的值以提高数值稳定性数据类型应为float32。
- **decay** (float) - 权重衰减值必须是具有float32数据类型的标量张量。默认值0.0。
- **gradient** (Tensor) - 梯度shape和数据类型与 `var` 相同。
输出:
3个张量的Tuple为更新后的参数。
- **var** (Tensor) - 具有与 `var` 相同的shape和数据类型。
- **m** (Tensor) - 具有与 `m` 相同的shape和数据类型。
- **v** (Tensor) - 具有与 `v` 相同的shape和数据类型。

View File

@ -0,0 +1,27 @@
mindspore.ops.logical_and
==========================
.. py:function:: mindspore.ops.logical_and(x, y)
逐元素计算两个Tensor的逻辑与运算。
`x``y` 的输入遵循隐式类型转换规则,使数据类型一致。
输入必须是两个Tensor或一个Tensor和一个bool。
当输入是两个Tensor时它们的shape可以广播数据类型必须都是bool。
当输入是一个Tensor和一个bool时bool对象只能是一个常量Tensor的数据类型必须是bool。
.. math::
out_{i} = x_{i} \wedge y_{i}
.. note::
logical_and支持广播。
参数:
- **x** (Union[Tensor, bool]) - 第一个输入是bool或数据类型为bool的Tensor。
- **y** (Union[Tensor, bool]) - 当第一个输入是Tensor的时候第二个输入是bool或者数据类型为bool的Tensor。
返回:
Tensor形状与广播后的shape相同数据类型为bool。
异常:
- **TypeError** - 如果 `x``y` 都不是Tensor。

View File

@ -0,0 +1,26 @@
mindspore.ops.logical_or
==============================
.. py:function:: mindspore.ops.logical_or(x, y)
逐元素计算两个Tensor的逻辑或运算。
`x``y` 的输入遵循隐式类型转换规则,使数据类型一致。
输入必须是两个Tensor或一个Tensor和一个bool。
当输入是两个Tensor时它们的shape可以广播数据类型必须是bool。
当输入是一个Tensor和一个bool时bool对象只能是一个常量Tensor的数据类型必须是bool。
.. math::
out_{i} = x_{i} \vee y_{i}
.. note::
logical_or支持广播。
参数:
- **x** (Union[Tensor, bool]) - 第一个输入是bool或数据类型为bool的Tensor。
- **y** (Union[Tensor, bool]) - 当第一个输入是Tensor的时候第二个输入是bool或者数据类型为bool的Tensor。
返回:
Tensor形状与广播后的shape相同数据类型为bool。
异常:
- **TypeError** - 如果 `x``y` 都不是Tensor。