!45115 modify format

Merge pull request !45115 from 俞涵/code_docs_1010
This commit is contained in:
i-robot 2022-11-04 03:14:51 +00:00 committed by Gitee
commit c03790d99a
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
11 changed files with 17 additions and 16 deletions

View File

@ -11,9 +11,9 @@ mindspore.dataset.IWSLT2017Dataset
- **dataset_dir** (str) - 包含数据集文件的根目录路径。
- **usage** (str, 可选) - 指定数据集的子集,可取值为'train''valid''test'或'all'。默认值None读取全部样本。
- **language_pair** (sequence, 可选) - 包含源语和目标语的语言列表,支持的语言对有('en', 'nl')、
'en', 'de')、('en', 'it')、('en', 'ro')、('nl', 'en')、('nl', 'de')、('nl', 'it')、('nl', 'ro')、
'de', 'en')、('de', 'nl')、('de', 'it')、('de', 'ro')、('it', 'en')、('it', 'nl')、('it', 'de')、
'it', 'ro')、('ro', 'en')、('ro', 'nl')、('ro', 'de')、('ro', 'it')。默认值:('de''en')。
'en', 'de')、('en', 'it')、('en', 'ro')、('nl', 'en')、('nl', 'de')、('nl', 'it')、('nl', 'ro')、
'de', 'en')、('de', 'nl')、('de', 'it')、('de', 'ro')、('it', 'en')、('it', 'nl')、('it', 'de')、
'it', 'ro')、('ro', 'en')、('ro', 'nl')、('ro', 'de')、('ro', 'it')。默认值:('de''en')。
- **num_samples** (int, 可选) - 指定从数据集中读取的样本数。默认值None读取所有样本。
- **shuffle** (Union[bool, Shuffle], 可选) - 每个epoch中数据混洗的模式支持传入bool类型与枚举类型进行指定。默认值`Shuffle.GLOBAL`
如果 `shuffle` 为False则不混洗如果 `shuffle` 为True等同于将 `shuffle` 设置为mindspore.dataset.Shuffle.GLOBAL。

View File

@ -43,7 +43,7 @@ mindspore.COOTensor
参数:
- **other** (COOTensor) - 另一个操作数,与当前操作数相加。
- **thresh** (Tensor) - 0维。用来决定COOTensor.add结果中的indice/value对是否出现的阈值。如果结果中value的数据类型为实数`thresh`的数据类型应该与它的数据类型一致。如果结果中value小于`thresh`, 它将会被丢掉。
- **thresh** (Tensor) - 0维。用来决定COOTensor.add结果中的indice/value对是否出现的阈值。如果结果中value的数据类型为实数 `thresh` 的数据类型应该与它的数据类型一致。如果结果中value小于 `thresh`, 它将会被丢掉。
返回:
COOTensor为两COOTensor相加后的结果。

View File

@ -10,7 +10,7 @@ mindspore.ops.argmax
参数:
- **x** (Tensor) - 输入Tensorshape :math:`(N, *)` ,其中 :math:`*` 表示任意数量的附加维度。
- **axis** (int可选) - `argmax` 的指定计算轴。默认值:-1。
- **output_type** (:class:`mindspore.dtype` ,可选) - 指定输出数据类型。默认值: `mindspore.dtype.int32`
- **output_type** (:class:`mindspore.dtype`,可选) - 指定输出数据类型。默认值: `mindspore.dtype.int32`
返回:
Tensor输出为指定轴上输入Tensor最大值的索引。

View File

@ -6,7 +6,7 @@ mindspore.ops.crop_and_resize
对输入图像Tensor进行裁剪并调整其大小。
.. note::
当输出的shape依赖 `crop_size`的时候,`crop_size` 必须为常量。
当输出的shape依赖 `crop_size` 的时候,`crop_size` 必须为常量。
当前该算子的反向仅支持"bilinear"模式其他模式将会返回0。
参数:

View File

@ -21,6 +21,6 @@ mindspore.ops.expand
- **ValueError** - 如果 `size` 的长度小于 `input_x` shape的大小。
- **ValueError** - 如果 `size` 不是一个1D Tensor。
- **ValueError** - 如果 `size` 某维度的值不等于 `input_x` 对应维度的值,且 `input_x` 该维度不为1。
- **ValueError** - 如果 `size` 有小于0的值在最前面且对应` input_x` 不存在的维度上。
- **ValueError** - 如果 `size` 有小于0的值在最前面且对应 `input_x` 不存在的维度上。
- **ValueError** - 如果输出的元素数量超过1000000。

View File

@ -12,7 +12,7 @@ mindspore.ops.glu
请参考 `Language Modeling with Gated Convluational Networks <https://arxiv.org/abs/1612.08083>`_.
参数:
- **x** (Tensor) - 被分Tensor数据类型为number.Number, shape为 :math:`(\ast_1, N, \ast_2)` ,其中`*`为任意额外维度。
- **x** (Tensor) - 被分Tensor数据类型为number.Number, shape为 :math:`(\ast_1, N, \ast_2)` ,其中 `*` 为任意额外维度。
- **axis** (int可选) - 指定分割轴。数据类型为整型,默认值:-1。
返回:

View File

@ -25,7 +25,7 @@ mindspore.ops.max_unpool2d
默认值None。
- **padding** (Union[int, tuple[int]]) - 填充值。默认值0。若为int类型则长宽方向的填充大小相同均为 `padding`
若为tuple类型则tuple中的两个值分别代表长宽方向填充的大小。
- **output_size** (tuple[int] 可选) - 输出shape。默认值None。
- **output_size** (tuple[int],可选) - 输出shape。默认值None。
如果output_size为()那么输出shape根据 `kernel_size``stride``padding` 计算得出。
如果output_size不为(),那么 `output_size` 必须满足格式 :math:`(N, C, H, W)`:math:`(C, H, W)` ,取值范围需满足:
:math:`[(N, C, H_{out} - stride[0], W_{out} - stride[1]), (N, C, H_{out} + stride[0], W_{out} + stride[1])]`

View File

@ -8,7 +8,7 @@ mindspore.ops.sparse_add
参数:
- **x1** (COOTensor) - 一个操作数,与当前操作数相加。
- **x2** (COOTensor) - 另一个操作数,与当前操作数相加。
- **thresh** (Tensor) - 0维。用来决定COOTensor.add结果中的indice/value对是否出现的阈值。如果结果中value的数据类型为实数`thresh`的数据类型应该与它的数据类型一致。如果结果中value小于`thresh`, 它将会被丢掉。
- **thresh** (Tensor) - 0维。用来决定COOTensor.add结果中的indice/value对是否出现的阈值。如果结果中value的数据类型为实数 `thresh` 的数据类型应该与它的数据类型一致。如果结果中value小于 `thresh`, 它将会被丢掉。
返回:
COOTensor为两COOTensor相加后的结果。

View File

@ -1,15 +1,15 @@
mindspore.ops.trunc
===================
.. py:function:: mindspore.ops.trunc(input_x)
.. py:function:: mindspore.ops.trunc(input)
返回一个新的张量,该张量具有输入元素的截断整数值。
参数:
- **input_x** (Tensor) - 任意维度的Tensor。
- **input** (Tensor) - 任意维度的Tensor。
返回:
Tensorshape和数据类型与 `input_x` 相同。
Tensorshape和数据类型与 `input` 相同。
异常:
- **TypeError** - `input_x` 不是Tensor。
- **TypeError** - `input` 不是Tensor。

View File

@ -4761,7 +4761,7 @@ def diagonal(input, offset=0, dim1=0, dim2=1):
to the right equal to the size of the resulting diagonals.
Args:
a (Tensor): Array from which the diagonals are taken.
input (Tensor): Array from which the diagonals are taken.
offset (int, optional): Offset of the diagonal from the main diagonal.
Can be positive or negative. Defaults: 0.
dim1 (int, optional): Axis to be used as the first axis of the 2-D

View File

@ -292,10 +292,11 @@ class CropAndResize(Primitive):
Normalized coordinates outside the [0, 1] range are allowed, in which case we use `extrapolation_value` to
extrapolate the input image values. Types allowed: float32.
- **box_index** (Tensor) - A 1-D tensor of shape [num_boxes] with int32 values in [0, batch).
The value of `box_index`[i] specifies the image that the i-th box refers to. Types allowed: int32.
The value of `box_index[i]` specifies the image that the i-th box refers to. Types allowed: int32.
- **crop_size** (Tuple[int]) - A tuple of two int32 elements: (crop_height, crop_width).
Only constant value is allowed. All cropped image patches are resized to this size.
The aspect ratio of the image content is not preserved. Both crop_height and crop_width need to be positive.
Outputs:
A 4-D tensor of shape [num_boxes, crop_height, crop_width, depth] with type: float32.