Merge pull request !49502 from 俞涵/code_docs_issue
This commit is contained in:
i-robot 2023-02-28 03:05:18 +00:00 committed by Gitee
commit 20f0935d14
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
6 changed files with 9 additions and 9 deletions

View File

@ -20,7 +20,7 @@ mindspore.nn.Conv3d
参数:
- **in_channels** (int) - Conv3d层输入Tensor的空间维度。
- **out_channels** (int) - Conv3d层输出Tensor的空间维度。
- **kernel_size** (Union[int, tuple[int]]) - 指定三维卷积核的深度、高度和宽度。数据类型为int或包含三个整数的tuple。一个整数表示卷积核的深度、高度和宽度均为该值该值。包含三个整数的tuple分别表示卷积核的深度、高度和宽度。
- **kernel_size** (Union[int, tuple[int]]) - 指定三维卷积核的深度、高度和宽度。数据类型为int或包含三个整数的tuple。一个整数表示卷积核的深度、高度和宽度均为该值。包含三个整数的tuple分别表示卷积核的深度、高度和宽度。
- **stride** (Union[int, tuple[int]]) - 三维卷积核的移动步长。数据类型为整型或三个整型的tuple。一个整数表示在深度、高度和宽度方向的移动步长均为该值。三个整数的tuple分别表示在深度、高度和宽度方向的移动步长。默认值1。
- **pad_mode** (str) - 指定填充模式。可选值为"same"、"valid"、"pad"。默认值:"same"。

View File

@ -11,10 +11,10 @@ mindspore.nn.ParameterUpdate
- **param** (Parameter) - 输入的参数。
输入:
- **x** Tensor- shape和type与 `param` 相同的Tensor。
- **x** (Tensor) - shape和type与 `param` 相同的Tensor。
输出:
Tensor `x`
Tensor `x`
异常:
- **KeyError** - 指定名称的参数不存在。

View File

@ -36,8 +36,8 @@ mindspore.ops.BCEWithLogitsLoss
Tensor或Scalar如果 `reduction` 为 'none' 则为shape和数据类型与输入 `logits` 相同的Tensor。否则输出为Scalar。
异常:
- **TypeError** - 任何输入不是Tensor。
- **TypeError** - 任何输入的数据类型既不是float16也不是float32。
- **TypeError** - 所有的输入都不是Tensor。
- **TypeError** - 所有输入的数据类型既不是float16也不是float32。
- **TypeError** - `reduction` 的数据类型不是string。
- **ValueError** - `weight``pos_weight` 不能广播到shape为 `logits` 的Tensor。
- **ValueError** - `reduction` 不为 'none' 、 'mean' 或 'sum' 。

View File

@ -3,7 +3,7 @@ mindspore.ops.Dropout2D
.. py:class:: mindspore.ops.Dropout2D(keep_prob=0.5)
在训练期间,根据概率 :math:`1-keep\_prob` ,随机将一些通道设置为0且服从伯努利分布。对于shape为 :math:`(N, C, H, W)` 的四维Tensor通道特征图指的是shape为 :math:`(H, W)` 的二维特征图。)
在训练期间,根据概率 :math:`1-keep\_prob` ,随机将一些通道设置为0且服从伯努利分布。对于shape为 :math:`(N, C, H, W)` 的四维Tensor通道特征图指的是shape为 :math:`(H, W)` 的二维特征图。)
.. note::
保持概率 :math:`keep\_prob` 等于 :func:`mindspore.ops.dropout2d` 中的 :math:`1 - p`

View File

@ -7,7 +7,7 @@ mindspore.ops.batch_to_space_nd
此函数会将批次维度 `N` 划分为具有 `block_shape` 的块,即输出张量的 `N` 维度是划分后对应的块数。
输出张量的 :math:`w_1, ..., w_M` 维度是原始的 :math:`w_1, ..., w_M` 维度和 `block_shape` 的乘积从维度裁剪给定。
如此,若输入的shape为 :math:`(n, c_1, ... c_k, w_1, ..., w_M)`则输出的shape为 :math:`(n', c_1, ... c_k, w'_1, ..., w'_M)`
若输入的shape为 :math:`(n, c_1, ... c_k, w_1, ..., w_M)`则输出的shape为 :math:`(n', c_1, ... c_k, w'_1, ..., w'_M)`
其中
.. math::

View File

@ -44,7 +44,7 @@
.. warning:: 这是一个实验性接口,后续可能删除或修改。
.. note:: 如果预先调用该接口构建计算图,那么 `Model.train` 会直接执行计算图。预构建计算图目前仅支持GRAPH_MOD模式和Ascend处理器。仅支持数据下沉模式。
.. note:: 如果预先调用该接口构建计算图,那么 `Model.train` 会直接执行计算图。预构建计算图目前仅支持GRAPH_MODE模式和Ascend处理器。仅支持数据下沉模式。
参数:
- **train_dataset** (Dataset) - 一个训练集迭代器。如果定义了 `train_dataset` 将会构建训练计算图。默认值None。
@ -84,7 +84,7 @@
如果 `valid_dataset` 不为None在训练过程中同时执行推理。
更多详细信息请参考 `mindspore.train.Model.train``mindspore.train.Model.eval`
更多详细信息请参考 :func:`mindspore.train.Model.train`:func:`mindspore.train.Model.eval`
参数:
- **epoch** (int) - 训练执行轮次。通常每个epoch都会使用全量数据集进行训练。当 `dataset_sink_mode` 设置为True且 `sink_size` 大于零时则每个epoch训练次数为 `sink_size` 而不是数据集的总步数。如果 `epoch``initial_epoch` 一起使用,它表示训练的最后一个 `epoch` 是多少。