From 797c7484a1600c9aef5542254d658ee022d06959 Mon Sep 17 00:00:00 2001 From: huodagu Date: Sat, 28 May 2022 15:47:13 +0800 Subject: [PATCH] modify format --- .../api/api_python/nn/mindspore.nn.BiDense.rst | 2 +- .../ops/mindspore.ops.ApplyProximalAdagrad.rst | 1 + .../api_python/ops/mindspore.ops.Conv3D.rst | 13 ++++++------- .../ops/mindspore.ops.Conv3DTranspose.rst | 18 ++++++++---------- .../api_python/ops/mindspore.ops.CumProd.rst | 2 +- .../api_python/ops/mindspore.ops.Depend.rst | 2 ++ .../api_python/ops/mindspore.ops.IndexAdd.rst | 6 ++---- .../api/api_python/ops/mindspore.ops.Pdist.rst | 5 ++--- .../api_python/ops/mindspore.ops.Randperm.rst | 2 +- .../ops/mindspore.ops.func_pdist.rst | 12 +++++------- ...e.nn.probability.bnn_layers.ConvReparam.rst | 6 +++--- .../api_python_en/mindspore.ops.functional.rst | 2 +- 12 files changed, 33 insertions(+), 38 deletions(-) diff --git a/docs/api/api_python/nn/mindspore.nn.BiDense.rst b/docs/api/api_python/nn/mindspore.nn.BiDense.rst index 4b148913b03..3c68c431fcd 100644 --- a/docs/api/api_python/nn/mindspore.nn.BiDense.rst +++ b/docs/api/api_python/nn/mindspore.nn.BiDense.rst @@ -1,5 +1,5 @@ mindspore.nn.BiDense -=================== +==================== .. py:class:: mindspore.nn.BiDense(in1_channels, in2_channels, out_channels, weight_init=None, bias_init=None, has_bias=True) diff --git a/docs/api/api_python/ops/mindspore.ops.ApplyProximalAdagrad.rst b/docs/api/api_python/ops/mindspore.ops.ApplyProximalAdagrad.rst index 37c832b9ad2..9276fc86a93 100644 --- a/docs/api/api_python/ops/mindspore.ops.ApplyProximalAdagrad.rst +++ b/docs/api/api_python/ops/mindspore.ops.ApplyProximalAdagrad.rst @@ -31,6 +31,7 @@ mindspore.ops.ApplyProximalAdagrad **输出：** 包含两个Tensor的Tuple，已被更新的参数。 + - **var** (Tensor) - 与输入 `var` 的shape与数据类型相同。 - **accum** (Tensor) - 与输入 `var` 的shape与数据类型相同。 diff --git a/docs/api/api_python/ops/mindspore.ops.Conv3D.rst b/docs/api/api_python/ops/mindspore.ops.Conv3D.rst index 11d0bc00553..fdff8827bfe 100644 --- a/docs/api/api_python/ops/mindspore.ops.Conv3D.rst +++ b/docs/api/api_python/ops/mindspore.ops.Conv3D.rst @@ -32,13 +32,13 @@ mindspore.ops.Conv3D - **stride** (Union[int, tuple[int]]) - 数据类型为int或由三个int值所组成的Tuple。当 `stride` 为int时表示在深度、高度和宽度方向的移动步长均为该值。当 `stride` 为三个int值所组成的Tuple时，三个int值分别表示在深度、高度和宽度方向的移动步长。默认值：1。 - **pad_mode** (str) - 指定填充模式。可选值为"same"、"valid"、"pad"。默认值："valid"。 - - same: 输出的深度、高度和宽度分别与对应输入整除 `stride` 后的值相同。 - 同一维度的padding将被尽可能均匀填充在两侧，额外的padding将被填充在尾侧。 - 若设置该模式， `pad` 的值必须为0。 + - same: 输出的深度、高度和宽度分别与对应输入整除 `stride` 后的值相同。 + 同一维度的padding将被尽可能均匀填充在两侧，额外的padding将被填充在尾侧。 + 若设置该模式， `pad` 的值必须为0。 - - valid: 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。如果设置此模式，则 `pad` 的值必须为0。 + - valid: 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。如果设置此模式，则 `pad` 的值必须为0。 - - pad: 在输入深度、高度和宽度各维度两侧进行自动填充。如果设置此模式， `pad` 的值必须大于或等于0。 + - pad: 在输入深度、高度和宽度各维度两侧进行自动填充。如果设置此模式， `pad` 的值必须大于或等于0。 - **pad** (Union(int, tuple[int])) - 在输入各维度两侧的填充长度。如果 `pad` 是一个整数，则前部、后部、顶部，底部，左边和右边的填充都等于 `pad` 。如果 `pad` 是6个整数的Tuple，则前部、后部、顶部、底部、左边和右边的填充分别等于填充 `pad[0]` 、 `pad[1]` 、 `pad[2]` 、 `pad[3]` 、 `pad[4]` 和 `pad[5]` 。默认值：0。 - **dilation** (Union[int, tuple[int]]) - 三维卷积核膨胀尺寸。数据类型为int或三个整数的Tuple :math:`(dilation_d, dilation_h, dilation_w)` 。目前在深度维度仅支持取值为1。若 :math:`k > 1` ，则kernel间隔 `k` 个元素取样。取值大于等于1且小于对应的高度或宽度大小。默认值: 1。 @@ -48,8 +48,7 @@ mindspore.ops.Conv3D **输入：** - **x** (Tensor) - shape为 :math:`(N, C_{in}, D_{in}, H_{in}, W_{in})` 的Tensor。目前数据类型仅支持float16和float32。 - - **weight** (Tensor) - 若kernel shape为 :math:`(k_d, K_h, K_w)` ，则weight shape应为 - :math:`(C_{out}, C_{in}/groups, k_d, K_h, K_w)` 。目前数据类型仅支持float16和float32。 + - **weight** (Tensor) - 若kernel shape为 :math:`(k_d, K_h, K_w)` ，则weight shape应为 :math:`(C_{out}, C_{in}/groups, k_d, K_h, K_w)` 。目前数据类型仅支持float16和float32。 - **bias** (Tensor) - shape为 :math:`C_{in}` 的Tensor。目前仅支持None。默认值：None。 **输出：** diff --git a/docs/api/api_python/ops/mindspore.ops.Conv3DTranspose.rst b/docs/api/api_python/ops/mindspore.ops.Conv3DTranspose.rst index 3dc9c23aca2..d361deef461 100644 --- a/docs/api/api_python/ops/mindspore.ops.Conv3DTranspose.rst +++ b/docs/api/api_python/ops/mindspore.ops.Conv3DTranspose.rst @@ -1,7 +1,7 @@ mindspore.ops.Conv3DTranspose ============================= -.. py:class:: mindspore.ops.Conv3DTranspose(out_channel, kernel_size, mode=1, stride=1, pad_mode='valid', pad=0, dilation=1, group=1, data_format='NCDHW') +.. py:class:: mindspore.ops.Conv3DTranspose(in_channel, out_channel, kernel_size, mode=1, stride=1, pad_mode='valid', pad=0, dilation=1, group=1, output_padding=0, data_format='NCDHW') 计算三维转置卷积，也称为反卷积（实际不是真正的反卷积）。 @@ -27,13 +27,14 @@ mindspore.ops.Conv3DTranspose - **mode** (int) - 指定不同的卷积模式。此值目前未被使用。默认值： 1。 - **pad_mode** (str) - 指定填充模式。可选值为"same"、"valid"、"pad"。默认值: "valid"。 - - same: 填充输入。输出的深度、高度和宽度分别与对应输入整除 `stride` 后的值相同。 - 同一维度的padding将被尽可能均匀填充在两侧，额外的padding将被填充在尾侧。 - 若设置该模式，`pad` 的值必须为0。 + - same: 填充输入。输出的深度、高度和宽度分别与对应输入整除 `stride` 后的值相同。 + 同一维度的padding将被尽可能均匀填充在两侧，额外的padding将被填充在尾侧。 + 若设置该模式，`pad` 的值必须为0。 - - valid: 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。如果设置此模式，则 `pad` 的值必须为0。 + - valid: 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。如果设置此模式，则 `pad` 的值必须为0。 - - pad: 在输入深度、高度和宽度各维度两侧进行自动填充。如果设置此模式， `pad` 的值必须大于或等于0。 + - pad: 在输入深度、高度和宽度各维度两侧进行自动填充。如果设置此模式， `pad` 的值必须大于或等于0。 + - **pad** (Union(int, tuple[int])) - 在输入各维度两侧填充的数量。如果 `pad` 是一个整数，则前部、后部、顶部，底部，左边和右边的填充都等于 `pad` 。如果 `pad` 是6个整数的Tuple，则前部、后部、顶部、底部、左边和右边的填充分别等于填充 `pad[0]` 、 `pad[1]` 、 `pad[2]` 、 `pad[3]` 、 `pad[4]` 和 `pad[5]` 。默认值：0。 - **stride** (Union(int, tuple[int])) - 三维卷积核的移动步长。数据类型为整型或三个整型的Tuple。一个整数表示在深度、高度和宽度方向的移动步长均为该值。三个整数的Tuple分别表示在深度、高度和宽度方向的移动步长。默认值：1。 - **dilation** (Union(int, tuple[int])) - 卷积核膨胀尺寸，指定应用卷积核的间隔。默认值: 1。 @@ -44,10 +45,7 @@ mindspore.ops.Conv3DTranspose **输入：** - **dout** (Tensor) - 卷积操作的输出的梯度Tensor。shape： :math:`(N, C_{in}, D_{out}, H_{out}, W_{out})` 。目前数据类型仅支持float16和float32。 - - **weight** (Tensor) - 若kernel shape为 :math:`(K_d, K_h, K_w)` ，则weight shape应为 - :math:`(C_{in}, C_{out}//group, K_d, K_h, K_w)` ，其中 :math:`group` 为算子参数。 - :math:`//` 为整数除法操作。 - 目前数据类型仅支持float16和float32。 + - **weight** (Tensor) - 若kernel shape为 :math:`(K_d, K_h, K_w)` ，则weight shape应为 :math:`(C_{in}, C_{out}//group, K_d, K_h, K_w)` ，其中 :math:`group` 为算子参数。:math:`//` 为整数除法操作。目前数据类型仅支持float16和float32。 - **bias** (Tensor) - shape为 :math:`C_{out}` 的Tensor。目前仅支持None。默认值：None。 **输出：** diff --git a/docs/api/api_python/ops/mindspore.ops.CumProd.rst b/docs/api/api_python/ops/mindspore.ops.CumProd.rst index 7851c3fec91..be0e792964c 100644 --- a/docs/api/api_python/ops/mindspore.ops.CumProd.rst +++ b/docs/api/api_python/ops/mindspore.ops.CumProd.rst @@ -22,7 +22,7 @@ mindspore.ops.CumProd **输出：** - Tensor，shape和数据类型与 `x` 相同。 + Tensor，shape和数据类型与 `x` 相同。 **异常：** diff --git a/docs/api/api_python/ops/mindspore.ops.Depend.rst b/docs/api/api_python/ops/mindspore.ops.Depend.rst index 5c12d25c0a8..f3b12fd5f56 100644 --- a/docs/api/api_python/ops/mindspore.ops.Depend.rst +++ b/docs/api/api_python/ops/mindspore.ops.Depend.rst @@ -7,6 +7,8 @@ mindspore.ops.Depend 在大多数情况下，如果操作有作用在IO或内存上的副作用，它们将按照用户的指令依序执行。在某些情况下，如果两个操作A和B没有顺序上的依赖性，而A必须在B之前执行，我们建议使用Depend来指定它们的执行顺序。使用方法如下： + .. code-block:: + a = A(x) ---> a = A(x) b = B(y) ---> y = Depend(y, a) ---> b = B(y) diff --git a/docs/api/api_python/ops/mindspore.ops.IndexAdd.rst b/docs/api/api_python/ops/mindspore.ops.IndexAdd.rst index 4aee3e75433..9468fc1bc64 100644 --- a/docs/api/api_python/ops/mindspore.ops.IndexAdd.rst +++ b/docs/api/api_python/ops/mindspore.ops.IndexAdd.rst @@ -14,10 +14,8 @@ mindspore.ops.IndexAdd **输入：** - **x** (Parameter) - 要添加到的输入参数。 - - **indices** (Tensor) - 沿 `axis` 在指定 `indices` 位置进行加法运算。数据类型支持int32。 - `indices` 必须为一维且与 `y` 在 `axis` 维度的尺寸相同。 `indices` 取值范围应为[0, b)， 其中b为 `x` 在 `axis` 维度的尺寸。 - - **y** (Tensor) - 被添加的 `x` 的输入Tensor。必须与 `x` 的数据类型相同。 - 除 `axis` 之外的维度shape必须与 `x` 的shape相同。 + - **indices** (Tensor) - 沿 `axis` 在指定 `indices` 位置进行加法运算。数据类型支持int32。`indices` 必须为一维且与 `y` 在 `axis` 维度的尺寸相同。 `indices` 取值范围应为[0, b)， 其中b为 `x` 在 `axis` 维度的尺寸。 + - **y** (Tensor) - 被添加的 `x` 的输入Tensor。必须与 `x` 的数据类型相同。除 `axis` 之外的维度shape必须与 `x` 的shape相同。 **输出：** diff --git a/docs/api/api_python/ops/mindspore.ops.Pdist.rst b/docs/api/api_python/ops/mindspore.ops.Pdist.rst index a7a16e0c180..bb11ae983f3 100644 --- a/docs/api/api_python/ops/mindspore.ops.Pdist.rst +++ b/docs/api/api_python/ops/mindspore.ops.Pdist.rst @@ -1,9 +1,8 @@ mindspore.ops.Pdist -================== +=================== -.. py:function:: mindspore.ops.Pdist() +.. py:class:: mindspore.ops.Pdist() 计算输入中每对行向量之间的p-范数距离。 更多参考详见 :func:`mindspore.ops.pdist`。 - diff --git a/docs/api/api_python/ops/mindspore.ops.Randperm.rst b/docs/api/api_python/ops/mindspore.ops.Randperm.rst index 4dc10393274..7a82b481d7e 100644 --- a/docs/api/api_python/ops/mindspore.ops.Randperm.rst +++ b/docs/api/api_python/ops/mindspore.ops.Randperm.rst @@ -1,7 +1,7 @@ mindspore.ops.Randperm ====================== -.. py:class:: mindspore.ops.Randperm(max_length=1, pad=-1, dtype=mindspore.int32) +.. py:class:: mindspore.ops.Randperm(max_length=1, pad=-1, dtype=mstype.int32) 生成从0到n-1不重复的n个随机样本。如果 `max_length` > n，则末尾的 `max_length-n` 个元素使用 `pad` 填充。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_pdist.rst b/docs/api/api_python/ops/mindspore.ops.func_pdist.rst index 7c087a74dc8..360526cfc7f 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_pdist.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_pdist.rst @@ -1,17 +1,17 @@ mindspore.ops.pdist -================== +=================== -.. py:function:: mindspore.ops.pdist(x, p) +.. py:function:: mindspore.ops.pdist(x, p=2.0) - 计算输入中每对行向量之间的p-范数距离。如果输入`x`的shape为 :math:`(N, M)`，那么输出就是一个shape为 :math:`(N * (N - 1) / 2,)` - 的Tensor。如果`x`的shape为 :math:`(*B, N, M)`，那么输出就是一个shape为 :math:`(*B, N * (N - 1) / 2)`的Tensor。 + 计算输入中每对行向量之间的p-范数距离。如果输入 `x` 的shape为 :math:`(N, M)` ，那么输出就是一个shape为 :math:`(N * (N - 1) / 2,)` 的Tensor。 + 如果 `x` 的shape为 :math:`(*B, N, M)` ，那么输出就是一个shape为 :math:`(*B, N * (N - 1) / 2)` 的Tensor。 .. math:: y[n] = \sqrt[p]{{\mid x_{i} - x_{j} \mid}^p} **参数：** - - **x** (tensor) - 输入tensor x，其shape为 :math:`(*B, N, M)`，其中 :math:`*B`表示批处理大小，可以是多维度。类型：float16，float32或float64。 + - **x** (tensor) - 输入tensor x，其shape为 :math:`(*B, N, M)`，其中 :math:`*B` 表示批处理大小，可以是多维度。类型：float16，float32或float64。 - **p** (float) - P -范数距离的P值，P∈[0，∞]。默认值:2.0。 **返回：** @@ -25,6 +25,4 @@ mindspore.ops.pdist - **TypeError** - `p` 不是float。 - **ValueError** - `p` 是负数。 - **ValueError** - `x` 的维度小于2。 - **支持平台：** - ``CPU`` diff --git a/docs/api/api_python/probability/mindspore.nn.probability.bnn_layers.ConvReparam.rst b/docs/api/api_python/probability/mindspore.nn.probability.bnn_layers.ConvReparam.rst index bad6a539f5e..0d7e1d68b70 100644 --- a/docs/api/api_python/probability/mindspore.nn.probability.bnn_layers.ConvReparam.rst +++ b/docs/api/api_python/probability/mindspore.nn.probability.bnn_layers.ConvReparam.rst @@ -16,11 +16,11 @@ mindspore.nn.probability.bnn_layers.ConvReparam - **pad_mode** (str) – 指定填充模式。可选值是"same"、"valid"和"pad"。默认值："same"。 - same：采用补全方式。输出高度和宽度将与输入相同。将在水平和垂直方向上计算填充的总数，并尽可能均匀地分布在顶部和底部、左侧和右侧。否则，最后的额外填充将从底部和右侧完成。如果设置了此模式，则 padding 必须为0。 + - same：采用补全方式。输出高度和宽度将与输入相同。将在水平和垂直方向上计算填充的总数，并尽可能均匀地分布在顶部和底部、左侧和右侧。否则，最后的额外填充将从底部和右侧完成。如果设置了此模式，则 padding 必须为0。 - valid：采用丢弃的方式。输出的可能最大高度和宽度将不带 padding 返回。多余的像素将被丢弃。如果设置了此模式，则 padding 必须为0。 + - valid：采用丢弃的方式。输出的可能最大高度和宽度将不带 padding 返回。多余的像素将被丢弃。如果设置了此模式，则 padding 必须为0。 - pad：输入两侧的隐式 padding。 padding 的值将被填充到输入 Tensor 边界。 padding 必须大于或等于0。 + - pad：输入两侧的隐式 padding。 padding 的值将被填充到输入 Tensor 边界。 padding 必须大于或等于0。 - **padding** (Union[int, tuple[int]]) – 输入两侧的隐式 padding 。默认值：0。 - **dilation** (Union[int, tuple[int]]) – 数据类型是 int 或2个 int 的元组。该参数指定空洞卷积的空洞率。如果设置为k>1， 将有k−1每个采样位置跳过的像素。它的值必须大于或等于1，并受输入的高度和宽度限制。默认值：1。 diff --git a/docs/api/api_python_en/mindspore.ops.functional.rst b/docs/api/api_python_en/mindspore.ops.functional.rst index 159a8700050..6b6ebfb90ee 100644 --- a/docs/api/api_python_en/mindspore.ops.functional.rst +++ b/docs/api/api_python_en/mindspore.ops.functional.rst @@ -161,7 +161,7 @@ Element-by-Element Operations Reduction Operators ^^^^^^^^^^^^^^^^^^^ -.. mscnplatformautosummary:: +.. msplatformautosummary:: :toctree: ops :nosignatures: :template: classtemplate.rst