!30272 optimizes the documentation of chinese API of AllGather,Argmin,Cast,etc

Merge pull request !30272 from zhangfanghe/code_docs_zfh_20220219_ops2
2022-02-22 13:09:10 +00:00 · 2022-02-22 13:09:10 +00:00 · f891b0a906
parent 6edc6fccee 0690427dec
commit f891b0a906
18 changed files with 531 additions and 0 deletions
--- a/docs/api/api_python/ops/mindspore.ops.AllGather.rst
+++ b/docs/api/api_python/ops/mindspore.ops.AllGather.rst
@ -0,0 +1,26 @@
+mindspore.ops.AllGather
+========================
+
+.. py:class:: mindspore.ops.AllGather(group=GlobalComm.WORLD_COMM_GROUP)
+
+    在指定的通信组中汇聚Tensor。
+
+    .. note::
+        集合中所有进程的Tensor拥有相同的shape和格式。用户在使用之前需要设置环境变量，运行下面的例子。获取详情请点击官方网站 `MindSpore <https://www.mindspore.cn/docs/api/zh-CN/master/api_python/mindspore.ops.html#communication-operators>`_ 。
+
+    **参数：**
+
+    - **group** (str) - 工作的通信组，默认值："GlobalComm.WORLD_COMM_GROUP"（即Ascend平台为"hccl_world_group"，GPU平台为"nccl_world_group" ）。
+
+    **输入：**
+
+    - **input_x** (Tensor) - AllGather的输入，shape为 :math:`(x_1, x_2, ..., x_R)` 的Tensor。
+
+    **输出：**
+
+    Tensor，如果组中的device数量为N，则输出的shape为 :math:`(N, x_1, x_2, ..., x_R)` 。
+
+    **异常：**
+
+    - **TypeError** - `group` 不是str。
+    - **ValueError** - 调用进程的rank id大于本通信组的rank大小。
--- a/docs/api/api_python/ops/mindspore.ops.AllReduce.rst
+++ b/docs/api/api_python/ops/mindspore.ops.AllReduce.rst
@ -0,0 +1,27 @@
+mindspore.ops.AllReduce
+========================
+
+.. py:class:: mindspore.ops.AllReduce(op=ReduceOp.SUM, group=GlobalComm.WORLD_COMM_GROUP)
+
+    使用指定方式对通信组内的所有设备的Tensor数据进行规约操作，所有设备都得到相同的结果
+
+    .. note::
+        AllReduce操作暂不支持"prod"。集合中的所有进程的Tensor必须具有相同的shape和格式。用户在使用之前需要设置环境变量，运行下面的例子。获取详情请点击官方网站 `MindSpore <https://www.mindspore.cn/docs/api/zh-CN/master/api_python/mindspore.ops.html#communication-operators>`_ 。
+
+    **参数：**
+
+    - **op** (str) - 规约的具体操作，如sum、max、和min。默认值：ReduceOp.SUM。
+    - **group** (str) - 工作的通信组。默认值："GlobalComm.WORLD_COMM_GROUP"（即Ascend平台为"hccl_world_group"，GPU平台为"nccl_world_group" ）。
+
+    **输入：**
+
+    - **input_x** (Tensor) - shape为 :math:`(x_1, x_2, ..., x_R)` 的Tensor。
+
+    **输出：**
+
+    Tensor，shape与输入相同，即 :math:`(x_1, x_2, ..., x_R)` 。其内容取决于操作。
+
+    **异常：**
+
+    - **TypeError** - `op` 或 `group` 不是str，或者输入的数据类型是bool。
+    - **ValueError** - `op` 为"prod"。
--- a/docs/api/api_python/ops/mindspore.ops.ArgMaxWithValue.rst
+++ b/docs/api/api_python/ops/mindspore.ops.ArgMaxWithValue.rst
@ -0,0 +1,35 @@
+mindspore.ops.ArgMaxWithValue
+==============================
+
+.. py:class:: mindspore.ops.ArgMaxWithValue(axis=0, keep_dims=False)
+
+    根据指定的索引计算最大值，并返回索引和值。
+
+    在给定轴上计算输入Tensor的最大值，并且返回最大值和索引。
+
+    .. note::
+        在auto_parallel和semi_auto_parallel模式下，不能使用第一个输出索引。
+
+    .. warning::
+        - 如果有多个最大值，则取第一个最大值的索引。
+        - "axis"的取值范围为[-dims, dims - 1]。"dims"为"input_x"的维度长度。
+
+    **参数：**
+
+    - **axis** (int) - 指定计算维度。默认值：0。
+    - **keep_dims** (bool) - 表示是否减少维度，如果为True，输出将与输入保持相同的维度；如果为False，输出将减少维度。默认值：False。
+
+    **输入：**
+
+    - **input_x** (Tensor) - 输入任意维度的Tensor。将输入Tensor的shape设为 :math: `(x_1, x_2, ..., x_N)` 。数据类型为mindspore.float16或float32。
+
+    **输出：**
+
+    tuple (Tensor)，表示2个Tensor组成的tuple，包含对应的索引和输入Tensor的最大值。
+	- **index** (Tensor) - 输入Tensor最大值的索引。如果 `keep_dims` 为true，则输出Tensor的shape为 :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)` 。否则，shape为 :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` 。
+	- **output_x** (Tensor) - 输入Tensor的最大值，其shape与索引相同。
+
+    **异常：**
+
+    - **TypeError** - `keep_dims` 不是bool。
+    - **TypeError** - `axis` 不是int。
--- a/docs/api/api_python/ops/mindspore.ops.ArgMinWithValue.rst
+++ b/docs/api/api_python/ops/mindspore.ops.ArgMinWithValue.rst
@ -0,0 +1,35 @@
+mindspore.ops.ArgMinWithValue
+==============================
+
+.. py:class:: mindspore.ops.ArgMinWithValue(axis=0, keep_dims=False)
+
+    根据指定的索引计算最小值，并返回索引和值。
+
+    在给定轴上计算输入Tensor的最小值，并且返回最小值和索引。
+
+    .. note::
+        在auto_parallel和semi_auto_parallel模式下，不能使用第一个输出索引。
+
+    .. warning::
+        - 如果有多个最小值，则取第一个最小值的索引。
+        - "axis"的取值范围为[-dims, dims - 1]。"dims"为"input_x"的维度长度。
+
+    **参数：**
+    
+    - **axis** (int) - 指定计算维度。默认值：0。
+    - **keep_dims** (bool) - 表示是否减少维度。如果为True，则输出维度和输入维度相同。如果为False，则减少输出维度。默认值：False。
+
+    **输入：**
+
+    - **input_x** (Tensor) - 输入任意维度的Tensor。将输入Tensor的shape设为 :math:`(x_1, x_2, ..., x_N)` 。
+
+    **输出：**
+
+    tuple(Tensor)，表示2个Tensor组成的tuple，包含对应的索引和输入Tensor的最小值。
+	- **index** (Tensor) - 输入Tensor最小值的索引。如果 `keep_dims` 为True，则输出Tensor的shape为 :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)` 。否则，shape为 :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` 。
+	- **output_x** (Tensor) - 输入Tensor的最小值，其shape与索引相同。
+
+    **异常：**
+
+    - **TypeError** - `keep_dims` 不是bool。
+    - **TypeError** - `axis` 不是int。
--- a/docs/api/api_python/ops/mindspore.ops.Argmax.rst
+++ b/docs/api/api_python/ops/mindspore.ops.Argmax.rst
@ -0,0 +1,30 @@
+mindspore.ops.Argmax
+=====================
+
+.. py:class:: mindspore.ops.Argmax(axis=-1, output_type=mstype.int32)
+
+    返回输入Tensor在指定轴上的最大值索引。
+
+    如果输入Tensor的shape为 :math:`(x_1, ..., x_N)` ，则输出Tensor的shape为 :math:`(x_1, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` 。
+
+    **参数：**
+
+    - **axis** (int) - 指定Argmax计算轴。默认值：-1。
+    - **output_type** (:class:`mindspore.dtype`) - 指定输出数据类型。默认值： `mindspore.dtype.int32` 。
+
+    **输入：**
+    
+    - **input_x** (Tensor)：Argmax的输入，任意维度的Tensor。支持的数据类型如下所示：
+
+      - Ascend：Float16和Float32。
+      - GPU：Float16和Float32。
+      - CPU：Float16、Float32和Float64。
+
+    **输出：**
+
+    Tensor，输出为指定轴上输入Tensor最大值的索引。
+
+    **异常：**
+
+    - **TypeError** - `axis` 不是int。
+    - **TypeError** - `output_type` 既不是int32也不是int64。
--- a/docs/api/api_python/ops/mindspore.ops.Argmin.rst
+++ b/docs/api/api_python/ops/mindspore.ops.Argmin.rst
@ -0,0 +1,26 @@
+mindspore.ops.Argmin
+=====================
+
+.. py:class:: mindspore.ops.Argmin(axis=-1, output_type=mstype.int32)
+
+    返回输入Tensor在指定轴上的最小值索引。
+
+    如果输入Tensor的shape为 :math:`(x_1, ..., x_N)` ，则输出Tensor的shape为 :math:`(x_1, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` 。
+
+    **参数：**
+
+    - **axis** (int) - 指定Argmin计算轴。默认值：-1。
+    - **output_type** (:class:`mindspore.dtype`) - 指定输出数据类型。默认值： `mindspore.dtype.int32` 。
+
+    **输入：**
+
+    - **input_x** (Tensor) - Argmin的输入，任意维度的Tensor。
+
+    **输出：**
+
+    Tensor，输出为指定轴上输入Tensor最小值的索引。
+
+    **异常：**
+
+    - **TypeError** - `axis` 不是int。
+    - **TypeError** - `output_type` 既不是int32也不是int64。
--- a/docs/api/api_python/ops/mindspore.ops.AvgPool3D.rst
+++ b/docs/api/api_python/ops/mindspore.ops.AvgPool3D.rst
@ -0,0 +1,55 @@
+mindspore.ops.AvgPool3D
+========================
+
+.. py:class:: mindspore.ops.AvgPool3D(kernel_size=1, strides=1, pad_mode="valid", pad=0, ceil_mode=False,
+                 count_include_pad=True, divisor_override=0, data_format="NCDHW")
+
+    对输入的多维数据进行三维的平均池化运算。
+
+    一般，输入shape为 :math:`(N, C, D_{in}, H_{in}, W_{in})` ，AvgPool3D在 :math:`(D_{in}, H_{in}, W_{in})` 维度上输出区域平均值。给定 `kernel_size` 为 :math:`(kD,kH,kW)` 和 `stride` ，运算如下：
+
+    .. warning::
+        "kernel_size"在[1, 255]范围中。"strides"在[1, 63]范围中。
+
+    .. math::
+        \text{output}(N_i, C_j, d, h, w) =
+        \frac{1}{kD * kH * kW} \sum_{l=0}^{kD-1} \sum_{m=0}^{kH-1} \sum_{n=0}^{kW-1}
+        \text{input}(N_i, C_j, stride[0] \times d + l, stride[1] \times h + m, stride[2] \times w + n)
+
+    **参数：**
+
+    - **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小，是一个整数，表示深度、高度和宽度，或者是含3个分别表示深度、高度和宽度整数的tuple。默认值：1。
+    - **strides** (Union[int, tuple[int]]) - 池化操作的移动步长，是一个整数，表示移动深度、高度和宽度，或者是含3个分别表示移动深度、高度和宽度整数的tuple。默认值：1。
+    - **pad_mode** (str) - 指定池化填充模式，可选值有："SAME"、"VALID"或"PAD"。默认值："VALID"。
+
+      - **same** - 输出的深度、高度和宽度分别与输入整除 `stride` 后的值相同。
+      - **valid** - 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。
+      - **pad** - 对输入进行填充。 在输入的深度、高度和宽度方向上填充 `pad` 大小的0。如果设置此模式， `pad` 必须大于或等于0。
+
+    - **pad** (Union(int, tuple[int])) - 池化填充方式。默认值：0。如果 `pad` 是一个整数，则头部、尾部、顶部、底部、左边和右边的填充都是相同的，等于pad。如果 `pad` 是六个integer的tuple，则头部、尾部、顶部、底部、左边和右边的填充分别等于填充pad[0]、pad[1]、pad[2]、pad[3]、pad[4]和pad[5]。
+    - **ceil_mode** (bool) - 是否使用ceil函数计算输出高度和宽度。默认值：False。
+    - **count_include_pad** (bool) - 如果为True，平均计算将包括零填充。默认值：True。
+    - **divisor_override** (int) - 如果指定了该值，它将在平均计算中用作除数，否则将使用kernel_size作为除数。默认值：0。
+    - **data_format** (str) - 输入和输出的数据格式。。目前仅支持'NCDHW'。默认值：'NCDHW'。
+
+    **输入：**
+
+    - **x** (Tensor) - shape为 :math:`(N, C, D_{in}, H_{in}, W_{in})` 的Tensor。数据类型为float16和float32。
+
+    **输出：**
+
+    Tensor，其shape为 :math:`(N, C, D_{out}, H_{out}, W_{out})` ，数据类型与 `x` 相同。
+
+    **异常：**
+
+    - **TypeError** - `kernel_size` 、 `strides` 或 `pad` 既不是int也不是tuple。
+    - **TypeError** - `ceil_mode` 或 `count_include_pad` 不是bool。
+    - **TypeError** - `pad_mode` 或`data_format` 不是string。
+    - **TypeError** - `divisor_override` 不是int。
+    - **ValueError** - `kernel_size` 或 `strides` 中的数字不是正数。
+    - **ValueError** - `kernel_size` 或 `strides` 是长度不等于3的tuple。
+    - **ValueError** - `pad_mode` 不是'same'，'valid'，或'pad'。
+    - **ValueError** - `pad` 是长度不等于6的tuple。
+    - **ValueError** - `pad` 的元素小于0。
+    - **ValueError** - `pad_mode` 不等于'pad'且`pad`不等于0或(0, 0, 0, 0, 0, 0)。
+    - **ValueError** - `data_format` 不是'NCDHW'。
--- a/docs/api/api_python/ops/mindspore.ops.Broadcast.rst
+++ b/docs/api/api_python/ops/mindspore.ops.Broadcast.rst
@ -0,0 +1,26 @@
+mindspore.ops.Broadcast
+========================
+
+.. py:class:: mindspore.ops.Broadcast(root_rank, group=GlobalComm.WORLD_COMM_GROUP)
+
+    对输入数据整租广播。
+
+    .. note::
+        集合中的所有进程的Tensor的shape和数据格式相同。
+
+    **参数：**
+
+    - **root_rank** (int) - 表示源秩。除发送数据的进程外，存在于所有进程中。
+    - **group** (str) - 表示通信域。默认值："hccl_world_group"。
+
+    **输入：**
+
+    - **input_x** (Tensor) - Tensor的shape为 :math:`(x_1, x_2, ..., x_R)` 。
+
+    **输出：**
+
+    Tensor，shape与输入相同，即 :math:`(x_1, x_2, ..., x_R)` 。内容取决于 `root_rank` device的数据。
+
+    **异常：**
+
+    - **TypeError** - root_rank不是整数或group不是字符串。
--- a/docs/api/api_python/ops/mindspore.ops.BroadcastTo.rst
+++ b/docs/api/api_python/ops/mindspore.ops.BroadcastTo.rst
@ -0,0 +1,27 @@
+mindspore.ops.BroadcastTo
+==========================
+
+.. py:class:: mindspore.ops.BroadcastTo(shape)
+
+    对输入Tensor广播到指定shape。
+
+    将输入shape广播到目标shape。如果目标shape中有-1的维度，它将被该维度中的输入shape的值替换。
+
+    当输入shape广播到目标shape时，它从最后一个维度开始。如果目标shape中有-1的维度，则-1维度不能位于一个不存在的维度中。
+
+    **参数：**
+
+    - **shape** (tuple) - 指定广播的目标shape。
+
+    **输入：**
+
+    - **input_x** (Tensor) - BroadcastTo输入，任意维度的Tensor，数据类型为float16、float32、int32、int8、uint8、bool。
+
+    **输出：**
+
+    Tensor，与目标 `shape` 相同，数据类型与 `input_x` 相同。
+
+    **异常：**
+
+    - **TypeError** - `shape` 不是tuple。
+    - **ValueError** - 目标shape和输入shape不兼容，或者目标shape中的-1维度位于一个无效位置。
--- a/docs/api/api_python/ops/mindspore.ops.Cast.rst
+++ b/docs/api/api_python/ops/mindspore.ops.Cast.rst
@ -0,0 +1,20 @@
+mindspore.ops.Cast
+===================
+
+.. py:class:: mindspore.ops.Cast
+
+    返回指定新数据类型后的Tensor
+
+    **输入：**
+    
+    - **input_x** (Union[Tensor, Number]) - 输入要进行数据类型转换的Tensor，其shape为 :math:`(x_1, x_2, ..., x_R)` 。
+    - **type** (dtype.Number) - 指定转换的数据类型。仅支持常量值。
+
+    **输出：**
+    
+    Tensor，其shape与 `input_x` 相同，即 :math:`(x_1, x_2, ..., x_R)` 。
+
+    **异常：**
+    
+    - **TypeError** - `input_x` 既不是Tensor也不是Number。
+    - **TypeError** - `type` 不是Number。
--- a/docs/api/api_python/ops/mindspore.ops.Ceil.rst
+++ b/docs/api/api_python/ops/mindspore.ops.Ceil.rst
@ -0,0 +1,22 @@
+mindspore.ops.Ceil
+===================
+
+.. py:class:: mindspore.ops.Ceil
+
+    向上取整函数。
+
+    .. math::
+        out_i = \lceil x_i \rceil = \lfloor x_i \rfloor + 1
+
+    **输入：**
+
+    - **x** (Tensor) - Ceil的输入，任意维度的Tensor，秩应小于8。其数据类型为float16或float32。
+
+    **输出：**
+
+    Tensor，shape与 `x` 相同。
+
+    **异常：**
+
+    - **TypeError** - `x` 的不是Tensor。
+    - **TypeError** - `x` 的数据类型既不是float16也不是float32。
--- a/docs/api/api_python/ops/mindspore.ops.ComputeAccidentalHits.rst
+++ b/docs/api/api_python/ops/mindspore.ops.ComputeAccidentalHits.rst
@ -0,0 +1,31 @@
+mindspore.ops.ComputeAccidentalHits
+=====================================
+
+.. py:class:: mindspore.ops.ComputeAccidentalHits(num_true=1)
+
+    计算与候选抽样目标类匹配的位置id。
+
+    当目标类与样本类匹配时，我们称之为"accidental hit"。accidental hit的计算结果包含三部分(index、id、weight)，其中index代表目标类中的行号，id代表候选抽样中的位置，weight为FLOAT_MAX。FLOAT_MAX表示Float类型中的最大值。
+
+    **参数：**
+
+    num_true (int)：每个训练样本的目标类数。默认值：1。
+
+    **输入：**
+
+    - **true_classes** (Tensor) - 目标类。数据类型为int32或int64，shape为 :math:`(batch\_size, num\_true)` 。
+    - **sampled_candidates** (Tensor) - 指定算子的候选采样结果，代表训练样本的类型。其数据类型为int32或int64，shape为 :math: `(num\_sampled, )` 。
+
+    **输出：**
+
+    3个Tensor组成的元组。
+
+    - **indices** (Tensor) - shape为 :math:`(num\_accidental\_hits, )` 的Tensor，具有与 `true_classes` 相同的类型。
+    - **ids** (Tensor) - shape为 :math:`(num\_accidental\_hits, )` 的Tensor，具有与 `true_classes` 相同的类型。
+    - **weights** (Tensor) - shape为 :math:`(num\_accidental\_hits, )` 的Tensor，类型为float32。
+
+    **异常：**
+
+    - **TypeError** - `num_true` 的数据类型不为int。
+    - **TypeError** - `true_classes` 或 `sampled_candidates` 不是Tensor。
+    - **TypeError** - `true_classes` 或 `sampled_candidates` 的数据类型既不是int32也不是int64。
--- a/docs/api/api_python/ops/mindspore.ops.Concat.rst
+++ b/docs/api/api_python/ops/mindspore.ops.Concat.rst
@ -0,0 +1,30 @@
+mindspore.ops.Concat
+=====================
+
+.. py:class:: mindspore.ops.Concat(axis=0)
+
+    在指定轴上拼接输入Tensor。
+
+    输入的是一个tuple。其元素秩相同，即 `R` 。将给定的轴设为 `m` ，并且 :math:`0 \le m < R` 。数量设为 `N` 。对于第 :math:`i` 个数据， :math:`t_i` 的shape为 `(x_1, x_2, ..., x_{mi}, ..., x_R)` 。 :math:`x_{mi}` 是第 :math:`i` 个元素的第 :math:`m` 个维度。然后，输出tensor的shape为：
+
+    .. math::
+        (x_1, x_2, ..., \sum_{i=1}^Nx_{mi}, ..., x_R)
+
+    .. note::
+        "axis"的取值范围为[-dims, dims - 1]。"dims"为"input_x"的维度长度。
+
+    **参数：**
+
+    - **axis** (int) - 表示指定的轴。默认值：0。
+
+    **输入：**
+
+    - **input_x** (tuple, list) - 输入为Tensor tuple或Tensor list。假设在这个tuple或list中有两个Tensor，即x1和x2。要在0轴方向上执行 `Concat` ，除0轴外，所有其他轴都应相等，即 :math:`x1.shape[1] == x2.shape[1]，x1.shape[2] == x2.shape[2]，...，x1.shape[R] == x2.shape[R]` ，其中 :math:`R` 表示最后一个轴。
+
+    **输出：**
+
+    Tensor，shape为 :math:`(x_1, x_2, ..., \sum_{i=1}^Nx_{mi}, ..., x_R)` 。数据类型与 `input_x` 相同。
+
+    **异常：**
+
+    - **TypeError** - `axis` 不是int。
--- a/docs/api/api_python/ops/mindspore.ops.CumSum.rst
+++ b/docs/api/api_python/ops/mindspore.ops.CumSum.rst
@ -0,0 +1,28 @@
+mindspore.ops.CumSum
+=====================
+
+.. py:class:: mindspore.ops.CumSum(exclusive=False, reverse=False)
+
+    在指定轴上计算输入Tensor的累加和。
+
+    .. math::
+        y_i = x_1 + x_2 + x_3 + ...+ x_i
+
+    **参数：**
+
+    - **exclusive** (bool) - 如果为True，则执行独占模式。默认值：False。
+    - **reverse** (bool) - 如果为True，则逆向计算累加和。默认值：False。
+
+    **输入：**
+
+    - **input** (Tensor) - 输入要计算的Tensor。
+    - **axis** (int) - 指定要累加和的轴。仅支持常量值。该值在[-rank(input), rank(input))范围中。
+
+    **输出：**
+
+    Tensor。输出Tensor的shape与输入Tensor的shape一致。
+
+    **异常：**
+
+    - **TypeError** - `exclusive` 或 `reverse` 不是bool。
+    - **TypeError** - `axis` 不是int。
--- a/docs/api/api_python/ops/mindspore.ops.Dropout.rst
+++ b/docs/api/api_python/ops/mindspore.ops.Dropout.rst
@ -0,0 +1,28 @@
+mindspore.ops.Dropout
+======================
+
+.. py:class:: mindspore.ops.Dropout(keep_prob=0.5, Seed0=0, Seed1=0)
+
+     Dropout是一种正则化手段，该算子根据丢弃概率 :math:`1 - keep\_prob` ，在训练过程中随机将一些神经元输出设置为0，通过阻止神经元节点间的相关性来减少过拟合。
+
+    **参数：**
+
+    - **keep_prob** (float) - 输入神经元保留率，数值范围在0到1之间。例如，rate=0.9，删除10%的输入单位。默认值：0.5。
+    - **Seed0** (int) - 算子层的随机种子，用于生成随机数。默认值：0。
+    - **Seed1** (int) - 全局的随机种子，和算子层的随机种子共同决定最终生成的随机数。默认值：0。
+
+    **输入：**
+
+    - **x** (Tensor) -  Dropout的输入，任意维度的Tensor，其数据类型为float16或float32。
+
+    **输出：**
+
+    - **output** (Tensor) - shape和数据类型与 `x` 相同。
+    - **mask** (Tensor) - shape与 `x` 相同。
+
+    **异常：**
+
+    - **TypeError** - `keep_prob` 不是float。
+    - **TypeError** - `Seed0` 或`Seed1` 不是int。
+    - **TypeError** - `x` 的数据类型既不是float16也不是float32。
+    - **TypeError** - `x` 不是Tensor。
--- a/docs/api/api_python/ops/mindspore.ops.Dropout3D.rst
+++ b/docs/api/api_python/ops/mindspore.ops.Dropout3D.rst
@ -0,0 +1,30 @@
+mindspore.ops.Dropout3D
+========================
+
+.. py:class:: mindspore.ops.Dropout3D(keep_prob=0.5)
+
+    随机丢弃层。
+
+    Dropout是一种正则化手段，该算子根据丢弃概率 :math:`1 - keep\_prob` ，在训练过程中随机将一些神经元输出设置为0，通过阻止神经元节点间的相关性来减少过拟合，在推理过程中，此层返回与 `x` 相同的Tensor。对于shape为NCDHW的五维Tensor，通道特征图指的是shape为DHW的三维特征图。
+
+    例如，输入的批数据中第 :math:`i_th` 个样本的第 :math:`j_th` 个通道，则可三维Tensor input[i,j,k]。
+
+    Dropout3D可以提高通feature map之间的独立性。
+
+    **参数：**
+
+    keep_prob (float)：输入通道保留率，数值范围在0到1之间，例如 `keep_prob` = 0.8，意味着过滤20%的通道。默认值：0.5。
+
+    **输入：**
+
+    - **x** (Tensor) - shape为 :math:`(N, C, D, H, W)` 的五维Tensor。N代表批次大小，C代表管道，D代表特征深度，H代表特征高度，W代表特征宽度。数据类型为int8、int16、int32、int64、float16或float32。
+
+    **输出：**
+
+    - **output** (Tensor) - shape和数据类型与 `x` 相同。
+    - **mask** (Tensor) - shape与 `x` 相同，数据类型为bool。
+
+    **异常：**
+
+    - **TypeError** - `keep_prob` 的数据类型不是float。
+    - **ValueError** - `keep_prob` 超出[0.0, 1.0]范围，或者输入的维度不是5。
--- a/docs/api/api_python/ops/mindspore.ops.EmbeddingLookup.rst
+++ b/docs/api/api_python/ops/mindspore.ops.EmbeddingLookup.rst
@ -0,0 +1,23 @@
+mindspore.ops.EmbeddingLookup
+===============================
+
+.. py:class:: mindspore.ops.EmbeddingLookup
+
+    根据指定的索引，返回输入Tensor的切片。
+
+    此算子在 `axis = 0` 上的运行与GatherV2的功能相似，只是多一个输入： `offset` 参数。
+    
+    **输入：**
+
+    - **input_params** (Tensor) - shape为 :math: `(x_1, x_2, ..., x_R)` 的Tensor。是一个Tensor切片。当前，只支持二维。
+    - **input_indices** (Tensor) - shape为 :math: `(y_1, y_2, ..., y_S)` 的Tensor。指定输入Tensor元素的索引。当取值超出  `input_params` 的范围时，超出部分在输出时填充为0。不支持负值，如果为负值，则结果未定义。其数据类型为int32或int64。
+    - **offset** (int) - 指定此 `input_params` 切片的偏移值。因此，实际索引等于 `input_indices` 减去 `offset` 。
+          
+    **输出：**
+
+    Tensor，shape为 :math:`(z_1, z_2, ..., z_N)` 的Tensor。数据类型与 `input_params` 相同。
+
+    **异常：**
+
+    - **TypeError** - `input_indices` 的数据类型不是int。
+    - **ValueError** - `input_params` 的shape长度大于2。
--- a/docs/api/api_python/ops/mindspore.ops.Equal.rst
+++ b/docs/api/api_python/ops/mindspore.ops.Equal.rst
@ -0,0 +1,32 @@
+mindspore.ops.Equal
+====================
+
+.. py:class:: mindspore.ops.Equal
+
+    逐元素比较两个输入Tensor是否相等。
+
+    .. note::
+        - 输入 `x` 和 `y` 遵循隐式类型转换规则，使数据类型保持一致。
+        - 输入必须是两个Tensor，或一个Tensor和一个Scalar。
+        - 当输入是两个Tensor时，它们的shape可以广播。
+        - 当输入是一个Tensor和一个Scalar时，Scalar只能是一个常数。
+        - 支持广播。
+
+    .. math::
+        out_{i} =\begin{cases}
+            & \text{True,    if } x_{i} = y_{i} \\
+            & \text{False,   if } x_{i} \ne y_{i}
+            \end{cases}
+
+    **输入：**
+
+    - **x** (Union[Tensor, Number]) - 第一个输入可以是Number，也可以是数据类型为Number的Tensor。
+    - **y** (Union[Tensor, Number]) - 当第一个输入是Tensor时，第二个输入是Number或数据类型为Number的Tensor。数据类型与第一个输入相同。
+
+    **输出：**
+
+    Tensor，输出的shape与输入广播后的shape相同，数据类型为bool。
+
+    **异常：**
+
+    - **TypeError** - `x` 和 `y` 都不是Tensor。