modify the format of API files

This commit is contained in:
zhangyi 2022-07-26 10:27:56 +08:00
parent 740776ac05
commit 60a1042e19
77 changed files with 841 additions and 1097 deletions

View File

@ -16,24 +16,20 @@ mindspore.ops.Gamma
- 全局的随机种子未设置,算子层的随机种子设置了:使用默认的全局的随机种子,和算子层的随机种子拼接。
- 全局的随机种子和算子层的随机种子都设置了:全局的随机种子和算子层的随机种子拼接。
**参数:**
参数:
- **seed** (int) - 算子层的随机种子用于生成随机数。必须是非负的。默认值0。
- **seed2** (int) - 全局的随机种子和算子层的随机种子共同决定最终生成的随机数。必须是非负的。默认值0。
- **seed** (int) - 算子层的随机种子用于生成随机数。必须是非负的。默认值0。
- **seed2** (int) - 全局的随机种子和算子层的随机种子共同决定最终生成的随机数。必须是非负的。默认值0。
输入:
- **shape** (tuple) - 待生成的随机Tensor的shape。只支持常量值。
- **alpha** (Tensor) - α为Gamma分布的shape parameter主要决定了曲线的形状。其值必须大于0。数据类型为float32。
- **beta** (Tensor) - β为Gamma分布的inverse scale parameter主要决定了曲线有多陡。其值必须大于0。数据类型为float32。
**输入:**
输出:
Tensor。shape是输入 `shape` `alpha` `beta` 广播后的shape。数据类型为float32。
- **shape** (tuple) - 待生成的随机Tensor的shape。只支持常量值。
- **alpha** (Tensor) - α为Gamma分布的shape parameter主要决定了曲线的形状。其值必须大于0。数据类型为float32。
- **beta** (Tensor) - β为Gamma分布的inverse scale parameter主要决定了曲线有多陡。其值必须大于0。数据类型为float32。
**输出:**
Tensor。shape是输入 `shape` `alpha` `beta` 广播后的shape。数据类型为float32。
**异常:**
- **TypeError** - `seed``seed2` 的数据类型不是int。
- **TypeError** - `alpha``beta` 不是Tensor。
- **TypeError** - `alpha``beta` 的数据类型不是float32。
- **ValueError** - `shape` 不是常量值。
异常:
- **TypeError** - `seed``seed2` 的数据类型不是int。
- **TypeError** - `alpha``beta` 不是Tensor。
- **TypeError** - `alpha``beta` 的数据类型不是float32。
- **ValueError** - `shape` 不是常量值。

View File

@ -15,15 +15,12 @@ mindspore.ops.GeLU
其中 :math:`P` 是标准高斯分布的累积分布函数, :math:`x_i` 是输入的元素。
**输入:**
输入:
- **x** (Tensor) - 激活函数GeLU的输入数据类型为float16或float32。
- **x** (Tensor) - 激活函数GeLU的输入数据类型为float16或float32。
输出:
Tensor数据类型和shape与 `x` 的相同。
**输出:**
Tensor数据类型和shape与 `x` 的相同。
**异常:**
- **TypeError** - `x` 不是Tensor。
- **TypeError** - `x` 的数据类型既不是float16也不是float32。
异常:
- **TypeError** - `x` 不是Tensor。
- **TypeError** - `x` 的数据类型既不是float16也不是float32。

View File

@ -8,17 +8,14 @@ mindspore.ops.GetNext
.. note::
GetNext操作需要联网且依赖'dataset'接口,例如: :class:`mindspore.dataset.MnistDataset` 。不能单独操作。详见 :class:`mindspore.connect_network_with_dataset` 的源码。
**参数:**
参数:
- **types** (list[:class:`mindspore.dtype`]) - 输出的数据类型。
- **shapes** (list[tuple[int]]) - 输出数据的shape大小。
- **output_num** (int) - 输出编号、 `types``shapes` 的长度。
- **shared_name** (str) - 待获取数据的队列名称。
- **types** (list[:class:`mindspore.dtype`]) - 输出的数据类型。
- **shapes** (list[tuple[int]]) - 输出数据的shape大小。
- **output_num** (int) - 输出编号、 `types``shapes` 的长度。
- **shared_name** (str) - 待获取数据的队列名称。
输入:
没有输入。
**输入:**
没有输入。
**输出:**
tuple[Tensor]Dataset的输出。Shape和类型参见 `shapes``types`
输出:
tuple[Tensor]Dataset的输出。Shape和类型参见 `shapes``types`

View File

@ -60,16 +60,13 @@ mindspore.ops.GradOperation
4. 用 `net` 的输入和 `sens_param` 作为参数调用梯度函数,得到关于所有输入的梯度:`gradient_function(x, y, grad_wrt_output)`
**参数:**
参数:
- **get_all** (bool) - 计算梯度如果等于False获得第一个输入的梯度如果等于True获得所有输入的梯度。默认值False。
- **get_by_list** (bool) - 如果 `get_all``get_by_list` 都等于False则得到第一个输入的梯度。如果等于True获得所有Parameter自由变量的梯度。如果 `get_all``get_by_list` 都等于True则同时得到输入和Parameter自由变量的梯度输出形式为(“所有输入的梯度”“所有Parameter自由变量的梯度”)。默认值False。
- **sens_param** (bool) - 是否在输入中配置灵敏度关于输出的梯度。如果sens_param等于False自动添加一个 `ones_like(output)` 灵敏度。如果sensor_param等于True灵敏度输出的梯度必须通过location参数或key-value pair参数来传递如果是通过key-value pair参数传递value那么key必须为sens。默认值False。
- **get_all** (bool) - 计算梯度如果等于False获得第一个输入的梯度如果等于True获得所有输入的梯度。默认值False。
- **get_by_list** (bool) - 如果 `get_all``get_by_list` 都等于False则得到第一个输入的梯度。如果等于True获得所有Parameter自由变量的梯度。如果 `get_all``get_by_list` 都等于True则同时得到输入和Parameter自由变量的梯度输出形式为(“所有输入的梯度”“所有Parameter自由变量的梯度”)。默认值False。
- **sens_param** (bool) - 是否在输入中配置灵敏度关于输出的梯度。如果sens_param等于False自动添加一个 `ones_like(output)` 灵敏度。如果sensor_param等于True灵敏度输出的梯度必须通过location参数或key-value pair参数来传递如果是通过key-value pair参数传递value那么key必须为sens。默认值False。
返回:
将一个函数作为参数,并返回梯度函数的高阶函数。
**返回:**
将一个函数作为参数,并返回梯度函数的高阶函数。
**异常:**
- **TypeError** - 如果 `get_all``get_by_list` 或者 `sens_params` 不是bool。
异常:
- **TypeError** - 如果 `get_all``get_by_list` 或者 `sens_params` 不是bool。

View File

@ -7,23 +7,19 @@ mindspore.ops.HyperMap
对序列的每个元素或嵌套序列进行运算。与 `mindspore.ops.Map` 不同,`HyperMap` 能够用于嵌套结构。
**参数:**
参数:
- **ops** (Union[MultitypeFuncGraph, None]) - `ops` 是指定运算操作。如果 `ops` 为None则运算应该作为 `HyperMap` 实例的第一个入参。默认值为None。
- **reverse** (bool) - 在某些场景下,需要逆向以提高计算的并行性能,一般情况下,用户可以忽略。`reverse` 用于决定是否逆向执行运算仅在图模式下支持。默认值为False。
- **ops** (Union[MultitypeFuncGraph, None]) - `ops` 是指定运算操作。如果 `ops` 为None则运算应该作为 `HyperMap` 实例的第一个入参。默认值为None。
- **reverse** (bool) - 在某些场景下,需要逆向以提高计算的并行性能,一般情况下,用户可以忽略。`reverse` 用于决定是否逆向执行运算仅在图模式下支持。默认值为False
输入:
- **args** (Tuple[sequence]) - 如果 `ops` 不是None则所有入参都应该是具有相同长度的序列并且序列的每一行都是运算的输入。如果 `ops` 是None则第一个入参是运算其余都是输入
**输入:**
.. note::
输入数量等于 `ops` 的输入数量。
- **args** (Tuple[sequence]) - 如果 `ops` 不是None则所有入参都应该是具有相同长度的序列并且序列的每一行都是运算的输入。如果 `ops` 是None则第一个入参是运算其余都是输入。
输出:
序列或嵌套序列,执行函数如 `operation(args[0][i], args[1][i])` 之后输出的序列。
.. note::
输入数量等于 `ops` 的输入数量。
**输出:**
序列或嵌套序列,执行函数如 `operation(args[0][i], args[1][i])` 之后输出的序列。
**异常:**
- **TypeError** - 如果 `ops` 既不是 `MultitypeFuncGraph` 也不是None。
- **TypeError** - 如果 `args` 不是一个tuple。
异常:
- **TypeError** - 如果 `ops` 既不是 `MultitypeFuncGraph` 也不是None。
- **TypeError** - 如果 `args` 不是一个tuple。

View File

@ -15,19 +15,15 @@ mindspore.ops.IOU
.. warning::
在Ascend中仅支持计算float16数据。为避免溢出输入长度和宽度在内部按0.2缩放。
**参数:**
参数:
- **mode** (string) - 指定计算方法,现支持'iou'(intersection over union)或'iof'(intersection over foreground)模式。默认值:'iou'。
- **mode** (string) - 指定计算方法,现支持'iou'(intersection over union)或'iof'(intersection over foreground)模式。默认值:'iou'。
输入:
- **anchor_boxes** (Tensor) - 预测区域shape为(N, 4)的Tensor。"N"表示预测区域的数量,"4"表示"x0"、"y0"、"x1"和"y1"。数据类型为float16或float32。
- **gt_boxes** (Tensor) - 真实区域shape为(M, 4)的Tensor。"M"表示地面真实区域的数量,"4"表示"x0"、"y0"、"x1"和"y1"。数据类型为float16或float32。
**输入:**
输出:
IOU值的Tensorshape为(M, N)的Tensor数据类型与 `anchor_boxes` 的相同。
- **anchor_boxes** (Tensor) - 预测区域shape为(N, 4)的Tensor。"N"表示预测区域的数量,"4"表示"x0"、"y0"、"x1"和"y1"。数据类型为float16或float32。
- **gt_boxes** (Tensor) - 真实区域shape为(M, 4)的Tensor。"M"表示地面真实区域的数量,"4"表示"x0"、"y0"、"x1"和"y1"。数据类型为float16或float32。
**输出:**
IOU值的Tensorshape为(M, N)的Tensor数据类型与 `anchor_boxes` 的相同。
**异常:**
- **KeyError** - `mode` 不是'iou'或'iof'。
异常:
- **KeyError** - `mode` 不是'iou'或'iof'。

View File

@ -5,14 +5,11 @@ mindspore.ops.Identity
返回与输入具有相同shape和值的Tensor。
**输入:**
输入:
- **x** (Tensor) - shape为 :math:`(x_1, x_2, ..., x_R)` 的Tensor。数据类型为Number。
- **x** (Tensor) - shape为 :math:`(x_1, x_2, ..., x_R)` 的Tensor。数据类型为Number。
输出:
Tensorshape和数据类型与输入相同 :math:`(x_1, x_2, ..., x_R)`
**输出:**
Tensorshape和数据类型与输入相同 :math:`(x_1, x_2, ..., x_R)`
**异常:**
- **TypeError** - `x` 不是Tensor。
异常:
- **TypeError** - `x` 不是Tensor。

View File

@ -5,27 +5,23 @@ mindspore.ops.IndexAdd
将Tensor `y` 加到Tensor `x` 的指定 `axis``indices``axis` 取值范围为[0, len(x.dim) - 1] `indices` 取值范围为[0, len(x[axis]) - 1]。
**参数:**
参数:
- **axis** (int) - 进行索引的axis。
- **use_lock** (bool) - 是否对参数更新加锁保护。默认值True。
- **check_index_bound** (bool) - 如果为True将对索引进行边界检查。默认值True。
- **axis** (int) - 进行索引的axis。
- **use_lock** (bool) - 是否对参数更新加锁保护。默认值: True。
- **check_index_bound** (bool) - 如果为True将对索引进行边界检查。默认值: True。
输入:
- **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相同。
**输入:**
输出:
Tensor`x` 的shape和数据类型相同。
- **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相同。
**输出:**
Tensor`x` 的shape和数据类型相同。
**异常:**
- **TypeError** - `x` 不是Parameter。
- **TypeError** - `indices``y` 不是Tensor。
- **ValueError** - axis 超过了 `x` 的秩。
- **ValueError** - `x``y` 的秩不相同。
- **ValueError** - `indices` 不是一维或与 `y[axis]` 的尺寸不同。
- **ValueError** - `y` 的shape与除 `axis` 之外的维度的 `x` 的shape不同。
异常:
- **TypeError** - `x` 不是Parameter。
- **TypeError** - `indices``y` 不是Tensor。
- **ValueError** - axis 超过了 `x` 的秩。
- **ValueError** - `x``y` 的秩不相同。
- **ValueError** - `indices` 不是一维或与 `y[axis]` 的尺寸不同。
- **ValueError** - `y` 的shape与除 `axis` 之外的维度的 `x` 的shape不同。

View File

@ -5,21 +5,17 @@ mindspore.ops.InplaceUpdate
`x` 的特定行更新为 `v`
**参数:**
参数:
- **indices** (Union[int, tuple]) - 指定将 `x` 的哪些行更新为 `v` 。可以为int或Tuple取值范围[0, len(`x`))。
- **indices** (Union[int, tuple]) - 指定将 `x` 的哪些行更新为 `v` 。可以为int或Tuple取值范围[0, len(`x`))。
输入:
- **x** (Tensor) - 待更新的Tensor。数据类型支持float16、float32或int32。
- **v** (Tensor) - 除第一个维度之外shape必须与 `x` 的shape相同。第一个维度必须与 `indices` 的长度相同。数据类型与 `x` 相同。
**输入:**
输出:
Tensor`x` 的shape和数据类型相同。
- **x** (Tensor) - 待更新的Tensor。数据类型支持float16、float32或int32。
- **v** (Tensor) - 除第一个维度之外shape必须与 `x` 的shape相同。第一个维度必须与 `indices` 的长度相同。数据类型与 `x` 相同。
**输出:**
Tensor`x` 的shape和数据类型相同。
**异常:**
- **TypeError** - `indices` 不是int或Tuple。
- **TypeError** - `indices` 为Tuple而其包含的某一元素非int类型。
异常:
- **TypeError** - `indices` 不是int或Tuple。
- **TypeError** - `indices` 为Tuple而其包含的某一元素非int类型。

View File

@ -5,19 +5,15 @@ mindspore.ops.InsertGradientOf
为图节点附加回调函数,将在梯度计算时被调用。
**参数:**
- **f** (Function) - MindSpore Function。回调函数。
参数:
- **f** (Function) - MindSpore Function。回调函数。
**输入:**
- **input_x** (Any) - 需要附加回调函数的图节点。
输入:
- **input_x** (Any) - 需要附加回调函数的图节点。
**输出:**
Tensor直接返回输入 `input_x` 。该算子不影响前向计算的结果。
输出:
Tensor直接返回输入 `input_x` 。该算子不影响前向计算的结果。
**异常:**
**TypeError** - `f` 不是MindSpore Function。
异常:
- **TypeError** - `f` 不是MindSpore Function。

View File

@ -13,14 +13,11 @@
其中 :math:`Inf` 表示不是一个数字。
**输入:**
输入:
- **x** (Tensor) - IsInf的输入shape :math:`(N, *)` ,其中 :math:`*` 表示任意数量的附加维度。
- **x** (Tensor) - IsInf的输入shape :math:`(N, *)` ,其中 :math:`*` 表示任意数量的附加维度。
输出:
Tensorshape与相同的输入数据的类型为bool。
**输出:**
Tensorshape与相同的输入数据的类型为bool。
**异常:**
- **TypeError** - 如果 `x` 不是Tensor。
异常:
- **TypeError** - 如果 `x` 不是Tensor。

View File

@ -5,15 +5,12 @@
检查输入对象是否为目标类型的实例。
**输入:**
输入:
- **inst** (Any Object) - 要检查的实例。只允许为常量。
- **type_** (mindspore.dtype) - 目标类型。只允许为常量。
- **inst** (Any Object) - 要检查的实例。只允许为常量。
- **type_** (mindspore.dtype) - 目标类型。只允许为常量
输出:
bool检查结果
**输出:**
bool检查结果。
**异常:**
- **TypeError** - 如果 `type_` 不是一种类型。
异常:
- **TypeError** - 如果 `type_` 不是一种类型。

View File

@ -5,15 +5,12 @@
检查输入类型是否为其他类型的子类。
**输入:**
输入:
- **sub_type** (mindspore.dtype) - 要检查的类型。只允许为常量。
- **type_** (mindspore.dtype) - 目标类型。只允许为常量。
- **sub_type** (mindspore.dtype) - 要检查的类型。只允许为常量。
- **type_** (mindspore.dtype) - 目标类型。只允许为常量
输出:
bool检查结果
**输出:**
bool检查结果。
**异常:**
- **TypeError** - 如果 `sub_type``type_` 不是一种类型。
异常:
- **TypeError** - 如果 `sub_type``type_` 不是一种类型。

View File

@ -28,26 +28,22 @@ mindspore.ops.KLDivLoss
- 目前Ascend平台不支持数据类型float64。
- 仅当 `reduction` 设置为"batchmean"时输出才与KL散度的数学定义一致。
**参数:**
参数:
- **reduction** (str) - 指定输出结果的计算方式。默认值: "mean"。
- **reduction** (str) - 指定输出结果的计算方式。默认值: "mean"。
- 在Ascend平台上 `reduction` 的可选值为"batchmean"、"none"或"sum"。
- 在GPU平台上 `reduction` 的可选值为"mean"、"none"或"sum"。
- 在CPU平台上 `reduction` 的可选值为"mean"、"batchmean"、"none"或"sum"。
- 在Ascend平台上 `reduction` 的可选值为"batchmean"、"none"或"sum"。
- 在GPU平台上 `reduction` 的可选值为"mean"、"none"或"sum"
- 在CPU平台上 `reduction` 的可选值为"mean"、"batchmean"、"none"或"sum"
输入:
- **logits** (Tensor) - 数据类型支持float16、float32或float64
- **labels** (Tensor) - 标签Tensor`logits` 的shape和数据类型相同
**输入:**
输出:
Tensor或标量。如果 `reduction` 为"none" 则输出为Tensor且与 `logits` 的shape相同。否则为标量。
- **logits** (Tensor) - 数据类型支持float16、float32或float64。
- **labels** (Tensor) - 标签Tensor`logits` 的shape和数据类型相同。
**输出:**
Tensor或标量。如果 `reduction` 为"none" 则输出为Tensor且与 `logits` 的shape相同。否则为标量。
**异常:**
- **TypeError** - `reduction` 不是str。
- **TypeError** - `logits``labels` 不是Tensor。
- **TypeError** - `logits``labels` 的数据类型不是支持的类型。
- **RuntimeError** - `logits``labels` 是标量并且 `reduction` 是"batchmean"。
异常:
- **TypeError** - `reduction` 不是str。
- **TypeError** - `logits``labels` 不是Tensor。
- **TypeError** - `logits``labels` 的数据类型不是支持的类型。
- **RuntimeError** - `logits``labels` 是标量并且 `reduction` 是"batchmean"。

View File

@ -10,15 +10,12 @@ mindspore.ops.L2Loss
.. math::
loss = \frac{\sum x ^ 2}{2}
**输入:**
输入:
- **input_x** (Tensor) - 用于计算L2范数的Tensor。数据类型必须为float16或float32。
- **input_x** (Tensor) - 用于计算L2范数的Tensor。数据类型必须为float16或float32。
输出:
Tensor具有与 `input_x` 相同的数据类型的Scalar Tensor。
**输出:**
Tensor具有与 `input_x` 相同的数据类型的Scalar Tensor。
**异常:**
- **TypeError** - `input_x` 不是Tensor。
- **TypeError** - `input_x` 的数据类型既不是float16也不是float32。
异常:
- **TypeError** - `input_x` 不是Tensor。
- **TypeError** - `input_x` 的数据类型既不是float16也不是float32。

View File

@ -12,23 +12,19 @@ mindspore.ops.L2Normalize
其中 :math:`\epsilon` 表示 `epsilon` :math:`\sum_{i}^{}\left | x_i \right | ^2` 表示计算输入 `x` 在给定 `axis` 上元素的平方和。
**参数:**
参数:
- **axis** (Union[list(int), tuple(int), int]) - 指定计算L2范数的轴。默认值0。
- **epsilon** (float) - 为了数值稳定性而引入的很小的浮点数。默认值1e-4。
- **axis** (Union[list(int), tuple(int), int]) - 指定计算L2范数的轴。默认值0。
- **epsilon** (float) - 为了数值稳定性而引入的很小的浮点数。默认值1e-4
输入:
- **x** (Tensor) - 计算归一化的输入。shape为 :math:`(N, *)` ,其中 :math:`*` 表示任意的附加维度数。数据类型必须为float16或float32
**输入:**
输出:
Tensorshape和数据类型与 `x` 的相同。
- **x** (Tensor) - 计算归一化的输入。shape为 :math:`(N, *)` ,其中 :math:`*` 表示任意的附加维度数。数据类型必须为float16或float32。
**输出:**
Tensorshape和数据类型与 `x` 的相同。
**异常:**
- **TypeError** - `axis` 不是list、tuple或int。
- **TypeError** - `epsilon` 不是float。
- **TypeError** - `x` 不是Tensor。
- **TypeError** - `x` 的数据类型既不是float16也不是float32。
- **ValueError** - `x` 的维度不大于0。
异常:
- **TypeError** - `axis` 不是list、tuple或int。
- **TypeError** - `epsilon` 不是float。
- **TypeError** - `x` 不是Tensor。
- **TypeError** - `x` 的数据类型既不是float16也不是float32。
- **ValueError** - `x` 的维度不大于0。

View File

@ -7,29 +7,25 @@ mindspore.ops.LARSUpdate
更多细节请参考 :class:`mindspore.nn.LARS`
**参数:**
- **epsilon** (float) - 添加在分母中提高数值稳定性。默认值1e-05。
- **hyperpara** (float) - 计算局部学习率的信任系数。默认值0.001。
- **use_clip** (bool) - 计算局部学习速率时是否裁剪。默认值False。
参数:
- **epsilon** (float) - 添加在分母中提高数值稳定性。默认值1e-05。
- **hyperpara** (float) - 计算局部学习率的信任系数。默认值0.001。
- **use_clip** (bool) - 计算局部学习速率时是否裁剪。默认值False。
**输入:**
输入:
- **weight** (Tensor) - 权重Tensorshape: :math:`(N, *)` ,其中 :math:`*` 表示任意数量的附加维度。
- **gradient** (Tensor) - `weight` 的梯度, 与 `weight` 的shape和数据类型相同。
- **norm_weight** (Tensor) - 标量Tensor权重的平方和。
- **norm_gradient** (Tensor) - 标量Tensor梯度的平方和。
- **weight_decay** (Union[Number, Tensor]) - 衰减率。必须为标量Tensor或Number。
- **learning_rate** (Union[Number, Tensor]) - 学习率。必须为标量Tensor或Number。
- **weight** (Tensor) - 权重Tensorshape: :math:`(N, *)` ,其中 :math:`*` 表示任意数量的附加维度。
- **gradient** (Tensor) - `weight` 的梯度, 与 `weight` 的shape和数据类型相同。
- **norm_weight** (Tensor) - 标量Tensor权重的平方和。
- **norm_gradient** (Tensor) - 标量Tensor梯度的平方和。
- **weight_decay** (Union[Number, Tensor]) - 衰减率。必须为标量Tensor或Number。
- **learning_rate** (Union[Number, Tensor]) - 学习率。必须为标量Tensor或Number。
输出:
Tensor计算后的梯度。
**输出:**
Tensor计算后的梯度。
**异常:**
- **TypeError** - `epsilon``hyperpara` 不是float类型。
- **TypeError** - `use_clip` 不是bool类型。
- **TypeError** - `weight``gradient``norm_weight``norm_gradient` 不是Tensor。
- **TypeError** - `weight_decay``learning_rate` 非Number或Tensor。
- **TypeError** - `gradient``weight` 的shape不同。
异常:
- **TypeError** - `epsilon``hyperpara` 不是float类型。
- **TypeError** - `use_clip` 不是bool类型。
- **TypeError** - `weight``gradient``norm_weight``norm_gradient` 不是Tensor。
- **TypeError** - `weight_decay``learning_rate` 非Number或Tensor。
- **TypeError** - `gradient``weight` 的shape不同。

View File

@ -13,25 +13,21 @@ mindspore.ops.LRN
:math:`n/2` 为参数 `depth_radius` :math:`k` 为参数 `bias`
:math:`\alpha` 为参数 `alpha` :math:`\beta` 为参数 `beta`
**参数:**
参数:
- **depth_radius** (int) - 一维归一化窗口的半宽。默认值5。
- **bias** (float) - 偏移量通常为正以避免除零问题。默认值1.0。
- **alpha** (float) - 比例系数通常为正。默认值1.0。
- **beta** (float) - 指数。默认值0.5。
- **norm_region** (str) - 指定归一化区域。可选值:"ACROSS_CHANNELS"。默认值:"ACROSS_CHANNELS"。
- **depth_radius** (int) - 一维归一化窗口的半宽。默认值5。
- **bias** (float) - 偏移量通常为正以避免除零问题。默认值1.0。
- **alpha** (float) - 比例系数通常为正。默认值1.0。
- **beta** (float) - 指数。默认值0.5。
- **norm_region** (str) - 指定归一化区域。可选值:"ACROSS_CHANNELS"。默认值:"ACROSS_CHANNELS"。
输入:
- **x** (Tensor) - 数据类型为float16或float32的4维Tensor。
**输入:**
输出:
Tensor`x` 的shape和数据类型相同。
- **x** (Tensor) - 数据类型为float16或float32的4维Tensor。
**输出:**
Tensor`x` 的shape和数据类型相同。
**异常:**
- **TypeError** - `depth_radius` 不是int类型。
- **TypeError** - `bias``alpha``beta` 不是float类型。
- **TypeError** - `norm_region` 不是str。
- **TypeError** - `x` 不是Tensor。
异常:
- **TypeError** - `depth_radius` 不是int类型。
- **TypeError** - `bias``alpha``beta` 不是float类型。
- **TypeError** - `norm_region` 不是str。
- **TypeError** - `x` 不是Tensor。

View File

@ -12,28 +12,24 @@ mindspore.ops.LayerNorm
其中 :math:`\gamma` 是Scalar :math:`\beta` 是偏置项, :math:`\epsilon` 是精度值。
**参数:**
参数:
- **begin_norm_axis** (int) - 指定 `input_x` 需进行层归一化的起始维度,其值必须在[-1, rank(input)范围内。默认值1。
- **begin_params_axis** (int) - 指定输入参数(`gamma`, `beta`) 需进行层归一化的开始轴,其值必须在[-1, rank(input))范围内。默认值1。
- **epsilon** (float) - 添加到分母中的值以确保数据稳定性。默认值1e-7。
- **begin_norm_axis** (int) - 指定 `input_x` 需进行层归一化的起始维度,其值必须在[-1, rank(input)范围内。默认值1。
- **begin_params_axis** (int) - 指定输入参数(`gamma`, `beta`) 需进行层归一化的开始轴,其值必须在[-1, rank(input))范围内。默认值1。
- **epsilon** (float) - 添加到分母中的值以确保数据稳定性。默认值1e-7。
输入:
- **input_x** (Tensor) - LayerNorm的输入shape为 :math:`(N, \ldots)` 的Tensor。
- **gamma** (Tensor) - 可学习参数 :math:`\gamma` shape为 :math:`(P_0, \ldots, P_\text{begin_params_axis})` 的Tensor。
- **beta** (Tensor) - 可学习参数 :math:`\beta` 。shape为 :math:`(P_0, \ldots, P_\text{begin_params_axis})` 的Tensor。
**输入:**
输出:
tuple[Tensor]3个Tensor组成的tuple层归一化输入和更新后的参数。
- **input_x** (Tensor) - LayerNorm的输入shape为 :math:`(N, \ldots)` 的Tensor
- **gamma** (Tensor) - 可学习参数 :math:`\gamma` shape为 :math:`(P_0, \ldots, P_\text{begin_params_axis})` 的Tensor。
- **beta** (Tensor) - 可学习参数 :math:`\beta` 。shape为 :math:`(P_0, \ldots, P_\text{begin_params_axis})` 的Tensor。
- **output_x** (Tensor) - 层归一化输入shape为是 :math:`(N, C)` 。数据类型和shape与 `input_x` 相同
- **mean** (Tensor) - 输入的均值shape为 :math:`(C,)` 的Tensor。
- **variance** (Tensor) - 输入的方差shape为 :math:`(C,)` 的Tensor。
**输出:**
tuple[Tensor]3个Tensor组成的tuple层归一化输入和更新后的参数。
- **output_x** (Tensor) - 层归一化输入shape为是 :math:`(N, C)` 。数据类型和shape与 `input_x` 相同。
- **mean** (Tensor) - 输入的均值shape为 :math:`(C,)` 的Tensor。
- **variance** (Tensor) - 输入的方差shape为 :math:`(C,)` 的Tensor。
**异常:**
- **TypeError** - `begin_norm_axis``begin_params_axis` 不是int。
- **TypeError** - `epsilon` 不是float。
- **TypeError** - `input_x``gamma``beta` 不是Tensor。
异常:
- **TypeError** - `begin_norm_axis``begin_params_axis` 不是int。
- **TypeError** - `epsilon` 不是float。
- **TypeError** - `input_x``gamma``beta` 不是Tensor。

View File

@ -7,29 +7,25 @@ mindspore.ops.LogUniformCandidateSampler
该操作从整数范围[0, `range_max` )中随机采样一个采样类( `sampled_candidates` )的Tensor。
**参数:**
参数:
- **num_true** (int) - 每个训练样本的目标类数。默认值1。
- **num_sampled** (int) - 随机采样的类数。默认值5。
- **unique** (bool) - 确认批处理中的所有采样类是否都是唯一的。如果 `unique` 为True则批处理中的所有采样类都唯一。默认值True。
- **range_max** (int) - 可能的类数。当 `unique` 为True时 `range_max` 必须大于或等于 `num_sampled` 。默认值5。
- **seed** (int) - 随机种子必须是非负。默认值0。
- **num_true** (int) - 每个训练样本的目标类数。默认值1。
- **num_sampled** (int) - 随机采样的类数。默认值5。
- **unique** (bool) - 确认批处理中的所有采样类是否都是唯一的。如果 `unique` 为True则批处理中的所有采样类都唯一。默认值True。
- **range_max** (int) - 可能的类数。当 `unique` 为True时 `range_max` 必须大于或等于 `num_sampled` 。默认值5。
- **seed** (int) - 随机种子必须是非负。默认值0。
输入:
- **true_classes** (Tensor) - 目标类其数据类型为int64shape为 :math:`(batch\_size, num\_true)`
**输入:**
输出:
3个Tensor组成的元组。
- **true_classes** (Tensor) - 目标类其数据类型为int64shape为 :math:`(batch\_size, num\_true)`
- **sampled_candidates** (Tensor) - shape为 :math:`(num\_sampled,)` 且数据类型与 `true_classes` 相同的Tensor。
- **true_expected_count** (Tensor) - shape与 `true_classes` 相同且数据类型为float32的Tensor。
- **sampled_expected_count** (Tensor) - shape与 `sampled_candidates` 相同且数据类型为float32的Tensor。
**输出:**
3个Tensor组成的元组。
- **sampled_candidates** (Tensor) - shape为 :math:`(num\_sampled,)` 且数据类型与 `true_classes` 相同的Tensor。
- **true_expected_count** (Tensor) - shape与 `true_classes` 相同且数据类型为float32的Tensor。
- **sampled_expected_count** (Tensor) - shape与 `sampled_candidates` 相同且数据类型为float32的Tensor。
**异常:**
- **TypeError** - `num_true``num_sampled` 都不是int。
- **TypeError** - `unique` 不是bool。
- **TypeError** - `range_max``seed` 都不是int。
- **TypeError** - `true_classes` 不是Tensor。
异常:
- **TypeError** - `num_true``num_sampled` 都不是int。
- **TypeError** - `unique` 不是bool。
- **TypeError** - `range_max``seed` 都不是int。
- **TypeError** - `true_classes` 不是Tensor。

View File

@ -5,16 +5,13 @@ mindspore.ops.MaskedSelect
返回一个一维张量,其中的内容是 `x` 张量中对应于 `mask` 张量中True位置的值。`mask` 的shape与 `x` 的shape不需要一样但必须符合广播规则。
**输入:**
输入:
- **x** (Tensor) - 它的shape是 :math:`(x_1, x_2, ..., x_R)`
- **mask** (Tensor[bool]) - 它的shape是 :math:`(x_1, x_2, ..., x_R)`
- **x** (Tensor) - 它的shape是 :math:`(x_1, x_2, ..., x_R)`
- **mask** (Tensor[bool]) - 它的shape是 :math:`(x_1, x_2, ..., x_R)`
输出:
一维Tensor数据类型与 `x` 相同
**输出:**
一维Tensor数据类型与 `x` 相同。
**异常:**
- **TypeError** - `x``mask` 不是Tensor。
- **TypeError** - `mask` 不是bool类型的Tensor。
异常:
- **TypeError** - `x``mask` 不是Tensor。
- **TypeError** - `mask` 不是bool类型的Tensor。

View File

@ -14,22 +14,18 @@ mindspore.ops.MatMul
.. note::
对于 :math:`N * M` 不能被16整除的情况下在Ascend环境上性能会比较差。
**参数:**
参数:
- **transpose_a** (bool) - 如果为True则在相乘之前转置 `a`。默认值False。
- **transpose_b** (bool) - 如果为True则在相乘之前转置 `b`。默认值False。
- **transpose_a** (bool) - 如果为True则在相乘之前转置 `a`。默认值False。
- **transpose_b** (bool) - 如果为True则在相乘之前转置 `b`。默认值False。
输入:
- **a** (Tensor) - 要相乘的第一个Tensor。如果 `transpose_a` 为False则该Tensor的shape为 :math:`(N, C)` 否则该Tensor的shape为 :math:`(C, N)`
- **b** (Tensor) - 要相乘的第二个Tensor。如果 `transpose_b` 为False则该Tensor的shape为 :math:`(C, M)` 否则该Tensor的shape为 :math:`(M, C)`
**输入:**
输出:
Tensor输出Tensor的shape为 :math:`(N, M)`
- **a** (Tensor) - 要相乘的第一个Tensor。如果 `transpose_a` 为False则该Tensor的shape为 :math:`(N, C)` 否则该Tensor的shape为 :math:`(C, N)`
- **b** (Tensor) - 要相乘的第二个Tensor。如果 `transpose_b` 为False则该Tensor的shape为 :math:`(C, M)` 否则该Tensor的shape为 :math:`(M, C)`
**输出:**
Tensor输出Tensor的shape为 :math:`(N, M)`
**异常:**
- **TypeError** - `transpose_a``transpose_b` 不是bool。
- **ValueError** - 矩阵 `a` 的列不等于矩阵 `b` 的行。
- **ValueError** - `a``b` 的维度不等于2。
异常:
- **TypeError** - `transpose_a``transpose_b` 不是bool。
- **ValueError** - 矩阵 `a` 的列不等于矩阵 `b` 的行。
- **ValueError** - `a``b` 的维度不等于2。

View File

@ -8,21 +8,17 @@
.. note::
参数 `adjoint` 目前只支持False因为目前该算子不支持复数。
**参数:**
参数:
- **adjoint** (bool) - 指定是否支持复数False表示为不支持复数。默认False。
- **adjoint** (bool) - 指定是否支持复数False表示为不支持复数。默认False。
输入:
- **x** (Tensor) - 输入需计算的矩阵至少为二维矩阵且最后两个维度大小相同数据类型为float32、float64。
**输入:**
输出:
Tensor数据类型和shape与输入 `x` 相同。
- **x** (Tensor) - 输入需计算的矩阵至少为二维矩阵且最后两个维度大小相同数据类型为float32、float64。
**输出:**
Tensor数据类型和shape与输入 `x` 相同。
**异常:**
- **TypeError** - `adjoint` 不是bool。
- **TypeError** - `x` 的数据类型既不是float32也不是float64。
- **ValueError** - `x` 最后两个维度大小不同。
- **ValueError** - `x` 低于二维。
异常:
- **TypeError** - `adjoint` 不是bool。
- **TypeError** - `x` 的数据类型既不是float32也不是float64。
- **ValueError** - `x` 最后两个维度大小不同。
- **ValueError** - `x` 低于二维。

View File

@ -5,35 +5,31 @@ mindspore.ops.MaxPool
对输入的多维数据进行二维的最大池化运算。
通常输入的shape为 :math:`(N_{in}, C_{in}, H_{in}, W_{in})` MaxPool在 :math:`(H_{in}, W_{in})` 维度输出区域最大值。 给定 `kernel_size`:math:`(kH,kW)``stride` ,运算如下:
通常输入的shape为 :math:`(N_{in}, C_{in}, H_{in}, W_{in})` MaxPool在 :math:`(H_{in}, W_{in})` 维度输出区域最大值。给定 `kernel_size`:math:`(kH,kW)``stride` ,运算如下:
.. math::
\text{output}(N_i, C_j, h, w) = \max_{m=0, \ldots, kH-1} \max_{n=0, \ldots, kW-1}
\text{input}(N_i, C_j, stride[0] \times h + m, stride[1] \times w + n)
**参数:**
参数:
- **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小。由一个整数或者是两个整数组成的tuple表示高和宽。默认值1。
- **strides** (Union[int, tuple[int]]) - 池化操作的移动步长由一个整数或者是两个整数组成的tuple表示高和宽上的移动步长。默认值1。
- **pad_mode** (str) - 指定池化填充模式,可选值是'same'或'valid',不区分大小写。默认值:'valid'。
- **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小。由一个整数或者是两个整数组成的tuple表示高和宽。默认值1。
- **strides** (Union[int, tuple[int]]) - 池化操作的移动步长由一个整数或者是两个整数组成的tuple表示高和宽上的移动步长。默认值1。
- **pad_mode** (str) - 指定池化填充模式,可选值是'same'或'valid',不区分大小写。默认值:'valid'。
- **same** - 输出的高度和宽度分别与输入整除 `stride` 后的值相同。
- **valid** - 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。
- **same** - 输出的高度和宽度分别与输入整除 `stride` 后的值相同。
- **valid** - 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。
- **data_format** (str) - 输入和输出的数据格式。可选值为'NHWC'或'NCHW'。默认值:'NCHW'。
- **data_format** (str):输入和输出的数据格式。可选值为'NHWC'或'NCHW'。默认值:'NCHW'。
输入:
- **x** (Tensor) - shape为 :math:`(N, C_{in}, H_{in}, W_{in})` 的Tensor。
**输入:**
输出:
Tensorshape为 :math:`(N, C_{out}, H_{out}, W_{out})`
- **x** (Tensor) - shape为 :math:`(N, C_{in}, H_{in}, W_{in})` 的Tensor。
**输出:**
Tensorshape为 :math:`(N, C_{out}, H_{out}, W_{out})`
**异常:**
- **TypeError** - `kernel_size``strides` 既不是int也不是tuple。
- **ValueError** - `pad_mode` 既不是'valid'也不是'same'(不区分大小写)。
- **ValueError** - `data_format` 既不是'NCHW'也不是'NHWC'。
- **ValueError** - `kernel_size``strides` 小于1。
- **ValueError** - `iput` 的shape长度不等于4。
异常:
- **TypeError** - `kernel_size``strides` 既不是int也不是tuple。
- **ValueError** - `pad_mode` 既不是'valid'也不是'same'(不区分大小写)。
- **ValueError** - `data_format` 既不是'NCHW'也不是'NHWC'。
- **ValueError** - `kernel_size``strides` 小于1。
- **ValueError** - `iput` 的shape长度不等于4。

View File

@ -12,34 +12,30 @@ mindspore.ops.MaxPool3D
\max_{l=0, \ldots, kD-1} \max_{m=0, \ldots, kH-1} \max_{n=0, \ldots, kW-1}
\text{input}(N_i, C_j, stride[0] \times d + l, stride[1] \times h + m, stride[2] \times w + n)
**参数:**
参数:
- **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小。整数类型表示池化核深度、高和宽或者是三个整数组成的元组表示深、高和宽。默认值1。
- **strides** (Union[int, tuple[int]]) - 池化操作的移动步长整数类型表示深、高和宽的移动步长或者是三个整数组成的元组表示深、高和宽移动步长。默认值1。
- **pad_mode** (str) - 指定池化填充模式,可选值有:"same"、"valid"或"pad"。默认值:"valid"。
- **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小。整数类型表示池化核深度、高和宽或者是三个整数组成的元组表示深、高和宽。默认值1。
- **strides** (Union[int, tuple[int]]) - 池化操作的移动步长整数类型表示深、高和宽的移动步长或者是三个整数组成的元组表示深、高和宽移动步长。默认值1。
- **pad_mode** (str) - 指定池化填充模式,可选值有:"same"、"valid"或"pad"。默认值:"valid"
- same输出的宽度于输入整数 `stride` 后的值相同
- valid在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃
- pad对输入进行填充。在输入的深度、高度和宽度方向上填充 `pad` 大小的0。如果设置此模式 `pad_list` 必须大于或等于0
- same输出的宽度于输入整数 `stride` 后的值相同。
- valid在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃
- pad对输入进行填充。 在输入的深度、高度和宽度方向上填充 `pad` 大小的0。如果设置此模式 `pad_list` 必须大于或等于0
- **pad_list** (Union(int, tuple[int])) - 池化填充方式。默认值0。如果 `pad` 是一个整数,则头尾部、顶部,底部,左边和右边的填充都是相同的,等于 `pad` 。如果 `pad` 是六个整数的tuple则头尾部、顶部、底部、左边和右边的填充分别等于填充pad[0]、pad[1]、pad[2]、pad[3]、pad[4]和pad[5]。
- **ceil_mode** (Union[bool, None]) - 是否使用ceil函数计算输出高度和宽度。默认值None
- **data_format** (str) - 输入和输出的数据格式。目前仅支持'NCDHW'。默认值:'NCDHW'
- **pad_list** (Union(int, tuple[int])) - 池化填充方式。默认值0。如果 `pad` 是一个整数,则头尾部、顶部,底部,左边和右边的填充都是相同的,等于 `pad` 。如果 `pad` 是六个整数的tuple则头尾部、顶部、底部、左边和右边的填充分别等于填充pad[0]、pad[1]、pad[2]、pad[3]、pad[4]和pad[5]。
- **ceil_mode** (Union[bool, None]) - 是否使用ceil函数计算输出高度和宽度。默认值None。
- **data_format** (str) - 输入和输出的数据格式。目前仅支持'NCDHW'。默认值:'NCDHW'。
输入:
- **x** (Tensor) - shape为 :math:`(N, C, D_{in}, H_{in}, W_{in})` 的Tensor。数据类型为float16或float32。
**输入:**
输出:
Tensorshape为 :math:`(N, C, D_{out}, H_{out}, W_{out})` 。数据类型与 `x` 相同。
- **x** (Tensor) - shape为 :math:`(N, C, D_{in}, H_{in}, W_{in})` 的Tensor。数据类型为float16或float32。
**输出:**
Tensorshape为 :math:`(N, C, D_{out}, H_{out}, W_{out})` 。数据类型与 `x` 相同。
**异常:**
- **TypeError** - `kernel_size``strides` 既不是int也不是元组。
- **TypeError** - `pad_mode``data_format` 不是str。
- **ValueError** - `kernel_size``strides` 不是正数。
- **ValueError** - `pad_mode` 不是'same''valid',或'pad'。
- **ValueError** - `pad_mode` 取值为'same'或'valid' `ceil_mode` 取值不是None。
- **ValueError** - `kernel_size``strides` 是长度不等于3的元组。
- **ValueError** - `data_format` 不是'NCDHW'。
异常:
- **TypeError** - `kernel_size``strides` 既不是int也不是元组。
- **TypeError** - `pad_mode``data_format` 不是str。
- **ValueError** - `kernel_size``strides` 不是正数。
- **ValueError** - `pad_mode` 不是'same''valid',或'pad'。
- **ValueError** - `pad_mode` 取值为'same'或'valid' `ceil_mode` 取值不是None。
- **ValueError** - `kernel_size``strides` 是长度不等于3的元组。
- **ValueError** - `data_format` 不是'NCDHW'。

View File

@ -13,33 +13,29 @@ mindspore.ops.MaxPool3DWithArgmax
\max_{l=0, \ldots, d_{ker}-1} \max_{m=0, \ldots, h_{ker}-1} \max_{n=0, \ldots, w_{ker}-1}
\text{input}(N_i, C_j, s_0 \times d + l, s_1 \times h + m, s_2 \times w + n)
**参数:**
参数:
- **ksize** (Union[int, tuple[int]]) - 池化核尺寸大小。可以是一个整数表示池化核的深度高度和宽度或者包含三个整数的tuple分别表示池化核的深度高度和宽度。
- **strides** (Union[int, tuple[int]]) - 池化操作的移动步长。可以是一个整数表示在深度高度和宽度方向的移动步长或者包含三个整数的tuple分别表示在深度高度和宽度方向的移动步长。
- **pads** (Union[int, tuple[int]]) - 池化填充长度。可以是一个整数表示在深度高度和宽度方向的填充长度或者包含三个整数的tuple分别表示在深度高度和宽度方向的填充长度。
- **dilation** (Union[int, tuple[int]]) - 控制池化核内元素的间距。默认为(1, 1, 1)。
- **ceil_mode** (bool) - 是否是用ceil代替floor来计算输出的shape。默认为False。
- **data_format** (str) - 选择输入数据格式,当前仅支持'NDCHW'。默认为'NDCHW'。
- **argmax_type** (mindspore.dtype) - 返回的最大值索引的数据类型。默认为mindspore.int64。
- **ksize** (Union[int, tuple[int]]) - 池化核尺寸大小。可以是一个整数表示池化核的深度高度和宽度或者包含三个整数的tuple分别表示池化核的深度高度和宽度。
- **strides** (Union[int, tuple[int]]) - 池化操作的移动步长。可以是一个整数表示在深度高度和宽度方向的移动步长或者包含三个整数的tuple分别表示在深度高度和宽度方向的移动步长。
- **pads** (Union[int, tuple[int]]) - 池化填充长度。可以是一个整数表示在深度高度和宽度方向的填充长度或者包含三个整数的tuple分别表示在深度高度和宽度方向的填充长度。
- **dilation** (Union[int, tuple[int]]) - 控制池化核内元素的间距。默认为(1, 1, 1)。
- **ceil_mode** (bool) - 是否是用ceil代替floor来计算输出的shape。默认为False。
- **data_format** (str) - 选择输入数据格式,当前仅支持'NDCHW'。默认为'NDCHW'。
- **argmax_type** (mindspore.dtype) - 返回的最大值索引的数据类型。默认为mindspore.int64。
输入:
- **x** (Tensor) - shape为 :math:`(N_{in}, C_{in}, D_{in}, H_{in}, W_{in})` 的Tensor。支持数据类型包括int8、int16、int32、int64、uint8、uint16、uint32、uint64、float16、float32和float64。
**输入:**
输出:
包含两个Tensor的tuple分别表示最大值结果和最大值对应的索引。
- **x** (Tensor) - shape为 :math:`(N_{in}, C_{in}, D_{in}, H_{in}, W_{in})` 的Tensor。支持数据类型包括int8、int16、int32、int64、uint8、uint16、uint32、uint64、float16、float32和float64。
- **output** (Tensor) - 输出的池化后的最大值,其数据类型与 `x` 相同。
- **argmax** (Tensor) - 输出的最大值对应的索引数据类型为int32或者int64。
**输出:**
包含两个Tensor的tuple分别表示最大值结果和最大值对应的索引。
- **output** (Tensor) - 输出的池化后的最大值,其数据类型与 `x` 相同。
- **argmax** (Tensor) - 输出的最大值对应的索引数据类型为int32或者int64。
**异常:**
- **TypeError** - `x` 不是Tensor。
- **ValueError** - `x` 的维度不是5D。
- **TypeError** - `ksize``strides``pads``dilation` 不是int或者tuple。
- **ValueError** - `ksize``strides` 的元素值小于1。
- **ValueError** - `pads` 的元素值小于0。
- **ValueError** - `data_format` 不是'NCDHW'。
- **ValueError** - `argmax_type` 不是mindspore.int64或mindspore.int32。
异常:
- **TypeError** - `x` 不是Tensor。
- **ValueError** - `x` 的维度不是5D。
- **TypeError** - `ksize``strides``pads``dilation` 不是int或者tuple。
- **ValueError** - `ksize``strides` 的元素值小于1。
- **ValueError** - `pads` 的元素值小于0。
- **ValueError** - `data_format` 不是'NCDHW'。
- **ValueError** - `argmax_type` 不是mindspore.int64或mindspore.int32。

View File

@ -11,30 +11,26 @@ mindspore.ops.MaxPoolWithArgmax
\text{output}(N_i, C_j, h, w) = \max_{m=0, \ldots, kH-1} \max_{n=0, \ldots, kW-1}\\
\text{input}(N_i, C_j, stride[0] \times h + m, stride[1] \times w + n)
**参数:**
参数:
- **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小。由一个整数或者是两个整数组成的tuple表示高和宽。默认值1。
- **strides** (Union[int, tuple[int]]) - 池化操作的移动步长由一个整数或者是两个整数组成的tuple表示高和宽移动步长。默认值1。
- **pad_mode** (str) - 指定池化填充模式,可选值是'same'或'valid',不区分大小写。默认值:'valid'。
- **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小。由一个整数或者是两个整数组成的tuple表示高和宽。默认值1。
- **strides** (Union[int, tuple[int]]) - 池化操作的移动步长由一个整数或者是两个整数组成的tuple表示高和宽移动步长。默认值1。
- **pad_mode** (str) - 指定池化填充模式,可选值是'same'或'valid',不区分大小写。默认值:'valid'。
- **same** - 输出的高度和宽度分别与输入整除 `stride` 后的值相同。
- **valid** - 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。
- **same** - 输出的高度和宽度分别与输入整除 `stride` 后的值相同。
- **valid** - 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。
- **data_format** (str) - 输入和输出的数据格式。可选值为'NHWC'或'NCHW'。默认值:'NCHW'。
- **data_format** (str):输入和输出的数据格式。可选值为'NHWC'或'NCHW'。默认值:'NCHW'。
输入:
- **x** (Tensor) - shape为 :math:`(N, C_{in}, H_{in}, W_{in})` 的Tensor。数据类型必须为float16或float32。
**输入:**
输出:
两个Tensor组成的tuple表示最大池化结果和生成最大值的位置。
- **x** (Tensor) - shape为 :math:`(N, C_{in}, H_{in}, W_{in})` 的Tensor。数据类型必须为float16或float32。
- **output** (Tensor) - 输出最大池结果shape为 :math:`(N, C_{out}, H_{out}, W_{out})` 。其数据类型与 `x` 的相同。
- **mask** (Tensor) - 输出最大值索引。数据类型为int32。
**输出:**
两个Tensor组成的tuple表示最大池化结果和生成最大值的位置。
- **output** (Tensor) - 输出最大池结果shape为 :math:`(N, C_{out}, H_{out}, W_{out})` 。其数据类型与 `x` 的相同。
- **mask** (Tensor) - 输出最大值索引。数据类型为int32。
**异常:**
- **TypeError** - `x` 的数据类型既不是float16也不是float32。
- **TypeError** - `kernel_size``strides` 既不是int也不是tuple。
- **TypeError** - `x` 不是Tensor。
异常:
- **TypeError** - `x` 的数据类型既不是float16也不是float32。
- **TypeError** - `kernel_size``strides` 既不是int也不是tuple。
- **TypeError** - `x` 不是Tensor。

View File

@ -5,29 +5,25 @@ mindspore.ops.MirrorPad
通过指定的填充模式和大小对输入Tensor进行填充。
**参数:**
参数:
- **mode** (str) - 指定填充模式。可选值:"REFLECT"和"SYMMETRIC"。
默认值:"REFLECT"。
- **mode** (str) - 指定填充模式。可选值:"REFLECT"和"SYMMETRIC"。
默认值:"REFLECT"。
输入:
- **input_x** (Tensor) - shape: :math:`(N, *)` ,其中 :math:`*` 表示任何数量的附加维度。
- **paddings** (Tensor) - shape为 :math:`(N, 2)` 的矩阵。N为输入Tensor的秩。int类型。
对于输入的第 `D` 个维度,`paddings[D, 0]` 表示需在输入第 `D` 维头部填充的数量,`paddings[D, 1]` 表示需在输入第 `D` 维尾部填充的数量。
**输入:**
输出:
填充后的Tensor。
- **input_x** (Tensor) - shape: :math:`(N, *)` ,其中 :math:`*` 表示任何数量的附加维度。
- **paddings** (Tensor) - shape为 :math:`(N, 2)` 的矩阵。N为输入Tensor的秩。int类型。
对于输入的第 `D` 个维度,`paddings[D, 0]` 表示需在输入第 `D` 维头部填充的数量,`paddings[D, 1]` 表示需在输入第 `D` 维尾部填充的数量。
- 如果设置 `mode` 为"REFLECT",将使用对称轴对称复制的方式来进行填充。
如果 `input_x` 为[[1,2,3][4,5,6][7,8,9]] `paddings` 为[[1,1], [2,2]],则输出为[[6,5,4,5,6,5,4][3,2,1,2,3,2,1][6,5,4,5,6,5,4][9,8,7,8,9,8,7][6,5,4,5,6,5,4]]。
更直观的理解请参见下面的样例。
- 如果 `mode` 为"SYMMETRIC",则填充方法类似于"REFLECT"。它也会根据对称轴复制,但是也包括对称轴。如果 `input_x` 为[[1,2,3],[4,5,6],[7,8,9]]] `paddings` 为[[1,1], [2,2]],则输出为[[2,1,1,2,3,3,2][2,1,1,2,3,3,2][5,4,4,5,6,6,5][8,7,7,8,9,9,8][8,7,7,8,9,9,8]]。
更直观的理解请参见下面的样例。
**输出:**
填充后的Tensor。
- 如果设置 `mode` 为"REFLECT",将使用对称轴对称复制的方式来进行填充。
如果 `input_x` 为[[1,2,3][4,5,6][7,8,9]] `paddings` 为[[1,1], [2,2]],则输出为[[6,5,4,5,6,5,4][3,2,1,2,3,2,1][6,5,4,5,6,5,4][9,8,7,8,9,8,7][6,5,4,5,6,5,4]]。
更直观的理解请参见下面的样例。
- 如果 `mode` 为"SYMMETRIC",则填充方法类似于"REFLECT"。它也会根据对称轴复制,但是也包括对称轴。如果 `input_x` 为[[1,2,3],[4,5,6],[7,8,9]]] `paddings` 为[[1,1], [2,2]],则输出为[[2,1,1,2,3,3,2][2,1,1,2,3,3,2][5,4,4,5,6,6,5][8,7,7,8,9,9,8][8,7,7,8,9,9,8]]。
更直观的理解请参见下面的样例。
**异常:**
- **TypeError** - `input_x``padings` 不是Tensor。
- **TypeError** - `mode` 不是str。
- **ValueError** - `paddings.size` 不等于2 * len(`input_x`)。
异常:
- **TypeError** - `input_x``padings` 不是Tensor。
- **TypeError** - `mode` 不是str。
- **ValueError** - `paddings.size` 不等于2 * len(`input_x`)。

View File

@ -12,14 +12,11 @@
更多详细信息请参见 `A Self Regularized Non-Monotonic Neural Activation Function <https://arxiv.org/abs/1908.08681>`_
**输入:**
输入:
- **x** (Tensor) - shape: :math:`(N, *)` ,其中 :math:`*` 表示任意数量的附加维度数据类型支持float16或float32。
- **x** (Tensor) - shape: :math:`(N, *)` ,其中 :math:`*` 表示任意数量的附加维度数据类型支持float16或float32。
输出:
Tensor`x` 的shape和数据类型相同。
**输出:**
Tensor`x` 的shape和数据类型相同。
**异常:**
- **TypeError** - `x` 的数据类型非float16或float32。
异常:
- **TypeError** - `x` 的数据类型非float16或float32。

View File

@ -16,17 +16,14 @@
- 由于架构的差异在NPU和CPU上生成的结果可能不一致。
- 如果shape表示为 :math:`(D1、D2...、Dn)` 则D1\*D2... \*DN<=1000000,n<=8。
**输入:**
输入:
- **x** (Union[Tensor, numbers.Number, bool]) - 第一个输入是数值型、bool或数据类型为数值型的Tensor。
- **y** (Union[Tensor, numbers.Number, bool]) - 当第一个输入是Tensor时第二个输入可以是数值型、bool或数据类型为数值型的Tensor。当第一个输入是数值型或bool时第二个输入必须是数据类型为数值型的Tensor。
- **x** (Union[Tensor, numbers.Number, bool]) - 第一个输入是数值型、bool或数据类型为数值型的Tensor。
- **y** (Union[Tensor, numbers.Number, bool]) - 当第一个输入是Tensor时第二个输入可以是数值型、bool或数据类型为数值型的Tensor。当第一个输入是数值型或bool时第二个输入必须是数据类型为数值型的Tensor
输出:
Tensorshape与广播后的shape相同数据类型为两个输入中精度较高或数据类型相对最高的类型
**输出:**
Tensorshape与广播后的shape相同数据类型为两个输入中精度较高或数据类型相对最高的类型。
**异常:**
- **TypeError** - 如果 `x``y` 都不是以下之一Tensor、数值型、bool。
- **TypeError** - 如果 `x``y` 都不是Tensor。
- **ValueError** - 如果 `x``y` 的shape不能相互广播。
异常:
- **TypeError** - 如果 `x``y` 都不是以下之一Tensor、数值型、bool。
- **TypeError** - 如果 `x``y` 都不是Tensor。
- **ValueError** - 如果 `x``y` 的shape不能相互广播。

View File

@ -16,16 +16,13 @@
.. note::
`x``y` 的shape应该相同或者可以广播。如果 `y` 是NaN或为无限的并且 `x` 是0结果将是NaN。
**输入:**
输入:
- **x** (Union[Tensor]) - 第一个输入是Tensor其数据类型为int32、int64、float16、float32、float64、complex64、complex128或Scalar。
- **y** (Union[Tensor]) - 第二个输入是Tensor其数据类型为int32、int64、float16、float32、float64、complex64、complex128或Scalar。
- **x** (Union[Tensor]) - 第一个输入是Tensor其数据类型为int32、int64、float16、float32、float64、complex64、complex128或Scalar。
- **y** (Union[Tensor]) - 第二个输入是Tensor其数据类型为int32、int64、float16、float32、float64、complex64、complex128或Scalar
输出:
Tensorshape与广播后的shape相同数据类型是两个输入中精度较高的类型
**输出:**
异常:
- **TypeError** - 如果 `x``y` 都不是Tensor。
Tensorshape与广播后的shape相同数据类型是两个输入中精度较高的类型。
**异常:**
- **TypeError** - 如果 `x``y` 都不是Tensor。

View File

@ -22,24 +22,20 @@ mindspore.ops.NLLLoss
\sum_{n=1}^{N} l_{n}, & \text { if reduction }=\text { 'sum' }
\end{array}\right.
**参数:**
参数:
- **reduction** (str) - 指定应用于输出结果的计算方式,比如'none'、'mean''sum',默认值:"mean"。
- **reduction** (str) - 指定应用于输出结果的计算方式,比如'none'、'mean''sum',默认值:"mean"。
输入:
- **logits** (Tensor) - 输入预测值shape为 :math:`(N, C)` 。数据类型仅支持float32或float16。
- **labels** (Tensor) - 输入目标值shape为 :math:`(N,)` 。数据类型仅支持int32。
- **weight** (Tensor) - 指定各类别的权重shape为 :math:`(C,)` 数据类型仅支持float32或float16。
**输入:**
输出:
`loss``total_weight` 组成的2个Tensor的tuple。
- **logits** (Tensor) - 输入预测值shape为 :math:`(N, C)` 。数据类型仅支持float32或float16。
- **labels** (Tensor) - 输入目标值shape为 :math:`(N,)` 。数据类型仅支持int32。
- **weight** (Tensor) - 指定各类别的权重shape为 :math:`(C,)` 数据类型仅支持float32或float16。
- **loss** (Tensor) - 当 `reduction` 为'none'且 `logits` 为2维Tensor时 `loss` 的shape为 :math:`(N,)` 。否则, `loss` 为scalar。数据类型与 `logits` 相同。
- **total_weight** (Tensor) - `total_weight` 是scalar数据类型与 `weight` 相同。
**输出:**
`loss``total_weight` 组成的2个Tensor的tuple。
- **loss** (Tensor) - 当 `reduction` 为'none'且 `logits` 为2维Tensor时 `loss` 的shape为 :math:`(N,)` 。否则, `loss` 为scalar。数据类型与 `logits` 相同。
- **total_weight** (Tensor) - `total_weight` 是scalar数据类型与 `weight` 相同。
**异常:**
- **TypeError** - `logits``weight` 的数据类型既不是float16也不是float32 `labels` 不是int32。
- **ValueError** - `logits` 不是一维或二维Tensor `labels``weight` 不是一维Tensor。 `logits` 是二维Tensor时 `logits` 的第一个维度不等于 `labels` `logits` 的第二个维度不等于 `weight``logits` 是一维Tensor时 `logits``labels``weight` 的维度应该相同。
异常:
- **TypeError** - `logits``weight` 的数据类型既不是float16也不是float32 `labels` 不是int32。
- **ValueError** - `logits` 不是一维或二维Tensor `labels``weight` 不是一维Tensor。 `logits` 是二维Tensor时 `logits` 的第一个维度不等于 `labels` `logits` 的第二个维度不等于 `weight``logits` 是一维Tensor时 `logits``labels``weight` 的维度应该相同。

View File

@ -13,24 +13,20 @@
.. warning::
一次最多支持2864个输入框。
**参数:**
参数:
- **iou_threshold** (float) - 指定删除框的IOU的阈值。默认值0.5。
- **iou_threshold** (float) - 指定删除框的IOU的阈值。默认值0.5。
输入:
- **bboxes** (Tensor) - 边界框shape: :math:`(N, 5)` `N` 为边界框的数量。每个边界框包含5个值前4个值为边界框的坐标x0、y0、x1、y1代表左上角和右下角的点。最后一个值为边界框的分数。数据类型支持float16或float32。
**输入:**
输出:
tuple[Tensor]包含三个Tensoroutput_boxes、output_idx和selected_mask。
- **bboxes** (Tensor) - 边界框shape: :math:`(N, 5)` `N` 为边界框的数量。每个边界框包含5个值前4个值为边界框的坐标x0、y0、x1、y1代表左上角和右下角的点。最后一个值为边界框的分数。数据类型支持float16或float32。
- **output_boxes** (Tensor) - shape: :math:`(N, 5)` 。在GPU和CPU平台上它是一个边界框的排序列表按分数对输入 `bboxes` 进行降序排序。在Ascend平台上它与输入 `bboxes` 相同。
- **output_idx** (Tensor) - shape: :math:`(N,)``output_boxes` 的索引列表。
- **selected_mask** (Tensor) - shape: :math:`(N,)` 。输出边界框的掩码列表。在 `output_boxes` 上应用此掩码以获取非极大值抑制算法NMS计算后的边界框或在 `output_idx` 上应用此掩码以获取边界框索引。
**输出:**
tuple[Tensor]包含三个Tensoroutput_boxes、output_idx和selected_mask。
- **output_boxes** (Tensor) - shape: :math:`(N, 5)` 。在GPU和CPU平台上它是一个边界框的排序列表按分数对输入 `bboxes` 进行降序排序。在Ascend平台上它与输入 `bboxes` 相同。
- **output_idx** (Tensor) - shape: :math:`(N,)``output_boxes` 的索引列表。
- **selected_mask** (Tensor) - shape: :math:`(N,)` 。输出边界框的掩码列表。在 `output_boxes` 上应用此掩码以获取非极大值抑制算法NMS计算后的边界框或在 `output_idx` 上应用此掩码以获取边界框索引。
**异常:**
- **ValueError** - `iou_threshold` 不是float。
- **ValueError** - 输入Tensor的第一个维度小于或等于0。
- **TypeError** - `bboxes` 的数据类型非float16或float32。
异常:
- **ValueError** - `iou_threshold` 不是float。
- **ValueError** - 输入Tensor的第一个维度小于或等于0。
- **TypeError** - `bboxes` 的数据类型非float16或float32。

View File

@ -12,18 +12,15 @@ mindspore.ops.scatter_update
输入的 `input_x``updates` 遵循隐式类型转换规则以确保数据类型一致。如果它们具有不同的数据类型则低精度数据类型将转换为高精度数据类型。因Parameter对象不支持类型转换`input_x` 为低精度数据类型时,会抛出异常。
**参数:**
参数:
- **input_x** (Parameter) - scatter_update的输入任意维度的Parameter。
- **indices** (Tensor) - 指定更新操作的索引。数据类型为int32或者int64。如果索引中存在重复项则更新的顺序无法得知。
- **updates** (Tensor) - 指定与 `input_x` 更新操作的Tensor其数据类型与 `input_x` 相同shape为 `indices.shape + input_x.shape[1:]`
- **input_x** (Parameter) - scatter_update的输入任意维度的Parameter。
- **indices** (Tensor) - 指定更新操作的索引。数据类型为int32或者int64。如果索引中存在重复项则更新的顺序无法得知。
- **updates** (Tensor) - 指定与 `input_x` 更新操作的Tensor其数据类型与 `input_x` 相同shape为 `indices.shape + input_x.shape[1:]`
返回:
Tensorshape和数据类型与输入 `input_x` 相同。
**返回:**
Tensorshape和数据类型与输入 `input_x` 相同。
**异常:**
- **TypeError** - `indices` 不是int32或者int64。
- **ValueError** - `updates` 的shape不等于 `indices.shape + input_x.shape[1:]`
- **RuntimeError** - 当 `input_x``updates` 类型不一致,需要进行类型转换时,如果 `updates` 不支持转成参数 `input_x` 需要的数据类型,就会报错。
异常:
- **TypeError** - `indices` 不是int32或者int64。
- **ValueError** - `updates` 的shape不等于 `indices.shape + input_x.shape[1:]`
- **RuntimeError** - 当 `input_x``updates` 类型不一致,需要进行类型转换时,如果 `updates` 不支持转成参数 `input_x` 需要的数据类型,就会报错。

View File

@ -14,22 +14,18 @@ mindspore.ops.select
y_i, & \text{otherwise}
\end{cases}
**参数:**
参数:
- **cond** (Tensor[bool]) - 条件Tensor决定选择哪一个元素shape是 :math:`(x_1, x_2, ..., x_N, ..., x_R)`
- **x** (Union[Tensor, int, float]) - 第一个被选择的Tensor或者数字。
如果x是一个Tensor那么shape是 :math:`(x_1, x_2, ..., x_N, ..., x_R)`
如果x是int或者float那么将会被转化为int32或者float32类型并且被广播为与y相同的shape。x和y中至少要有一个Tensor。
- **y** (Union[Tensor, int, float]) - 第二个被选择的Tensor或者数字。
如果y是一个Tensor那么shape是 :math:`(x_1, x_2, ..., x_N, ..., x_R)`
如果y是int或者float那么将会被转化为int32或者float32类型并且被广播为与x相同的shape。x和y中至少要有一个Tensor。
- **cond** (Tensor[bool]) - 条件Tensor 决定选择哪一个元素shape是 :math:`(x_1, x_2, ..., x_N, ..., x_R)`
- **x** (Union[Tensor, int, float]) - 第一个被选择的Tensor或者数字。
如果x是一个Tensor那么shape是 :math:`(x_1, x_2, ..., x_N, ..., x_R)`
如果x是int或者float 那么将会被转化为int32或者float32类型并且被广播为与y相同的shape。x和y中至少要有一个Tensor。
- **y** (Union[Tensor, int, float]) - 第二个被选择的Tensor或者数字。
如果y是一个Tensor那么shape是 :math:`(x_1, x_2, ..., x_N, ..., x_R)`
如果y是int或者float 那么将会被转化为int32或者float32类型并且被广播为与x相同的shape。x和y中至少要有一个Tensor。
返回:
Tensor`cond` 的shape相同。
**返回:**
Tensor`cond` 的shape相同。
**异常:**
- **TypeError** - `x``y` 不是Tensor、int或者float。
- **ValueError** - 输入的shape不同。
异常:
- **TypeError** - `x``y` 不是Tensor、int或者float。
- **ValueError** - 输入的shape不同。

View File

@ -19,14 +19,11 @@ mindspore.ops.selu
更多详细信息,请参见 `Self-Normalizing Neural Networks <https://arxiv.org/abs/1706.02515>`_
**参数:**
参数:
- **input_x** (Tensor) - 任意维度的Tensor数据类型为int8、int32、float16、float32、float64仅CPU、GPU
- **input_x** (Tensor) - 任意维度的Tensor数据类型为int8、int32、float16、float32、float64仅CPU、GPU
返回:
Tensor数据类型和shape与 `input_x` 的相同。
**返回:**
Tensor数据类型和shape与 `input_x` 的相同。
**异常:**
- **TypeError** - `input_x` 的数据类型不是int8、int32、float16、float32、float64。
异常:
- **TypeError** - `input_x` 的数据类型不是int8、int32、float16、float32、float64。

View File

@ -7,17 +7,14 @@
如果 `lengths` 的shape为 :math:`(d_1, d_2, ..., d_n)` 则生成的Tensor掩码拥有数据类型其shape为 :math:`(d_1, d_2, ..., d_n, maxlen)` 且mask :math:`[i_1, i_2, ..., i_n, j] = (j < lengths[i_1, i_2, ..., i_n])`
**参数:**
参数:
- **lengths** (Tensor) - 用来计算掩码的Tensor一般代表长度。此Tensor中的所有值都应小于或等于 `maxlen` 。大于 `maxlen` 的值将被视为 `maxlen` 。其数据类型为int32或int64。
- **maxlen** (int) - 指定返回Tensor的长度。其值为正数且与 `lengths` 中的元素数据类型相同。默认为None。
- **lengths** (Tensor) - 用来计算掩码的Tensor一般代表长度。此Tensor中的所有值都应小于或等于 `maxlen` 。大于 `maxlen` 的值将被视为 `maxlen` 。其数据类型为int32或int64。
- **maxlen** (int) - 指定返回Tensor的长度。其值为正数且与 `lengths` 中的元素数据类型相同。默认为None
返回:
返回一个Tensorshape为 `lengths.shape + (maxlen,)`
**返回:**
返回一个Tensorshape为 `lengths.shape + (maxlen,)`
**异常:**
- **TypeError** - `lengths` 不是Tensor。
- **TypeError** - `maxlen` 不是int。
- **TypeError** - `lengths` 的数据类型既不是int32也不是int64。
异常:
- **TypeError** - `lengths` 不是Tensor。
- **TypeError** - `maxlen` 不是int。
- **TypeError** - `lengths` 的数据类型既不是int32也不是int64。

View File

@ -5,14 +5,11 @@ mindspore.ops.size
返回一个Scalar类型为整数表示输入Tensor的大小即Tensor中元素的总数。
**参数:**
参数:
- **input_x** (Tensor) - 输入参数shape为 :math:`(x_1, x_2, ..., x_R)` 。数据类型为 `number <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_
- **input_x** (Tensor) - 输入参数shape为 :math:`(x_1, x_2, ..., x_R)` 。数据类型为 `number <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_
返回:
整数,表示 `input_x` 元素大小的Scalar。它的值为 :math:`size=x_1*x_2*...x_R`
**返回:**
整数,表示 `input_x` 元素大小的Scalar。它的值为 :math:`size=x_1*x_2*...x_R`
**异常:**
- **TypeError** - `input_x` 不是Tensor。
异常:
- **TypeError** - `input_x` 不是Tensor。

View File

@ -12,16 +12,13 @@ mindspore.ops.slice
如果 `size[i]` 为-1则维度i中的所有剩余元素都包含在切片中。这相当于 :math:`size[i] = input_x.shape(i) - begin[i]`
**参数:**
参数:
- **input_x** (Tensor) - Slice的输入任意维度的Tensor。
- **begin** (Union[tuple, list]) - 切片的起始位置。只支持常量值(>=0
- **size** (Union[tuple, list]) - 切片的大小。只支持常量值。
- **input_x** (Tensor) - Slice的输入任意维度的Tensor。
- **begin** (Union[tuple, list]) - 切片的起始位置。只支持常量值(>=0
- **size** (Union[tuple, list]) - 切片的大小。只支持常量值。
返回:
Tensorshape与输入 `size` 相同,数据类型与输入 `input_x` 的相同。
**返回:**
Tensorshape与输入 `size` 相同,数据类型与输入 `input_x` 的相同。
**异常:**
- **TypeError** - `begin``size` 既不是tuple也不是list。
异常:
- **TypeError** - `begin``size` 既不是tuple也不是list。

View File

@ -30,21 +30,18 @@ mindspore.ops.smooth_l1_loss
.. note::
在Ascend上目前不支持将 `reduction` 设定成'sum'或'mean'。
**参数:**
参数:
- **logits** (Tensor) - shape :math:`(N, *)` ,其中 :math:`*` 表示任意数量的附加维度。数据类型支持float16、float32或float64。
- **labels** (Tensor) - shape :math:`(N, *)` ,与 `logits` 的shape和数据类型相同。
- **beta** (float) - 控制损失函数在L1Loss和L2Loss间变换的阈值。默认值1.0。
- **reduction** (str) - 缩减输出的方法。默认值:'none'。 其他选项:'mean'和'sum'。
- **logits** (Tensor) - shape :math:`(N, *)` ,其中 :math:`*` 表示任意数量的附加维度。数据类型支持float16、float32或float64。
- **labels** (Tensor) - shape :math:`(N, *)` ,与 `logits` 的shape和数据类型相同。
- **beta** (float) - 控制损失函数在L1Loss和L2Loss间变换的阈值。默认值1.0。
- **reduction** (str) - 缩减输出的方法。默认值:'none'。 其他选项:'mean'和'sum'。
返回:
Tensor。如果 `reduction` 为'none'则输出为Tensor且与 `logits` 的shape相同。否则shape为 `(1,)`
**返回:**
Tensor。如果 `reduction` 为'none'则输出为Tensor且与 `logits` 的shape相同。否则shape为 `(1,)`
**异常:**
- **TypeError** - `beta` 不是float类型。
- **ValueError** - `reduction` 不是'none''mean'和'sum'中的任一者。
- **TypeError** - `logits``labels` 的数据类型不是float16float32和float64中的任一者。
- **ValueError** - `beta` 小于或等于0。
- **ValueError** - `logits``labels` 的shape不同。
异常:
- **TypeError** - `beta` 不是float类型。
- **ValueError** - `reduction` 不是'none''mean'和'sum'中的任一者。
- **TypeError** - `logits``labels` 的数据类型不是float16float32和float64中的任一者。
- **ValueError** - `beta` 小于或等于0。
- **ValueError** - `logits``labels` 的shape不同。

View File

@ -13,18 +13,15 @@ mindspore.ops.soft_shrink
0, & \text{ otherwise }
\end{cases}
**参数:**
参数:
- **x** (Tensor) - Soft Shrink的输入数据类型为float16或float32。
- **lambd** (float) - :math:`\lambda` 应大于等于0。默认值0.5。
- **x** (Tensor) - Soft Shrink的输入数据类型为float16或float32。
- **lambd** (float) - :math:`\lambda` 应大于等于0。默认值0.5
返回:
Tensorshape和数据类型与输入相同
**返回:**
Tensorshape和数据类型与输入相同。
**异常:**
- **TypeError** - `lambd` 不是float。
- **TypeError** - `x` 不是Tensor。
- **TypeError** - `x` 的dtype既不是float16也不是float32。
- **ValueError** - `lambd` 小于0。
异常:
- **TypeError** - `lambd` 不是float。
- **TypeError** - `x` 不是Tensor。
- **TypeError** - `x` 的dtype既不是float16也不是float32。
- **ValueError** - `lambd` 小于0。

View File

@ -10,15 +10,12 @@ mindspore.ops.softsign
.. math::
\text{SoftSign}(x) = \frac{x}{1 + |x|}
**参数:**
参数:
- **x** (Tensor) - shape为 :math:`(N, *)` 的Tensor其中 :math:`*` 表示任意个数的维度。它的数据类型必须为float16或float32。
- **x** (Tensor) - shape为 :math:`(N, *)` 的Tensor, 其中 :math:`*` 表示任意个数的维度。它的数据类型必须为float16或float32。
返回:
Tensor数据类型和shape与 `x` 相同。
**返回:**
Tensor数据类型和shape与 `x` 相同。
**异常:**
- **TypeError** - `x` 不是Tensor。
- **TypeError** - `x` 的数据类型既不是float16也不是float32。
异常:
- **TypeError** - `x` 不是Tensor。
- **TypeError** - `x` 的数据类型既不是float16也不是float32。

View File

@ -21,22 +21,19 @@ mindspore.ops.space_to_batch_nd
Ascend只支持四维张量的输入。
**参数:**
参数:
- **input_x** (Tensor) - 输入张量Ascend平台必须为四维。
- **block_size** (list[int], tuple[int], int) - 块形状描述空间维度为分割的个数。如果 `block_size` 为list或者tuple其长度 `M` 为空间维度的长度。如果 `block_size` 为整数,那么所有空间维度分割的个数均为 `block_size` 。在Ascend后端 `M` 必须为2。
- **paddings** (tuple, list) - 空间维度的填充大小。
- **input_x** (Tensor) - 输入张量Ascend平台必须为四维。
- **block_size** (list[int], tuple[int], int) - 块形状描述空间维度为分割的个数。如果 `block_size` 为list或者tuple其长度 `M` 为空间维度的长度。如果 `block_size` 为整数,那么所有空间维度分割的个数均为 `block_size` 。在Ascend后端 `M` 必须为2。
- **paddings** (tuple, list) - 空间维度的填充大小。
返回:
Tensor经过划分排列之后的结果。
**返回:**
Tensor经过划分排列之后的结果。
**异常:**
- **TypeError** - 如果 `block_size` 不是 list, tuple 或者 int。
- **TypeError** - 如果 `paddings` 不是 list 或者 tuple。
- **ValueError** - 如果当 `block_size` 为 list 或 tuple `block_size` 不是一维。
- **ValueError** - 如果 Ascend 平台上 `block_size` 长度不是2。
- **ValueError** - 如果 `paddings` 的形状不是 (2, M), 其中 M 为 `block_size` 的长度。
- **ValueError** - 如果 `block_size` 的元素不是大于一的整数。
- **ValueError** - 如果 `paddings` 的元素不是非负的整数。
异常:
- **TypeError** - 如果 `block_size` 不是 list, tuple 或者 int。
- **TypeError** - 如果 `paddings` 不是 list 或者 tuple。
- **ValueError** - 如果当 `block_size` 为 list 或 tuple `block_size` 不是一维。
- **ValueError** - 如果 Ascend 平台上 `block_size` 长度不是2。
- **ValueError** - 如果 `paddings` 的形状不是 (2, M), 其中 M 为 `block_size` 的长度。
- **ValueError** - 如果 `block_size` 的元素不是大于一的整数。
- **ValueError** - 如果 `paddings` 的元素不是非负的整数。

View File

@ -5,28 +5,25 @@ mindspore.ops.sparse_add
两个COOTensor相加根据相加的结果与thresh返回新的COOTensor。
**参数:**
参数:
- **x1** (COOTensor) - 一个操作数,与当前操作数相加。
- **x2** (COOTensor) - 另一个操作数,与当前操作数相加。
- **thresh** (Tensor) - 0维用来决定sparse_add结果中的indices/values对是否出现。
- **x1** (COOTensor) - 一个操作数,与当前操作数相加。
- **x2** (COOTensor) - 另一个操作数,与当前操作数相加。
- **thresh** (Tensor) - 0维 用来决定sparse_add结果中的indices/values对是否出现。
返回:
COOTensor为两COOTensor相加后的结果。
**返回:**
COOTensor, 为两COOTensor相加后的结果。
**异常:**
- **ValueError** - 如果操作数(x1/x2)的indices的维度不等于2。
- **ValueError** - 如果操作数(x1/x2)的values的维度不等于1。
- **ValueError** - 如果操作数(x1/x2)的shape的维度不等于1。
- **ValueError** - 如果thresh的维度不等于0。
- **TypeError** - 如果操作数(x1/x2)的indices的数据类型不为int64。
- **TypeError** - 如果操作数(x1/x2)的shape的数据类型不为int64。
- **ValueError** - 如果操作数(x1/x2)的indices的长度不等于它的values的长度。
- **TypeError** - 如果操作数(x1/x2)的values的数据类型不为(int8/int16/int32/int64/float32/float64/complex64/complex128)中的任何一个。
- **TypeError** - 如果thresh的数据类型不为(int8/int16/int32/int64/float32/float64)中的任何一个。
- **TypeError** - 如果操作数x1的indices数据类型不等于x2的indices数据类型。
- **TypeError** - 如果操作数x1的values数据类型不等于x2的values数据类型。
- **TypeError** - 如果操作数x1的shape数据类型不等于x2的shape数据类型。
- **TypeError** - 如果操作数(x1/x2)的values的数据类型与thresh数据类型不匹配。
异常:
- **ValueError** - 如果操作数(x1/x2)的indices的维度不等于2。
- **ValueError** - 如果操作数(x1/x2)的values的维度不等于1。
- **ValueError** - 如果操作数(x1/x2)的shape的维度不等于1。
- **ValueError** - 如果thresh的维度不等于0。
- **TypeError** - 如果操作数(x1/x2)的indices的数据类型不为int64。
- **TypeError** - 如果操作数(x1/x2)的shape的数据类型不为int64。
- **ValueError** - 如果操作数(x1/x2)的indices的长度不等于它的values的长度。
- **TypeError** - 如果操作数(x1/x2)的values的数据类型不为(int8/int16/int32/int64/float32/float64/complex64/complex128)中的任何一个。
- **TypeError** - 如果thresh的数据类型不为(int8/int16/int32/int64/float32/float64)中的任何一个。
- **TypeError** - 如果操作数x1的indices数据类型不等于x2的indices数据类型。
- **TypeError** - 如果操作数x1的values数据类型不等于x2的values数据类型。
- **TypeError** - 如果操作数x1的shape数据类型不等于x2的shape数据类型。
- **TypeError** - 如果操作数(x1/x2)的values的数据类型与thresh数据类型不匹配。

View File

@ -8,18 +8,15 @@ mindspore.ops.sparse_concat
.. note::
实验特性接口目前只支持CPU。
**参数:**
参数:
- **sp_input** (Union[list(COOTnesor), tuple(COOTensor)) - 输入的需要concat合并的稀疏张量。
- **concat_dim** (标量) - 指定需要合并的轴序号,它的取值必须是在[-rank, rank)之内,
其中rank为sp_input中COOTensor的shape的纬度值
- **sp_input** (Union[list(COOTnesor), tuple(COOTensor)) - 输入的需要concat合并的稀疏张量。
- **concat_dim** (标量) - 指定需要合并的轴序号, 它的取值必须是在[-rank, rank)之内,
其中rank为sp_input中COOTensor的shape的纬度值
返回:
COOTensor按concat_dim轴合并后的COOTensor。
**返回:**
COOTensor按concat_dim轴合并后的COOTensor。
**异常:**
- **ValueError** - 如果只有一个COOTensor输入报错。
- **ValueError** - 如果输入的COOTensor的shape纬度大于3。COOTensor的构造会报错
目前COOTensor的shape纬度只能为2
异常:
- **ValueError** - 如果只有一个COOTensor输入报错。
- **ValueError** - 如果输入的COOTensor的shape纬度大于3。COOTensor的构造会报错
目前COOTensor的shape纬度只能为2

View File

@ -9,21 +9,18 @@ mindspore.ops.sparse_segment_mean
- 在CPU平台 `segment_ids` 中的值会被校验是否排序,若索引值不是升序的,则抛出错误。另外, `indices` 中的值也会被校验是否在界限内,若索引值超出范围[0, x.shape[0]),则抛出错误。
- 在GPU平台对于 `segment_ids` 未排序和 `indices` 越界则不抛出错误。如果,无序的 `segment_ids` 会导致安全但未指定的行为,而超出范围的 `indices` 将被忽略。
**参数:**
参数:
- **x** (Tensor) - Tensor其维度必须大于或等于1。
- **indices** (Tensor) - 1维Tensor数据类型为int32或int64。
- **segment_ids** (Tensor) - 1维Tensor`indices` 有同样的数据类型。索引值应当是已排序的,并且可以重复。
- **x** (Tensor) - Tensor其维度必须大于或等于1。
- **indices** (Tensor) - 1维Tensor数据类型为int32或int64。
- **segment_ids** (Tensor) - 1维Tensor`indices` 有同样的数据类型。索引值应当是已排序的,并且可以重复。
返回:
Tensor其数据类型和维数与 `x` 相同。第一维度等于 `segment_ids` 的最后一个元素的值加一,其他维度与 `x` 的对应维度相同。
**返回:**
Tensor其数据类型和维数与 `x` 相同。第一维度等于 `segment_ids` 的最后一个元素的值加一,其他维度与 `x` 的对应维度相同。
**异常:**
- **TypeError** - `x``indices``segment_ids` 不是Tensor类型。
- **TypeError** - `x` 的数据类型不是float16、float32、float64的任一类型。
- **TypeError** - `indices``segment_ids` 的数据类型不是int32、int64的任一类型。
- **TypeError** - `indices``segment_ids` 的数据类型不相同。
- **ValueError** - `x``indices``segment_ids` 的维度不满足上述要求。
- **ValueError** - `indices``segment_ids` 的shape不相同。
异常:
- **TypeError** - `x``indices``segment_ids` 不是Tensor类型。
- **TypeError** - `x` 的数据类型不是float16、float32、float64的任一类型。
- **TypeError** - `indices``segment_ids` 的数据类型不是int32、int64的任一类型。
- **TypeError** - `indices``segment_ids` 的数据类型不相同。
- **ValueError** - `x``indices``segment_ids` 的维度不满足上述要求。
- **ValueError** - `indices``segment_ids` 的shape不相同。

View File

@ -7,19 +7,15 @@ mindspore.ops.split
`input_x` Tensor将被分割为相同shape的子Tensor且要求 `input_x.shape(axis)` 可被 `output_num` 整除。
**参数:**
参数:
- **input_x** (Tensor) - Tensor的shape为 :math:`(x_1, x_2, ..., x_R)`
- **axis** (int) - 指定分割轴。默认值0。
- **output_num** (int) - 指定分割数量。其值为正整数。默认值1。
- **input_x** (Tensor) - Tensor的shape为 :math:`(x_1, x_2, ..., x_R)`
- **axis** (int) - 指定分割轴。默认值0。
- **output_num** (int) - 指定分割数量。其值为正整数。默认值1。
返回:
tuple[Tensor]每个输出Tensor的shape相同:math:`(y_1, y_2, ..., y_S)` 。数据类型与 `input_x` 的相同。
**返回:**
tuple[Tensor]每个输出Tensor的shape相同:math:`(y_1, y_2, ..., y_S)` 。数据类型与 `input_x` 的相同。
**异常:**
- **TypeError** - `axis``output_num` 不是int。
- **ValueError** - `axis` 超出[-len(`input_x.shape`), len(`input_x.shape`))范围。或 `output_num` 小于或等于0。
- **ValueError** - `input_x.shape(axis)` 不可被 `output_num` 整除。
异常:
- **TypeError** - `axis``output_num` 不是int。
- **ValueError** - `axis` 超出[-len(`input_x.shape`), len(`input_x.shape`))范围。或 `output_num` 小于或等于0。
- **ValueError** - `input_x.shape(axis)` 不可被 `output_num` 整除。

View File

@ -9,16 +9,13 @@
给定输入Tensor的shape为 :math:`(x_1, x_2, ..., x_R)` 。若输入Tensor的长度为 `N` 。如果存在 :math:`axis \ge 0` 则输出Tensor的shape为 :math:`(x_1, x_2, ..., x_{axis}, N, x_{axis+1}, ..., x_R)`
**参数:**
参数:
- **input_x** (Union[tuple, list]) - 输入多个Tensor对象组成的tuple或list每个Tensor具有相同shape和数据类型。
- **axis** (int) - 指定堆叠运算的轴。取值范围为[-(R+1), R+1)。默认值0。
- **input_x** (Union[tuple, list]) - 输入多个Tensor对象组成的tuple或list每个Tensor具有相同shape和数据类型。
- **axis** (int) - 指定堆叠运算的轴。取值范围为[-(R+1), R+1)。默认值0
返回:
堆叠运算后的Tensor数据类型和 `input_x` 的相同
**返回:**
堆叠运算后的Tensor数据类型和 `input_x` 的相同。
**异常:**
- **TypeError** - `input_x` 中元素的数据类型不相同。
- **ValueError** - `input_x` 的长度不大于1或axis不在[-(R+1),R+1)范围中,或 `input_x` 中元素的shape不相同。
异常:
- **TypeError** - `input_x` 中元素的数据类型不相同。
- **ValueError** - `input_x` 的长度不大于1或axis不在[-(R+1),R+1)范围中,或 `input_x` 中元素的shape不相同。

View File

@ -9,18 +9,15 @@ mindspore.ops.standard_laplace
.. math::
\text{f}(x) = \frac{1}{2}\exp(-|x|)
**参数:**
参数:
- **shape** (Union[tuple, Tensor]) - 待生成的Tensor的shape。当为tuple类型时只支持常量值当为Tensor类型时支持动态Shape。
- **seed** (int) - 算子层的随机种子用于生成随机数。必须是非负的。默认值0。
- **seed2** (int) - 全局的随机种子和算子层的随机种子共同决定最终生成的随机数。必须是非负的。默认值0。
- **shape** (Union[tuple, Tensor]) - 待生成的Tensor的shape。当为tuple类型时只支持常量值当为Tensor类型时支持动态Shape。
- **seed** (int) - 算子层的随机种子用于生成随机数。必须是非负的。默认值0。
- **seed2** (int) - 全局的随机种子和算子层的随机种子共同决定最终生成的随机数。必须是非负的。默认值0。
返回:
Tensor其shape为输入 `shape`。数据类型为float32。
**返回:**
Tensor其shape为输入 `shape`。数据类型为float32。
**异常:**
- **TypeError** - `seed``seed2` 不是int。
- **TypeError** - `shape` 不是tuple。
- **ValueError** - `shape` 不是常量值。
异常:
- **TypeError** - `seed``seed2` 不是int。
- **TypeError** - `shape` 不是tuple。
- **ValueError** - `shape` 不是常量值。

View File

@ -10,18 +10,15 @@ mindspore.ops.standard_normal
.. math::
f(x)=\frac{1}{\sqrt{2 \pi}} e^{\left(-\frac{x^{2}}{2}\right)}
**参数:**
参数:
- **shape** (tuple) - 目标随机数Tensor的shape。只允许常量值。
- **seed** (int) - 随机种子非负值。默认值0。
- **seed2** (int) - 随机种子2用来防止随机种子冲突非负值。默认值0。
- **shape** (tuple) - 目标随机数Tensor的shape。只允许常量值。
- **seed** (int) - 随机种子非负值。默认值0。
- **seed2** (int) - 随机种子2用来防止随机种子冲突非负值。默认值0。
返回:
Tensor。shape为输入 `shape` 。数据类型支持float32。
**返回:**
Tensor。shape为输入 `shape` 。数据类型支持float32。
**异常:**
- **TypeError** - `seed``seed2` 不是int类型。
- **TypeError** - `shape` 不是Tuple。
- **ValueError** - `shape` 不是常量值。
异常:
- **TypeError** - `seed``seed2` 不是int类型。
- **TypeError** - `shape` 不是Tuple。
- **ValueError** - `shape` 不是常量值。

View File

@ -15,15 +15,12 @@ mindspore.ops.sub
- 当输入是两个Tensor时它们的数据类型不能同时是bool它们的shape可以广播。
- 当输入是一个Tensor和一个Scalar时Scalar只能是一个常数。
**参数:**
参数:
- **x** (Union[Tensor, number.Number, bool]) - 第一个输入是一个number.Number、bool值或数据类型为 `number <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_`bool_ <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_ 的Tensor。
- **y** (Union[Tensor, number.Number, bool]) - 第二个输入当第一个输入是Tensor时第二个输入应该是一个number.Number或bool值或数据类型为number或bool_的Tensor。当第一个输入是Scalar时第二个输入必须是数据类型为number或bool_的Tensor。
- **x** (Union[Tensor, number.Number, bool]) - 第一个输入是一个number.Number、bool值或数据类型为 `number <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_`bool_ <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_ 的Tensor。
- **y** (Union[Tensor, number.Number, bool]) - 第二个输入当第一个输入是Tensor时第二个输入应该是一个number.Number或bool值或数据类型为number或bool_的Tensor。当第一个输入是Scalar时第二个输入必须是数据类型为number或bool_的Tensor
返回:
Tensorshape与广播后的shape相同数据类型为两个输入中精度较高的类型
**返回:**
Tensorshape与广播后的shape相同数据类型为两个输入中精度较高的类型。
**异常:**
- **TypeError** - `x``y` 不是Tensor、number.Number或bool。
异常:
- **TypeError** - `x``y` 不是Tensor、number.Number或bool。

View File

@ -10,20 +10,17 @@ mindspore.ops.svd
.. math::
A=U*diag(S)*V^{T}
**参数:**
参数:
- **a** (Tensor) - 待分解的矩阵。shape为 :math:`(*, M, N)`
- **full_matrices** (bool, optional) - 如果为True则计算完整的 :math:`U`:math:`V` 。否则仅计算前P个奇异向量P为M和N中的较小值M和N分别是输入矩阵的行和列。默认值False。
- **compute_uv** (bool, optional) - 如果这个参数为True则计算 :math:`U`:math:`V` , 否则只计算 :math:`S` 。默认值True。
- **a** (Tensor) - 待分解的矩阵。shape为 :math:`(*, M, N)`
- **full_matrices** (bool, optional) - 如果为True则计算完整的 :math:`U`:math:`V` 。否则仅计算前P个奇异向量P为M和N中的较小值M和N分别是输入矩阵的行和列。默认值False。
- **compute_uv** (bool, optional) - 如果这个参数为True则计算 :math:`U`:math:`V` , 否则只计算 :math:`S` 。默认值True。
返回:
- **s** (Tensor) - 奇异值。shape为 :math:`(*, P)`
- **u** (Tensor) - 左奇异向量。如果 `compute_uv` 为False该值不会返回。shape为 :math:`(*, M, P)` 。如果 `full_matrices` 为True则shape为 :math:`(*, M, M)`
- **v** (Tensor) - 右奇异向量。如果 `compute_uv` 为False该值不会返回。shape为 :math:`(*, P, N)` 。如果 `full_matrices` 为True则shape为 :math:`(*, N, N)`
**返回:**
- **s** (Tensor) - 奇异值。shape为 :math:`(*, P)`
- **u** (Tensor) - 左奇异向量。如果 `compute_uv` 为False该值不会返回。shape为 :math:`(*, M, P)` 。如果 `full_matrices` 为True则shape为 :math:`(*, M, M)`
- **v** (Tensor) - 右奇异向量。如果 `compute_uv` 为False该值不会返回。shape为 :math:`(*, P, N)` 。如果 `full_matrices` 为True则shape为 :math:`(*, N, N)`
**异常:**
- **TypeError** - `full_matrices``compute_uv` 不是bool类型。
- **TypeError** - 输入的rank小于2。
- **TypeError** - 输入的数据类型不为float32或float64。
异常:
- **TypeError** - `full_matrices``compute_uv` 不是bool类型。
- **TypeError** - 输入的rank小于2。
- **TypeError** - 输入的数据类型不为float32或float64。

View File

@ -8,14 +8,11 @@ mindspore.ops.tan
.. math::
out_i = tan(x_i)
**参数:**
参数:
- **x** (Tensor) - Tan的输入任意维度的Tensor。
- **x** (Tensor) - Tan的输入任意维度的Tensor。
返回:
Tensor数据类型和shape与 `x` 相同。
**返回:**
Tensor数据类型和shape与 `x` 相同。
**异常:**
- **TypeError** - `x` 不是Tensor。
异常:
- **TypeError** - `x` 不是Tensor。

View File

@ -12,15 +12,12 @@
其中 :math:`x_i` 是输入Tensor的元素。
**参数:**
参数:
- **input_x** (Tensor) - Tanh的输入任意维度的Tensor其数据类型为float16或float32。
- **input_x** (Tensor) - Tanh的输入任意维度的Tensor其数据类型为float16或float32。
返回:
Tensor数据类型和shape与 `input_x` 相同。
**返回:**
Tensor数据类型和shape与 `input_x` 相同。
**异常:**
- **TypeError** - `input_x` 的数据类型既不是float16也不是float32。
- **TypeError** - `input_x` 不是Tensor。
异常:
- **TypeError** - `input_x` 的数据类型既不是float16也不是float32。
- **TypeError** - `input_x` 不是Tensor。

View File

@ -11,17 +11,14 @@
axes = 0为外积。axes = 1为普通矩阵乘法输入是2维的。axes = 1与axes = ((1,),(0,)相同,其中 `a``b` 都是2维的。axes = 2与axes = ((1,2),(0,1))相同,其中 `a``b` 都是3维的。
**参数:**
参数:
- **x1** (Tensor) - tensor_dot的第一个输入Tensor其数据类型为float16或float32。
- **x2** (Tensor) - tensor_dot的第二个输入Tensor其数据类型为float16或float32。
- **axes** (Union[int, tuple(int), tuple(tuple(int)), list(list(int))]) - 指定 `a``b` 计算轴可为单个值也可为长度为2的tuple或list。如果传递了单个值 `N` ,则自动从输入 `a` 的shape中获取最后N个维度从输入 `b` 的shape中获取前N个维度分别作为每个维度的轴。
- **x1** (Tensor) - tensor_dot的第一个输入Tensor其数据类型为float16或float32。
- **x2** (Tensor) - tensor_dot的第二个输入Tensor其数据类型为float16或float32。
- **axes** (Union[int, tuple(int), tuple(tuple(int)), list(list(int))]) - 指定 `a``b` 计算轴可为单个值也可为长度为2的tuple或list。如果传递了单个值 `N` ,则自动从输入 `a` 的shape中获取最后N个维度从输入 `b` 的shape中获取前N个维度分别作为每个维度的轴。
返回:
Tensor输出Tensor的shape为 :math:`(N + M)` 。其中 :math:`N`:math:`M` 在两个输入中没有计算,是自由轴。
**返回:**
Tensor输出Tensor的shape为 :math:`(N + M)` 。其中 :math:`N`:math:`M` 在两个输入中没有计算,是自由轴。
**异常:**
- **TypeError** - `x1``x2` 不是Tensor。
- **TypeError** - `axes` 不是int、tuple或list。
异常:
- **TypeError** - `x1``x2` 不是Tensor。
- **TypeError** - `axes` 不是int、tuple或list。

View File

@ -10,17 +10,14 @@
.. note::
GPU平台上如果 `indices` 的某些值超出范围,则相应的 `updates` 不会更新到 `input_x` 而不是抛出索引错误CPU平台上直接抛出索引错误Ascend平台不支持越界检查若越界可能会造成未知错误。
**参数:**
参数:
- **input_x** (Tensor) - 输入Tensor。 `input_x` 的维度必须不小于 `indices.shape[-1]`
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64。其rank至少为2。
- **updates** (Tensor) - 指定与 `input_x` 相加操作的Tensor其数据类型与输入相同。 `updates.shape` 应等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]`
- **input_x** (Tensor) - 输入Tensor。 `input_x` 的维度必须不小于 `indices.shape[-1]`
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64。其rank至少为2。
- **updates** (Tensor) - 指定与 `input_x` 相加操作的Tensor其数据类型与输入相同。 `updates.shape` 应等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]`
返回:
Tensorshape和数据类型与输入 `input_x` 相同。
**返回:**
Tensorshape和数据类型与输入 `input_x` 相同。
**异常:**
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x` 的shape长度小于 `indices` 的shape的最后一个维度。
异常:
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x` 的shape长度小于 `indices` 的shape的最后一个维度。

View File

@ -11,18 +11,14 @@ mindspore.ops.tensor_scatter_div
- 如果 `indices` 的某些值超出范围,则相应的 `updates` 不会更新为 `input_x` ,而不是抛出索引错误。
- 算子无法处理除0异常, 用户需保证 `updates` 中没有0值。
参数:
- **input_x** (Tensor) - 输入Tensor。 `input_x` 的维度必须不小于 `indices.shape[-1]`
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64的。其rank至少为2。
- **updates** (Tensor) - 指定与 `input_x` 相加操作的Tensor其数据类型与输入相同。 `updates.shape` 应等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]`
**参数:**
返回:
Tensorshape和数据类型与输入 `input_x` 相同。
- **input_x** (Tensor) - 输入Tensor。 `input_x` 的维度必须不小于 `indices.shape[-1]`
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64的。其rank至少为2。
- **updates** (Tensor) - 指定与 `input_x` 相加操作的Tensor其数据类型与输入相同。 `updates.shape` 应等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]`
**返回:**
Tensorshape和数据类型与输入 `input_x` 相同。
**异常:**
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x` 的shape长度小于 `indices` 的shape的最后一个维度。
异常:
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x` 的shape长度小于 `indices` 的shape的最后一个维度。

View File

@ -21,22 +21,19 @@
.. note::
如果 `indices` 的某些值超出范围,则相应的 `updates` 不会更新到 `input_x` ,也不会抛出索引错误。
**参数:**
参数:
- **input_x** (Tensor) - 输入Tensor。 `input_x` 其rank必须至少为1。
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64的。其rank必须和 `input_x` 一致。取值范围是[-s, s)这里的s是 `input_x``axis` 指定轴的size。
- **updates** (Tensor) - 指定与 `input_x` 进行reduction操作的Tensor其数据类型与输入的数据类型相同。updates的shape必须等于indices的shape。
- **axis** (int) - `input_x` reduction操作的轴默认值是0。取值范围是[-r, r)其中r是 `input_x` 的秩。
- **reduction** (str) - 指定进行的reduction操作。默认值是"none",可选"add"。
- **input_x** (Tensor) - 输入Tensor。 `input_x` 其rank必须至少为1。
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64的。其rank必须和 `input_x` 一致。取值范围是[-s, s), 这里的s是 `input_x``axis` 指定轴的size。
- **updates** (Tensor) - 指定与 `input_x` 进行reduction操作的Tensor其数据类型与输入的数据类型相同。updates的shape必须等于indices的shape。
- **axis** (int) - `input_x` reduction操作的轴默认值是0。取值范围是[-r, r)其中r是 `input_x` 的秩。
- **reduction** (str) - 指定进行的reduction操作。默认值是"none",可选"add"。
返回:
Tensorshape和数据类型与输入 `input_x` 相同。
**返回:**
Tensorshape和数据类型与输入 `input_x` 相同。
**异常:**
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x``indices``updates`任意一者的秩小于1。
- **ValueError** - `updates` 的shape和 `indices` 的shape不一样。
- **ValueError** - `updates` 的秩和 `input_x` 的秩不一样。
- **RuntimeError** - `input_x` 的数据类型和 `updates` 的数据类型不能隐式转换。
异常:
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x``indices``updates`任意一者的秩小于1。
- **ValueError** - `updates` 的shape和 `indices` 的shape不一样。
- **ValueError** - `updates` 的秩和 `input_x` 的秩不一样。
- **RuntimeError** - `input_x` 的数据类型和 `updates` 的数据类型不能隐式转换。

View File

@ -10,17 +10,14 @@
.. note::
如果 `indices` 的某些值超出范围,则 `input_x` 不会更新相应的 `updates`,同时也不会抛出索引错误。
**参数:**
参数:
- **input_x** (Tensor) - 输入Tensor。 `input_x` 的维度必须不小于indices.shape[-1]。
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64。其rank必须至少为2。
- **updates** (Tensor) - 指定与 `input_x` 取最小值操作的Tensor其数据类型与输入相同。updates.shape应该等于indices.shape[:-1] + input_x.shape[indices.shape[-1]:]。
- **input_x** (Tensor) - 输入Tensor。 `input_x` 的维度必须不小于indices.shape[-1]。
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64。其rank必须至少为2。
- **updates** (Tensor) - 指定与 `input_x` 取最小值操作的Tensor其数据类型与输入相同。updates.shape应该等于indices.shape[:-1] + input_x.shape[indices.shape[-1]:]。
返回:
Tensorshape和数据类型与输入 `input_x` 相同。
**返回:**
Tensorshape和数据类型与输入 `input_x` 相同。
**异常:**
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x` 的shape长度小于 `indices` 的shape的最后一个维度。
异常:
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x` 的shape长度小于 `indices` 的shape的最后一个维度。

View File

@ -10,17 +10,14 @@
.. note::
如果 `indices` 的某些值超出范围,则相应的 `updates` 不会更新为 `input_x` ,而不是抛出索引错误。
**参数:**
参数:
- **input_x** (Tensor) - 输入Tensor。 `input_x` 的维度必须不小于 `indices.shape[-1]`
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64。其rank至少为2。
- **updates** (Tensor) - 指定与 `input_x` 取最小值操作的Tensor其数据类型与输入相同。 `updates.shape` 应该等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]`
- **input_x** (Tensor) - 输入Tensor。 `input_x` 的维度必须不小于 `indices.shape[-1]`
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64。其rank至少为2。
- **updates** (Tensor) - 指定与 `input_x` 取最小值操作的Tensor其数据类型与输入相同。 `updates.shape` 应该等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]`
返回:
Tensorshape和数据类型与输入 `input_x` 相同。
**返回:**
Tensorshape和数据类型与输入 `input_x` 相同。
**异常:**
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x` 的shape长度小于 `indices` 的shape的最后一个维度。
异常:
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x` 的shape长度小于 `indices` 的shape的最后一个维度。

View File

@ -10,17 +10,14 @@ mindspore.ops.tensor_scatter_mul
.. note::
- 如果 `indices` 的某些值超出 `input_x` 的维度范围,则相应的 `updates` 不会更新为 `input_x` ,而不是抛出索引错误。
**参数:**
参数:
- **input_x** (Tensor) - 输入Tensor。 `input_x` 的维度必须不小于 `indices.shape[-1]`
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64的。其rank至少为2。
- **updates** (Tensor) - 指定与 `input_x` 相加操作的Tensor其数据类型与输入相同。 `updates.shape` 应等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]`
- **input_x** (Tensor) - 输入Tensor。 `input_x` 的维度必须不小于 `indices.shape[-1]`
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64的。其rank至少为2。
- **updates** (Tensor) - 指定与 `input_x` 相加操作的Tensor其数据类型与输入相同。 `updates.shape` 应等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]`
返回:
Tensorshape和数据类型与输入 `input_x` 相同。
**返回:**
Tensorshape和数据类型与输入 `input_x` 相同。
**异常:**
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x` 的shape长度小于 `indices` 的shape的最后一个维度。
异常:
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x` 的shape长度小于 `indices` 的shape的最后一个维度。

View File

@ -10,17 +10,14 @@
.. note::
GPU平台上如果 `indices` 的某些值超出范围,则相应的 `updates` 不会更新到 `input_x` 而不是抛出索引错误CPU平台上直接抛出索引错误Ascend平台不支持越界检查若越界可能会造成未知错误。
**参数:**
参数:
- **input_x** (Tensor) - 输入Tensor。 `input_x` 的维度必须不小于 `indices.shape[-1]`
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64。其rank至少为2。
- **updates** (Tensor) - 指定与 `input_x` 相减操作的Tensor其数据类型与输入相同。 `updates.shape` 应等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]`
- **input_x** (Tensor) - 输入Tensor。 `input_x` 的维度必须不小于 `indices.shape[-1]`
- **indices** (Tensor) - 输入Tensor的索引数据类型为int32或int64。其rank至少为2。
- **updates** (Tensor) - 指定与 `input_x` 相减操作的Tensor其数据类型与输入相同。 `updates.shape` 应等于 `indices.shape[:-1] + input_x.shape[indices.shape[-1]:]`
返回:
Tensorshape和数据类型与输入 `input_x` 相同。
**返回:**
Tensorshape和数据类型与输入 `input_x` 相同。
**异常:**
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x` 的shape长度小于 `indices` 的shape的最后一个维度。
异常:
- **TypeError** - `indices` 的数据类型既不是int32也不是int64。
- **ValueError** - `input_x` 的shape长度小于 `indices` 的shape的最后一个维度。

View File

@ -11,20 +11,17 @@ mindspore.ops.tile
`multiples` 的长度必须大于或等于 `input_x` 的维度。
**参数:**
参数:
- **input_x** (Tensor) - 1-D或更高维的Tensor。
- **multiples** (tuple[int]) - 指定复制次数的参数参数类型为tuple数据类型为整数。如 :math:`(y_1, y_2, ..., y_S)``multiples` 的长度不能小于 `input_x` 的维度。只支持常量值。
- **input_x** (Tensor) - 1-D或更高维的Tensor。
- **multiples** (tuple[int]) - 指定复制次数的参数参数类型为tuple数据类型为整数。如 :math:`(y_1, y_2, ..., y_S)``multiples` 的长度不能小于 `input_x` 的维度。只支持常量值
返回:
Tensor具有与 `input_x` 相同的数据类型。假设 `multiples` 的长度为 `d` `input_x` 的维度为 `input_x.dim` `input_x` 的shape为 :math:`(x_1, x_2, ..., x_S)`
**返回:**
- 如果 `input_x.dim = d` 将其相应位置的shape相乘输出的shape为 :math:`(x_1*y_1, x_2*y_2, ..., x_S*y_S)`
- 如果 `input_x.dim < d` `input_x` 的shape的前面填充1直到它们的长度一致。例如将 `input_x` 的shape设置为 :math:`(1, ..., x_1, ..., x_R, x_S)` 然后可以将其相应位置的shape相乘输出的shape为 :math:`(1*y_1, ..., x_R*y_R, x_S*y_S)`
Tensor具有与 `input_x` 相同的数据类型。假设 `multiples` 的长度为 `d` `input_x` 的维度为 `input_x.dim` `input_x` 的shape为 :math:`(x_1, x_2, ..., x_S)`
- 如果 `input_x.dim = d` 将其相应位置的shape相乘输出的shape为 :math:`(x_1*y_1, x_2*y_2, ..., x_S*y_S)`
- 如果 `input_x.dim < d` `input_x` 的shape的前面填充1直到它们的长度一致。例如将 `input_x` 的shape设置为 :math:`(1, ..., x_1, ..., x_R, x_S)` 然后可以将其相应位置的shape相乘输出的shape为 :math:`(1*y_1, ..., x_R*y_R, x_S*y_S)`
**异常:**
- **TypeError** - `multiples` 不是tuple或者其元素并非全部是int。
- **ValueError** - `multiples` 的元素并非全部大于0。
- **ValueError** - `multiples` 的长度小于 `input_x` 中的维度。
异常:
- **TypeError** - `multiples` 不是tuple或者其元素并非全部是int。
- **ValueError** - `multiples` 的元素并非全部大于0。
- **ValueError** - `multiples` 的长度小于 `input_x` 中的维度。

View File

@ -7,17 +7,14 @@ mindspore.ops.transpose
此函数对于一维数组转置后不产生变化。对于一维数组转为二维列向量,请参照: :class:`mindspore.ops.ExpandDims` 。对于二维数组可以看做是标准的矩阵转置。对于n维数组根据指定的轴进行排列。如果没有指定轴并且a.shape为 :math:`(i[0], i[1], ... i[n-2], i[n-1])` 那么a.transpose().shape为 :math:`(i[n-1], i[n-2], ... i[1], i[0])`
**参数:**
参数:
- **input_x** (Tensor) - 输入Tensor其shape是 :math:`(x_1, x_2, ..., x_R)`
- **input_perm** (tuple[int]) - 指定排列。 `input_perm` 中的元素由 `input_x` 的每个维度的索引组成。 `input_perm` 的长度和 `input_x` 的shape相同。只支持常量值。其范围在[0rank(input_x))内。
- **input_x** (Tensor) - 输入Tensor其shape是 :math:`(x_1, x_2, ..., x_R)`
- **input_perm** (tuple[int]) - 指定排列。 `input_perm` 中的元素由 `input_x` 的每个维度的索引组成。 `input_perm` 的长度和 `input_x` 的shape相同。只支持常量值。其范围在[0rank(input_x))内
返回:
Tensor输出Tensor的数据类型与 `input_x` 相同输出Tensor的shape由 `input_x` 的shape和 `input_perm` 的值决定
**返回:**
Tensor输出Tensor的数据类型与 `input_x` 相同输出Tensor的shape由 `input_x` 的shape和 `input_perm` 的值决定。
**异常:**
- **TypeError** - `input_perm` 不是tuple。
- **ValueError** - `input_x` 的shape长度不等于 `input_perm` 的shape长度。
- **ValueError** - `input_perm` 中存在相同的元素。
异常:
- **TypeError** - `input_perm` 不是tuple。
- **ValueError** - `input_x` 的shape长度不等于 `input_perm` 的shape长度。
- **ValueError** - `input_perm` 中存在相同的元素。

View File

@ -7,15 +7,12 @@
如果tuple中第一个数据类型为int则输出Tensor的数据类型为int。否则输出Tensor的数据类型为float。
**参数:**
参数:
- **input_x** (tuple) - 数值型组成的tuple。其元素具有相同的类型。仅支持常量值。shape为 :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度。
- **input_x** (tuple) - 数值型组成的tuple。其元素具有相同的类型。仅支持常量值。shape为 :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度。
返回:
Tensor。如果输入tuple包含 `N` 个数值型元素则输出Tensor的shape为(N,)。
**返回:**
Tensor。如果输入tuple包含 `N` 个数值型元素则输出Tensor的shape为(N,)。
**异常:**
- **TypeError** - `input_x` 不是tuple。
- **ValueError** - `input_x` 的长度小于或等于0。
异常:
- **TypeError** - `input_x` 不是tuple。
- **ValueError** - `input_x` 的长度小于或等于0。

View File

@ -8,21 +8,18 @@
.. note::
广播后任意位置上Tensor的最小值都必须小于最大值。
**参数:**
参数:
- **shape** (tuple) - 指定输出shape任意维度的Tensor。其 :math:`(N,*)` 的长度应小于8。
- **minval** (Tensor) - 指定生成随机值的最小值其数据类型为int32或float32。如果数据类型为int32则只允许输入一个数字。
- **maxval** (Tensor) - 指定生成随机值的最大值其数据类型为int32或float32。如果数据类型为int32则只允许输入一个数字。
- **seed** (int) - 指定随机种子用于随机数生成器生成伪随机数。随机数为非负数。默认值None将被视为0
- **dtype** (mindspore.dtype) - 指定输入的数据类型。如果数据类型为int32则从离散型均匀分布中生成数值型数据如果数据类型是float32则从连续型均匀分布中生成数值型数据。仅支持这两种数据类型。默认值mindspore.float32。
- **shape** (tuple) - 指定输出shape任意维度的Tensor。 其 :math:`(N,*)` 的长度应小于8。
- **minval** (Tensor) - 指定生成随机值的最小值其数据类型为int32或float32。如果数据类型为int32则只允许输入一个数字。
- **maxval** (Tensor) - 指定生成随机值的最大值其数据类型为int32或float32。如果数据类型为int32则只允许输入一个数字。
- **seed** (int) - 指定随机种子用于随机数生成器生成伪随机数。随机数为非负数。默认值None将被视为0
- **dtype** (mindspore.dtype) - 指定输入的数据类型。如果数据类型为int32则从离散型均匀分布中生成数值型数据如果数据类型是float32则从连续型均匀分布中生成数值型数据。仅支持这两种数据类型。默认值mindspore.float32。
返回:
Tensorshape等于输入 `shape``minval``maxval` 广播后的shape。数据类型由输入 `dtype` 决定。
**返回:**
Tensorshape等于输入 `shape``minval``maxval` 广播后的shape。数据类型由输入 `dtype` 决定。
**异常:**
- **TypeError** - `shape` 不是tuple。
- **TypeError** - `minval``maxval` 的数据类型既不是int32也不是float32并且 `minval` 的数据类型与 `maxval` 的不同。
- **TypeError** - `seed` 不是int。
- **TypeError** - `dtype` 既不是int32也不是float32。
异常:
- **TypeError** - `shape` 不是tuple。
- **TypeError** - `minval``maxval` 的数据类型既不是int32也不是float32并且 `minval` 的数据类型与 `maxval` 的不同。
- **TypeError** - `seed` 不是int。
- **TypeError** - `dtype` 既不是int32也不是float32。

View File

@ -7,26 +7,22 @@
此函数使用均匀分布从[0, range_max-1]中采样一组类sampled_candidates。如果 `unique` 为True则候选采样没有重复如果 `unique` 为False则有重复。
**参数:**
参数:
- **true_classes** (Tensor) - 输入Tensor目标类其shape为(batch_size, num_true)。
- **num_true** (int) - 每个训练样本的目标类数。
- **num_sampled** (int) - 随机采样的类数。sampled_candidates的shape将为 `num_sampled` 。如果 `unique` 为True`num_sampled` 必须小于或等于 `range_max`
- **unique** (bool) - 表示一个batch中的所有采样类是否唯一。
- **range_max** (int) - 可能的类数,该值必须是非负的。
- **seed** (int) - 随机种子该值必须是非负的。如果seed的值为0则seed的值将被随机生成的值替换。默认值0。
- **remove_accidental_hits** (bool) - 表示是否移除accidental hit。默认值False。
- **true_classes** (Tensor) - 输入Tensor目标类其shape为(batch_size, num_true)。
- **num_true** (int) - 每个训练样本的目标类数。
- **num_sampled** (int) - 随机采样的类数。sampled_candidates的shape将为 `num_sampled` 。如果 `unique` 为True`num_sampled` 必须小于或等于 `range_max`
- **unique** (bool) - 表示一个batch中的所有采样类是否唯一。
- **range_max** (int) - 可能的类数,该值必须是非负的。
- **seed** (int) - 随机种子该值必须是非负的。如果seed的值为0则seed的值将被随机生成的值替换。默认值0。
- **remove_accidental_hits** (bool) - 表示是否移除accidental hit。默认值False。
返回:
- **sampled_candidates** (Tensor) - 候选采样与目标类之间不存在联系其shape为(num_sampled, )。
- **true_expected_count** (Tensor) - 在每组目标类的采样分布下的预期计数。Shape为(batch_size, num_true)。
- **sampled_expected_count** (Tensor) - 每个候选采样分布下的预期计数。Shape为(num_sampled, )。
**返回:**
- **sampled_candidates** (Tensor) - 候选采样与目标类之间不存在联系其shape为(num_sampled, )。
- **true_expected_count** (Tensor) - 在每组目标类的采样分布下的预期计数。Shape为(batch_size, num_true)。
- **sampled_expected_count** (Tensor) - 每个候选采样分布下的预期计数。Shape为(num_sampled, )。
**异常:**
- **TypeError** - `num_true``num_sampled` 都不是int。
- **TypeError** - `uique``remo_acidental_hits` 都不是bool。
- **TypeError** - `range_max``seed` 都不是int。
- **TypeError** - `true_classes` 不是Tensor。
异常:
- **TypeError** - `num_true``num_sampled` 都不是int。
- **TypeError** - `uique``remo_acidental_hits` 都不是bool。
- **TypeError** - `range_max``seed` 都不是int。
- **TypeError** - `true_classes` 不是Tensor。

View File

@ -11,14 +11,11 @@ mindspore.ops.unique
.. warning::
此算子为实验性算子,将来可能面临更改或删除。
**参数:**
- **x** (Tensor) - 需要被去重的Tensor。shape :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度。
参数:
- **x** (Tensor) - 需要被去重的Tensor。shape :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度。
**返回:**
Tuple `(y, idx)``y` 是与 `x` 数据类型相同的Tensor包含 `x` 中去重后的元素。 `idx` 为索引Tensor包含 `x` 中的元素在 `y` 中的索引,与 `x` 的shape相同。
返回:
Tuple `(y, idx)``y` 是与 `x` 数据类型相同的Tensor包含 `x` 中去重后的元素。 `idx` 为索引Tensor包含 `x` 中的元素在 `y` 中的索引,与 `x` 的shape相同。
**异常:**
- **TypeError** - `x` 不是Tensor。
异常:
- **TypeError** - `x` 不是Tensor。

View File

@ -5,22 +5,19 @@ mindspore.ops.unique_consecutive
对输入张量中连续且重复的元素去重。
**参数:**
参数:
- **x** (Tensor) - 输入Tensor。
- **return_idx** (bool, optional) - 是否返回每个去重元素在输入中所在的连续序列的末尾位置的索引。默认值False。
- **return_counts** (bool, optional) - 是否返回每个去重元素在输入所在的连续序列的计数。默认值False。
- **axis** (int, optional) - 维度。如果为None则对输入进行展平操作。如果指定必须是int32或int64类型。默认值None。
- **x** (Tensor) - 输入Tensor。
- **return_idx** (bool, optional) - 是否返回每个去重元素在输入中所在的连续序列的末尾位置的索引。默认值False。
- **return_counts** (bool, optional) - 是否返回每个去重元素在输入所在的连续序列的计数。默认值False。
- **axis** (int, optional) - 维度。如果为None则对输入进行展平操作。如果指定必须是int32或int64类型。默认值None。
返回:
Tensor或包含Tensor对象的元组 `output``idx``counts` )。
**返回:**
- `output` 为去重后的输出,与 `x` 具有相同的数据类型。
- 如果 `return_idx` 为 True则返回张量 `idx` shape与 `x` 相同,表示每个去重元素在输入中所在的连续序列的末尾位置的索引。
- 如果 `return_counts` 为 True则返回张量 `counts` ,表示每个去重元素在输入中所在的连续序列的计数。
Tensor或包含Tensor对象的元组 `output``idx``counts` )。
- `output` 为去重后的输出,与 `x` 具有相同的数据类型。
- 如果 `return_idx` 为 True则返回张量 `idx` shape与 `x` 相同,表示每个去重元素在输入中所在的连续序列的末尾位置的索引。
- 如果 `return_counts` 为 True则返回张量 `counts` ,表示每个去重元素在输入中所在的连续序列的计数。
**异常:**
- **TypeError** - `x` 不是Tensor。
- **RuntimeError** `axis` 不在 `[-ndim, ndim-1]` 范围内。
异常:
- **TypeError** - `x` 不是Tensor。
- **RuntimeError** - `axis` 不在 `[-ndim, ndim-1]` 范围内。

View File

@ -9,16 +9,13 @@ mindspore.ops.unique_with_pad
unique运算符对张量处理后所返回的元组 `y` `idx` `y``idx` 的shape通常会有差别因此为了解决上述情况
unique_with_pad操作符将用用户指定的 `pad_num` 填充 `y` 张量,使其具有与张量 `idx` 相同的形状。
**参数:**
参数:
- **x** (Tensor) - 需要被去重的Tensor。必须是类型为int32或int64的一维向量。
- **pad_num** (int) - 填充值。数据类型为int32或int64。
- **x** (Tensor) - 需要被去重的Tensor。必须是类型为int32或int64的一维向量。
- **pad_num** (int) - 填充值。数据类型为int32或int64
返回:
Tuple `(y, idx)``y` 是与 `x` 形状和数据类型相同的Tensor包含 `x` 中去重后的元素,并用 `pad_num` 填充。 `idx` 为索引Tensor包含 `x` 中的元素在 `y` 中的索引,与 `x` 的shape相同
**返回:**
Tuple `(y, idx)``y` 是与 `x` 形状和数据类型相同的Tensor包含 `x` 中去重后的元素,并用 `pad_num` 填充。 `idx` 为索引Tensor包含 `x` 中的元素在 `y` 中的索引,与 `x` 的shape相同。
**异常:**
- **TypeError** - `x` 的数据类型既不是int32也不是int64。
- **ValueError** - `x` 不是一维张量。
异常:
- **TypeError** - `x` 的数据类型既不是int32也不是int64。
- **ValueError** - `x` 不是一维张量。

View File

@ -18,17 +18,14 @@ mindspore.ops.unsorted_segment_max
- 如果 `segment_ids` 中不存在segment_id `i` ,则将使用 `x` 的数据类型的最小值填充输出 `output[i]`
- `segment_ids` 必须是一个非负Tensor。
**参数:**
参数:
- **x** (Tensor) - shape :math:`(x_1, x_2, ..., x_R)` 。数据类型支持float16、float32或int32。
- **segment_ids** (Tensor) - shape为 :math:`(x_1)` 的1维张量值必须是非负数。数据类型支持int32。
- **num_segments** (int) - 分段的数量。
- **x** (Tensor) - shape :math:`(x_1, x_2, ..., x_R)` 。数据类型支持float16、float32或int32。
- **segment_ids** (Tensor) - shape为 :math:`(x_1)` 的1维张量值必须是非负数。数据类型支持int32。
- **num_segments** (int) - 分段的数量。
返回:
Tensor`num_segments` 值为 `N` 则shape为 :math:`(N, x_2, ..., x_R)`
**返回:**
Tensor`num_segments` 值为 `N` 则shape为 :math:`(N, x_2, ..., x_R)`
**异常:**
- **TypeError** - `num_segments` 不是int类型。
- **ValueError** - `segment_ids` 的维度不等于1。
异常:
- **TypeError** - `num_segments` 不是int类型。
- **ValueError** - `segment_ids` 的维度不等于1。

View File

@ -18,17 +18,14 @@ mindspore.ops.unsorted_segment_min
- 如果 `segment_ids` 中不存在segment_id `i` ,则将使用 `x` 的数据类型的最大值填充输出 `output[i]`
- `segment_ids` 必须是一个非负Tensor。
**参数:**
参数:
- **x** (Tensor) - shape :math:`(x_1, x_2, ..., x_R)` 。数据类型支持float16、float32或int32。
- **segment_ids** (Tensor) - shape为 :math:`(x_1)` 的1维张量值必须是非负数。数据类型支持int32。
- **num_segments** (int) - 分段的数量。
- **x** (Tensor) - shape :math:`(x_1, x_2, ..., x_R)` 。数据类型支持float16、float32或int32。
- **segment_ids** (Tensor) - shape为 :math:`(x_1)` 的1维张量值必须是非负数。数据类型支持int32。
- **num_segments** (int) - 分段的数量。
返回:
Tensor`num_segments` 值为 `N` 则shape为 :math:`(N, x_2, ..., x_R)`
**返回:**
Tensor`num_segments` 值为 `N` 则shape为 :math:`(N, x_2, ..., x_R)`
**异常:**
- **TypeError** - `num_segments` 不是int类型。
- **ValueError** - `segment_ids` 的维度不等于1。
异常:
- **TypeError** - `num_segments` 不是int类型。
- **ValueError** - `segment_ids` 的维度不等于1。

View File

@ -13,17 +13,14 @@ mindspore.ops.unsorted_segment_prod
- 如果 `segment_ids` 中不存在segment_id `i` 则将使用1填充输出 `output[i]`
- `segment_ids` 必须是一个非负Tensor。
**参数:**
参数:
- **x** (Tensor) - shape :math:`(x_1, x_2, ..., x_R)` 。数据类型支持float16、float32或int32。
- **segment_ids** (Tensor) - shape为 :math:`(x_1)` 的1维张量值必须是非负数。数据类型支持int32。
- **num_segments** (int) - 分段的数量。必须大于0。
- **x** (Tensor) - shape :math:`(x_1, x_2, ..., x_R)` 。数据类型支持float16、float32或int32。
- **segment_ids** (Tensor) - shape为 :math:`(x_1)` 的1维张量值必须是非负数。数据类型支持int32。
- **num_segments** (int) - 分段的数量。必须大于0。
返回:
Tensor`num_segments` 值为 `N` 则shape为 :math:`(N, x_2, ..., x_R)`
**返回:**
Tensor`num_segments` 值为 `N` 则shape为 :math:`(N, x_2, ..., x_R)`
**异常:**
- **TypeError** - `num_segments` 不是int类型。
- **ValueError** - `segment_ids` 的维度不等于1。
异常:
- **TypeError** - `num_segments` 不是int类型。
- **ValueError** - `segment_ids` 的维度不等于1。

View File

@ -17,18 +17,15 @@
如果给定的segment_ids :math: `i` 的和为空math: `\text{output}[i] = 0` 。如果 `segment_ids` 元素为负数,将忽略该值。 `num_segments` 必须等于不同segment_id的数量。
**参数:**
- **input_x** (Tensor)- shape :math:`(x_1, x_2, ..., x_R)`
- **segment_ids** (Tensor) - 将形状设置为 :math:`(x_1, x_2, ..., x_N)` 其中0<N<=R。
- **num_segments** (Union[int, Tensor], optional) - 分段数量 :math:`z` 数据类型为int或0维的Tensor。
参数:
- **input_x** (Tensor) - shape :math:`(x_1, x_2, ..., x_R)`
- **segment_ids** (Tensor) - 将形状设置为 :math:`(x_1, x_2, ..., x_N)` 其中0<N<=R。
- **num_segments** (Union[int, Tensor], optional) - 分段数量 :math:`z` 数据类型为int或0维的Tensor。
**返回:**
Tensorshape :math:`(z, x_{N+1}, ..., x_R)`
返回:
Tensorshape :math:`(z, x_{N+1}, ..., x_R)`
**异常:**
- **TypeError** - `num_segments` 不是int类型。
- **ValueError** - `segment_ids` 的维度不等于1。
异常:
- **TypeError** - `num_segments` 不是int类型。
- **ValueError** - `segment_ids` 的维度不等于1。

View File

@ -11,15 +11,12 @@
与Stack函数操作相反。
**参数:**
参数:
- **input_x** (Tensor) - 输入Tensor其shape为 :math:`(x_1, x_2, ..., x_R)` 。rank必须大于0。
- **axis** (int) - 指定矩阵分解的轴。取值范围为[-R,R)默认值0。
- **input_x** (Tensor) - 输入Tensor其shape为 :math:`(x_1, x_2, ..., x_R)` 。rank必须大于0。
- **axis** (int) - 指定矩阵分解的轴。取值范围为[-R,R)默认值0
返回:
Tensor对象组成的tuple。每个Tensor对象的shape相同
**返回:**
Tensor对象组成的tuple。每个Tensor对象的shape相同。
**异常:**
- **ValueError** - axis超出[-len(input_x.shape), len(input_x.shape))范围。
异常:
- **ValueError** - axis超出[-len(input_x.shape), len(input_x.shape))范围。

View File

@ -16,28 +16,25 @@ mindspore.ops.vmap
- vmap的能力来自于原语的VmapRules实现。虽然我们为用户自定义算子设计了一个通用规则但是我们无法保证它对所有算子都能很好地工作用户需知晓使用风险。如果想要获得更好的性能请提前花一些时间参阅教程为自定义算子实现特定的VmapRule。
- 当在vmap作用域内调用随机数生成方法时每次在向量函数之间生成相同的随机数。如果希望每个向量分支使用不同的随机数需要提前从外部生成一批随机数然后将其传入vmap。
**参数:**
参数:
- **fn** (Union[Cell, Function]) - 待沿参数轴映射的函数该函数至少拥有一个输入参数并且返回值为一个或多个Tensor或Tensor支持的数据类型。
- **in_axes** (Union[int, list, tuple]) - 指定输入参数映射的轴索引。如果 `in_axes` 是一个整数,则 `fn` 的所有输入参数都将根据此轴索引进行映射。
如果 `in_axes` 是一个tuple或list仅支持由整数或None组成则其长度应与 `fn` 的输入参数的个数一致,分别表示相应位置参数的映射轴索引。
请注意,每个参数对应的整数轴索引的取值范围必须在 :math:`[-ndim, ndim)` 中,其中 `ndim` 是参数的维度。None表示不沿任何轴映射。并且 `in_axes` 中必须至少有一个位置参数的映射轴索引不为None。 所有参数的映射轴索引对应的size `axis_size` 必须相等。默认值0。
- **out_axes** (Union[int, list, tuple]) - 指定映射轴呈现在输出中的索引位置。如果 `out_axes` 是一个整数,则 `fn` 的所有输出都根据此axis指定。
如果 `out_axes` 是一个tuple或list仅支持由整数或None组成其长度应与 `fn` 的输出个数相等。
请注意,每个输出对应的整数轴索引的取值范围必须在 :math:`[-ndim, ndim)` 中,其中 `ndim``vmap` 映射后的函数的输出的维度。
所有具有非None映射轴的输出只能指定非None的 `out_axes` 如果具有None映射轴的输出指定非None的 `out_axes` 结果将沿映射轴进行广播。默认值0。
- **fn** (Union[Cell, Function]) - 待沿参数轴映射的函数该函数至少拥有一个输入参数并且返回值为一个或多个Tensor或Tensor支持的数据类型。
- **in_axes** (Union[int, list, tuple]) - 指定输入参数映射的轴索引。如果 `in_axes` 是一个整数,则 `fn` 的所有输入参数都将根据此轴索引进行映射。
如果 `in_axes` 是一个tuple或list仅支持由整数或None组成则其长度应与 `fn` 的输入参数的个数一致,分别表示相应位置参数的映射轴索引。
请注意,每个参数对应的整数轴索引的取值范围必须在 :math:`[-ndim, ndim)` 中,其中 `ndim` 是参数的维度。None表示不沿任何轴映射。并且 `in_axes` 中必须至少有一个位置参数的映射轴索引不为None。 所有参数的映射轴索引对应的size `axis_size` 必须相等。默认值0。
- **out_axes** (Union[int, list, tuple]) - 指定映射轴呈现在输出中的索引位置。 如果 `out_axes` 是一个整数,则 `fn` 的所有输出都根据此axis指定。
如果 `out_axes` 是一个tuple或list仅支持由整数或None组成其长度应与 `fn` 的输出个数相等。
请注意,每个输出对应的整数轴索引的取值范围必须在 :math:`[-ndim, ndim)` 中,其中 `ndim``vmap` 映射后的函数的输出的维度。
所有具有非None映射轴的输出只能指定非None的 `out_axes` 如果具有None映射轴的输出指定非None的 `out_axes` 结果将沿映射轴进行广播。默认值0。
返回:
Function返回 `fn` 的自动向量化后的函数。此函数的输入参数和输出与 `fn` 的相对应,但它在 `in_axes``out_axes` 指定的位置新增了额外的批处理维度。
**返回:**
异常:
- **RuntimeError** -
Function返回 `fn` 的自动向量化后的函数。此函数的输入参数和输出与 `fn` 的相对应,但它在 `in_axes``out_axes` 指定的位置新增了额外的批处理维度。
**异常:**
- **RuntimeError** -
- 如果 `in_axes``out_axes` 中的基本元素不是None或整数。
- 如果 `in_axes``out_axes` 中的所有基本元素均为None。
- 如果 `in_axes` 不是单个整数,并且 `in_axes` 的长度不等于输入参数的个数。
- 如果 `out_axes` 不是单个整数,并且 `out_axes` 的长度不等于输出个数。
- 如果 `vmap` 范围内每个参数的 `axis_size` 不相等。
- 如果 `in_axes``out_axes` 中的 `axis` 超出边界限制。
- 如果 `in_axes``out_axes` 中的基本元素不是None或整数。
- 如果 `in_axes``out_axes` 中的所有基本元素均为None。
- 如果 `in_axes` 不是单个整数,并且 `in_axes` 的长度不等于输入参数的个数。
- 如果 `out_axes` 不是单个整数,并且 `out_axes` 的长度不等于输出个数。
- 如果 `vmap` 范围内每个参数的 `axis_size` 不相等。
- 如果 `in_axes``out_axes` 中的 `axis` 超出边界限制。

View File

@ -10,17 +10,14 @@ mindspore.ops.xlogy
`x``y` 的输入遵循隐式类型转换规则使数据类型一致。输入必须是两个Tensor或一个Tensor和一个Scalar。当输入是两个Tensor时它们的数据类型不能同时是bool的它们的shape可以广播。当输入是一个Tensor和一个Scalar时Scalar只能是一个常量。
**参数:**
参数:
- **x** (Union[Tensor, number.Number, bool]) - 第一个输入为数值型。数据类型为 `number <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_`bool_ <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_
- **y** (Union[Tensor, number.Number, bool]) - 第二个输入为数值型。当第一个输入是Tensor或数据类型为数值型或bool的Tensor时则第二个输入是数值型或bool。当第一个输入是Scalar时则第二个输入必须是数据类型为数值型或bool的Tensor。
- **x** (Union[Tensor, number.Number, bool]) - 第一个输入为数值型。数据类型为 `number <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_`bool_ <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/mindspore.dtype.html#mindspore.dtype>`_
- **y** (Union[Tensor, number.Number, bool]) - 第二个输入为数值型。当第一个输入是Tensor或数据类型为数值型或bool的Tensor时则第二个输入是数值型或bool。当第一个输入是Scalar时则第二个输入必须是数据类型为数值型或bool的Tensor
返回:
Tensorshape与广播后的shape相同数据类型为两个输入中精度较高或数数值较高的类型
**返回:**
Tensorshape与广播后的shape相同数据类型为两个输入中精度较高或数数值较高的类型。
**异常:**
- **TypeError** - 如果 `x``y` 不是数值型、bool或Tensor。
- **TypeError** - 如果 `x``y` 的数据类型不是float16、float32或float64。
- **ValueError** - 如果 `x` 不能广播到与 `y` 的shape一致。
异常:
- **TypeError** - 如果 `x``y` 不是数值型、bool或Tensor。
- **TypeError** - 如果 `x``y` 的数据类型不是float16、float32或float64。
- **ValueError** - 如果 `x` 不能广播到与 `y` 的shape一致。