forked from mindspore-Ecosystem/mindspore
!41321 modify the format of the rst files in 1.8
Merge pull request !41321 from 宦晓玲/code_docs_00901
This commit is contained in:
Gitee
commit
d0db9326fe
|
|
@ -5,7 +5,7 @@
|
|||
|
||||
:class:`mindspore.dataset.text.SentencePieceTokenizer` 输出类型的枚举值。
|
||||
|
||||
可选的枚举值包括：SPieceTokenizerOutType.STRING和SPieceTokenizerOutType.INT
|
||||
可选的枚举值包括：SPieceTokenizerOutType.STRING和SPieceTokenizerOutType.INT。
|
||||
|
||||
- **SPieceTokenizerOutType.STRING** - 表示SentencePiece分词器的输出类型为string。
|
||||
- **SPieceTokenizerOutType.INT** - 表示SentencePiece分词器的输出类型为int。
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ mindspore.dataset.text.SlidingWindow
|
|||
|
||||
**参数：**
|
||||
|
||||
- **width** (str) - 窗口的宽度，它必须是整数并且大于零。
|
||||
- **width** (str) - 窗口的宽度，它必须是整数并且大于零。
|
||||
- **axis** (int, 可选) - 计算滑动窗口的轴，默认值：0。
|
||||
|
||||
**异常：**
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@
|
|||
- **delimiter** (str，可选) - 表示用来分隔文件中每一行的分隔符。第一个元素被视为单词，默认值：""。
|
||||
- **vocab_size** (int，可选) - 表示要从 `file_path` 读取的字数，默认值：None，表示读取所有的字。
|
||||
- **special_tokens** (list，可选) - 特殊分词列表，如常用的"<pad>"、"<unk>"等。默认值：None，表示不添加特殊分词（token）。
|
||||
- **special_first** (list，可选) - 表示是否将 `special_tokens` 中的特殊分词添加到词典的最前面。如果为True则将 `special_tokens` 添加到词典的最前，否则添加到词典的最后。默认值：True。
|
||||
- **special_first** (bool，可选) - 表示是否将 `special_tokens` 中的特殊分词添加到词典的最前面。如果为True则将 `special_tokens` 添加到词典的最前，否则添加到词典的最后。默认值：True。
|
||||
|
||||
**返回：**
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ mindspore.dataset.vision.RandomAffine
|
|||
如果 `translate` 是一个包含4个值的元组或列表，则 (translate[0], translate[1]) 表示水平(X)方向的随机平移范围，(translate[2], translate[3])表示垂直(Y)方向的随机平移范围。
|
||||
如果为None，则不对图像进行任何平移。
|
||||
- **scale** (sequence, 可选) - 图像的比例因子的随机范围，必须为非负数，使用原始比例，默认值：None。
|
||||
- **shear** (Union[int, float, sequence], 可选) - 图像的剪切因子的随机范围，必须为正数，默认值：None。
|
||||
- **shear** (Union[float, Sequence[float, float], Sequence[float, float, float, float]], 可选) - 图像的剪切因子的随机范围，必须为正数，默认值：None。
|
||||
如果是数字，则应用在 (-shear, +shear) 范围内平行于 X 轴的剪切。
|
||||
如果 `shear` 是一个包含2个值的元组或列表，则在 (shear[0],shear[1]) 范围内进行水平(X)方向的剪切变换。
|
||||
如果 `shear` 是一个包含4个值的元组或列表，则在 (shear[0],shear[1]) 范围内进行水平(X)方向的剪切变换，并在(shear[2], shear[3])范围内进行垂直(Y)方向的剪切变换。
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ mindspore.nn.AdaMax
|
|||
.. include:: mindspore.nn.optim_group_gc.rst
|
||||
.. include:: mindspore.nn.optim_group_order.rst
|
||||
|
||||
- **learning_rate** (Union[float, Tensor, iterable, LearningRateSchedule]): 默认值：0.001。
|
||||
- **learning_rate** (Union[float, int, Tensor, iterable, LearningRateSchedule]): 默认值：0.001。
|
||||
|
||||
.. include:: mindspore.nn.optim_arg_dynamic_lr.rst
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ mindspore.nn.AvgPool2d
|
|||
|
||||
对输入的多维数据进行二维的平均池化运算。
|
||||
|
||||
通常，输入的shape为 :math:`(N_{in},C_{in},H_{in},W_{in})` ，AvgPool2d的输出为 :math:`(H_{in},W_{in})` 维度的区域平均值。给定 `kernel_size` 为 :math:`(kH,kW)` 和 `stride` ，公式定义如下
|
||||
通常，输入的shape为 :math:`(N_{in},C_{in},H_{in},W_{in})` ，AvgPool2d的输出为 :math:`(H_{in},W_{in})` 维度的区域平均值。给定 `kernel_size` 为 :math:`(kH,kW)` 和 `stride` ，公式定义如下：
|
||||
|
||||
.. math::
|
||||
\text{output}(N_i, C_j, h, w) = \frac{1}{kH * kW} \sum_{m=0}^{kH-1} \sum_{n=0}^{kW-1}
|
||||
|
|
|
|||
|
|
@ -40,5 +40,5 @@ mindspore.nn.BleuScore
|
|||
|
||||
**异常：**
|
||||
|
||||
- **ValueError** - 输入参数的数量不等于2。
|
||||
- **ValueError** - 输入参数的数量不等于2。
|
||||
- **ValueError** - `candidate_corpus` 的长度与 `reference_corpus` 不同。
|
||||
|
|
@ -13,20 +13,20 @@ mindspore.nn.Conv2dTranspose
|
|||
|
||||
**参数：**
|
||||
|
||||
- **in_channels** (`int`) - Conv2dTranspose层输入Tensor的空间维度。
|
||||
- **out_channels** (`dict`) - Conv2dTranspose层输出Tensor的空间维度。
|
||||
- **kernel_size** (`Union[int, tuple[int]]`) - 指定二维卷积核的高度和宽度。数据类型为整型或两个整型的tuple。一个整数表示卷积核的高度和宽度均为该值。两个整数的tuple分别表示卷积核的高度和宽度。
|
||||
- **stride** (`Union[int, tuple[int]]`) - 二维卷积核的移动步长。数据类型为整型或两个整型的tuple。一个整数表示在高度和宽度方向的移动步长均为该值。两个整数的tuple分别表示在高度和宽度方向的移动步长。默认值：1。
|
||||
- **pad_mode** (`str`) - 指定填充模式。可选值为"same"、"valid"、"pad"。默认值："same"。
|
||||
- **in_channels** (int) - Conv2dTranspose层输入Tensor的空间维度。
|
||||
- **out_channels** (dict) - Conv2dTranspose层输出Tensor的空间维度。
|
||||
- **kernel_size** (Union[int, tuple[int]]) - 指定二维卷积核的高度和宽度。数据类型为整型或两个整型的tuple。一个整数表示卷积核的高度和宽度均为该值。两个整数的tuple分别表示卷积核的高度和宽度。
|
||||
- **stride** (Union[int, tuple[int]]) - 二维卷积核的移动步长。数据类型为整型或两个整型的tuple。一个整数表示在高度和宽度方向的移动步长均为该值。两个整数的tuple分别表示在高度和宽度方向的移动步长。默认值：1。
|
||||
- **pad_mode** (str) - 指定填充模式。可选值为"same"、"valid"、"pad"。默认值："same"。
|
||||
|
||||
- **same**：输出的高度和宽度分别与输入整除 `stride` 后的值相同。若设置该模式，`padding` 的值必须为0。
|
||||
- **valid**：在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。如果设置此模式，则 `padding` 的值必须为0。
|
||||
- **pad**：对输入进行填充。在输入的高度和宽度方向上填充 `padding` 大小的0。如果设置此模式， `padding` 必须大于或等于0。
|
||||
|
||||
- **padding** (`Union[int, tuple[int]]`) - 输入的高度和宽度方向上填充的数量。数据类型为整型或包含四个整数的tuple。如果 `padding` 是一个整数，那么上、下、左、右的填充都等于 `padding` 。如果 `padding` 是一个有四个整数的tuple，那么上、下、左、右的填充分别等于 `padding[0]` 、 `padding[1]` 、 `padding[2]` 和 `padding[3]` 。值应该要大于等于0，默认值：0。
|
||||
- **dilation** (`Union[int, tuple[int]]`) - 二维卷积核膨胀尺寸。数据类型为整型或具有两个整型的tuple。若 :math:`k > 1` ，则kernel间隔 `k` 个元素进行采样。高度和宽度方向上的 `k` ，其取值范围分别为[1, H]和[1, W]。默认值：1。
|
||||
- **group** (`int`) - 将过滤器拆分为组， `in_channels` 和 `out_channels` 必须可被 `group` 整除。如果组数等于 `in_channels` 和 `out_channels` ，这个二维卷积层也被称为二维深度卷积层。默认值：1.
|
||||
- **has_bias** (`bool`) - Conv2dTranspose层是否添加偏置参数。默认值：False。
|
||||
- **padding** (Union[int, tuple[int]]) - 输入的高度和宽度方向上填充的数量。数据类型为整型或包含四个整数的tuple。如果 `padding` 是一个整数，那么上、下、左、右的填充都等于 `padding` 。如果 `padding` 是一个有四个整数的tuple，那么上、下、左、右的填充分别等于 `padding[0]` 、 `padding[1]` 、 `padding[2]` 和 `padding[3]` 。值应该要大于等于0，默认值：0。
|
||||
- **dilation** (Union[int, tuple[int]]) - 二维卷积核膨胀尺寸。数据类型为整型或具有两个整型的tuple。若 :math:`k > 1` ，则kernel间隔 `k` 个元素进行采样。高度和宽度方向上的 `k` ，其取值范围分别为[1, H]和[1, W]。默认值：1。
|
||||
- **group** (int) - 将过滤器拆分为组， `in_channels` 和 `out_channels` 必须可被 `group` 整除。如果组数等于 `in_channels` 和 `out_channels` ，这个二维卷积层也被称为二维深度卷积层。默认值：1.
|
||||
- **has_bias** (bool) - Conv2dTranspose层是否添加偏置参数。默认值：False。
|
||||
- **weight_init** (Union[Tensor, str, Initializer, numbers.Number]) - 权重参数的初始化方法。它可以是Tensor，str，Initializer或numbers.Number。当使用str时，可选"TruncatedNormal"，"Normal"，"Uniform"，"HeUniform"和"XavierUniform"分布以及常量"One"和"Zero"分布的值，可接受别名"xavier_uniform"，"he_uniform"，"ones"和"zeros"。上述字符串大小写均可。更多细节请参考Initializer的值。默认值："normal"。
|
||||
- **bias_init** (Union[Tensor, str, Initializer, numbers.Number]) - 偏置参数的初始化方法。可以使用的初始化方法与"weight_init"相同。更多细节请参考Initializer的值。默认值："zeros"。
|
||||
|
||||
|
|
|
|||
|
|
@ -50,10 +50,10 @@ mindspore.nn.CrossEntropyLoss
|
|||
|
||||
**参数：**
|
||||
|
||||
- **weight** (Tensor): 指定各类别的权重。若值不为None，则shape为 (C,)。数据类型仅支持float32或float16。默认值: None。
|
||||
- **ignore_index** (int): 指定target中需要忽略的值(一般为填充值)，使其不对梯度产生影响。默认值: -100。
|
||||
- **reduction** (str): 指定应用于输出结果的计算方式，比如'none'、'mean'、'sum'。默认值：'mean'。
|
||||
- **label_smoothing** (float): 标签平滑值，用于计算Loss时防止模型过拟合的正则化手段。取值范围为[0.0, 1.0]。 默认值: 0.0。
|
||||
- **weight** (Tensor) - 指定各类别的权重。若值不为None，则shape为 (C,)。数据类型仅支持float32或float16。默认值: None。
|
||||
- **ignore_index** (int) - 指定target中需要忽略的值(一般为填充值)，使其不对梯度产生影响。默认值: -100。
|
||||
- **reduction** (str) - 指定应用于输出结果的计算方式，比如'none'、'mean'、'sum'。默认值：'mean'。
|
||||
- **label_smoothing** (float) - 标签平滑值，用于计算Loss时防止模型过拟合的正则化手段。取值范围为[0.0, 1.0]。 默认值: 0.0。
|
||||
|
||||
**输入：**
|
||||
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ mindspore.nn.LSTMCell
|
|||
**参数：**
|
||||
|
||||
- **input_size** (int) - 输入的大小。
|
||||
- **hidden_size** (int)- 隐藏状态大小。
|
||||
- **hidden_size** (int) - 隐藏状态大小。
|
||||
- **has_bias** (bool) - cell是否有偏置 `b_ih` 和 `b_hh` 。默认值：True。
|
||||
|
||||
**输入：**
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ mindspore.nn.Lamb
|
|||
|
||||
**参数：**
|
||||
|
||||
- **params** (Union[list[Parameter], list[dict]]): 必须是 `Parameter` 组成的列表或字典组成的列表。当列表元素是字典时，字典的键可以是"params"、"lr"、"weight_decay"、"grad_centralization"和"order_params"：
|
||||
- **params** (Union[list[Parameter], list[dict]]) - 必须是 `Parameter` 组成的列表或字典组成的列表。当列表元素是字典时，字典的键可以是"params"、"lr"、"weight_decay"、"grad_centralization"和"order_params"：
|
||||
|
||||
.. include:: mindspore.nn.optim_group_param.rst
|
||||
.. include:: mindspore.nn.optim_group_lr.rst
|
||||
|
|
@ -64,12 +64,12 @@ mindspore.nn.Lamb
|
|||
.. include:: mindspore.nn.optim_group_gc.rst
|
||||
.. include:: mindspore.nn.optim_group_order.rst
|
||||
|
||||
- **learning_rate** (Union[float, Tensor, Iterable, LearningRateSchedule]):
|
||||
- **learning_rate** (Union[float, int, Tensor, Iterable, LearningRateSchedule]) -
|
||||
|
||||
.. include:: mindspore.nn.optim_arg_dynamic_lr.rst
|
||||
|
||||
- **beta1** (float)：第一矩的指数衰减率。参数范围（0.0,1.0）。默认值：0.9。
|
||||
- **beta2** (float)：第二矩的指数衰减率。参数范围（0.0,1.0）。默认值：0.999。
|
||||
- **beta1** (float) - 第一矩的指数衰减率。参数范围（0.0,1.0）。默认值：0.9。
|
||||
- **beta2** (float) - 第二矩的指数衰减率。参数范围（0.0,1.0）。默认值：0.999。
|
||||
- **eps** (float) - 将添加到分母中，以提高数值稳定性。必须大于0。默认值：1e-6。
|
||||
- **weight_decay** (Union[float, int, Cell]) - 权重衰减（L2 penalty）。默认值：0.0。
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ mindspore.nn.LayerNorm
|
|||
|
||||
**参数：**
|
||||
|
||||
- **normalized_shape** (Union(tuple[int], list[int]) - 沿轴 `begin_norm_axis ... R - 1` 执行归一化。
|
||||
- **normalized_shape** (Union(tuple[int], list[int])) - 沿轴 `begin_norm_axis ... R - 1` 执行归一化。
|
||||
- **begin_norm_axis** (int) - 归一化开始计算的轴，取值范围是[-1, rank(x))。默认值：-1。
|
||||
- **begin_params_axis** (int) - 第一个参数(beta, gamma)的维度：scale和centering参数有 `begin_params_axis: rank(x)` 个维度，并与输入一起广播，取值范围是[-1, rank(input))。默认值：-1。
|
||||
- **gamma_init** (Union[Tensor, str, Initializer, numbers.Number]) - :math:`\gamma` 参数的初始化方法。str的值引用自函数 `initializer` ，包括'zeros'、'ones'、'xavier_uniform'、'he_uniform'等。默认值：'ones'。
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ mindspore.nn.TrainOneStepWithLossScaleCell
|
|||
|
||||
**参数：**
|
||||
|
||||
- **sens** （Tensor）- 新的损失缩放系数，其shape和类型需要与原始 `scale_sense` 相同。
|
||||
- **sens** （Tensor） - 新的损失缩放系数，其shape和类型需要与原始 `scale_sense` 相同。
|
||||
|
||||
.. py:method:: start_overflow_check(pre_cond, compute_input)
|
||||
|
||||
|
|
|
|||
|
|
@ -17,8 +17,8 @@ mindspore.nn.WarmUpLR
|
|||
|
||||
**参数：**
|
||||
|
||||
- **learning_rate** (float): 学习率的初始值。
|
||||
- **warmup_steps** (int): 学习率warmup的step数。
|
||||
- **learning_rate** (float) - 学习率的初始值。
|
||||
- **warmup_steps** (int) - 学习率warmup的step数。
|
||||
|
||||
**输入：**
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue