!35112 modify format

Merge pull request !35112 from 俞涵/code_docs_0527
This commit is contained in:
i-robot 2022-05-28 08:28:38 +00:00 committed by Gitee
commit 44bf5724a9
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
12 changed files with 33 additions and 38 deletions

View File

@ -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)

View File

@ -31,6 +31,7 @@ mindspore.ops.ApplyProximalAdagrad
**输出:**
包含两个Tensor的Tuple已被更新的参数。
- **var** (Tensor) - 与输入 `var` 的shape与数据类型相同。
- **accum** (Tensor) - 与输入 `var` 的shape与数据类型相同。

View File

@ -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。
**输出:**

View File

@ -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。
**输出:**

View File

@ -22,7 +22,7 @@ mindspore.ops.CumProd
**输出:**
Tensorshape和数据类型与 `x` 相同。
Tensorshape和数据类型与 `x` 相同。
**异常:**

View File

@ -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)

View File

@ -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相同。
**输出:**

View File

@ -1,9 +1,8 @@
mindspore.ops.Pdist
==================
===================
.. py:function:: mindspore.ops.Pdist()
.. py:class:: mindspore.ops.Pdist()
计算输入中每对行向量之间的p-范数距离。
更多参考详见 :func:`mindspore.ops.pdist`

View File

@ -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` 填充。

View File

@ -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`表示批处理大小可以是多维度。类型float16float32或float64。
- **x** (tensor) - 输入tensor x其shape为 :math:`(*B, N, M)`,其中 :math:`*B` 表示批处理大小可以是多维度。类型float16float32或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``

View File

@ -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 将有k1每个采样位置跳过的像素。它的值必须大于或等于1并受输入的高度和宽度限制。默认值1。

View File

@ -161,7 +161,7 @@ Element-by-Element Operations
Reduction Operators
^^^^^^^^^^^^^^^^^^^
.. mscnplatformautosummary::
.. msplatformautosummary::
:toctree: ops
:nosignatures:
:template: classtemplate.rst