diff --git a/docs/api/api_python/ops/mindspore.ops.OneHot.rst b/docs/api/api_python/ops/mindspore.ops.OneHot.rst new file mode 100644 index 00000000000..d03c65ef4a7 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.OneHot.rst @@ -0,0 +1,35 @@ +mindspore.ops.OneHot +==================== + +.. py:class:: mindspore.ops.OneHot(axis=-1)) + + 返回一个one-hot类型的Tensor。 + + 生成一个新的Tensor,由索引 `indices` 表示的位置取值为 `on_value` ,而在其他所有位置取值为 `off_value` 。 + + .. note:: + 如果输入索引为秩 `N` ,则输出为秩 `N+1` 。新轴在 `axis` 处创建。 + + **参数:** + + - **axis** (int) - 指定插入值的位置。例如,如果 `indices` 的shape为 :math:`(N, C)` ,`axis` 为-1,则输出shape为 :math:`(N, C, D)` ,如果 `axis` 为0,则输出shape为 :math:`(D, N, C)` 。默认值:-1。 + + **输入:** + + - **indices** (Tensor) - 输入索引,shape为 :math:`(X_0, \ldots, X_n)` 的Tensor。数据类型必须为int32或int64。 + - **depth** (int) - 输入的Scalar,定义one-hot的深度。 + - **on_value** (Tensor) - 当 `indices[j] = i` 时,用来填充输出的值。数据类型为float16或float32。 + - **off_value** (Tensor) - 当 `indices[j] != i` 时,用来填充输出的值。数据类型与 `on_value` 的相同。 + + **输出:** + + Tensor,one-hot类型的Tensor。shape为 :math:`(X_0, \ldots, X_{axis}, \text{depth} ,X_{axis+1}, \ldots, X_n)` 。 + + **异常:** + + - **TypeError** - `axis` 或 `depth` 不是int。 + - **TypeError** - `indices` 的数据类型既不是int32也不是int64。 + - **TypeError** - `indices`、`on_value` 或 `off_value` 不是Tensor。 + - **ValueError** - `axis` 不在[-1,len(indices_shape)]范围内。 + - **ValueError** - `depth` 小于0。 + \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.Ones.rst b/docs/api/api_python/ops/mindspore.ops.Ones.rst new file mode 100644 index 00000000000..099376ffb08 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.Ones.rst @@ -0,0 +1,21 @@ +mindspore.ops.Ones +=================== + +.. py:class:: mindspore.ops.Ones + + 创建一个值全为1的Tensor。 + + 第一个参数指定Tensor的shape,第二个参数指定填充值的数据类型。 + + **输入:** + + - **shape** (Union[tuple[int], int]) - 指定输出Tensor的shape,只能是正整数常量。 + - **type** (mindspore.dtype) - 指定输出Tensor的数据类型,只能是常量值。 + + **输出:** + + Tensor,shape和数据类型与输入相同。 + + **异常:** + + - **TypeError** - `shape` 既不是tuple,也不是int。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.Pad.rst b/docs/api/api_python/ops/mindspore.ops.Pad.rst new file mode 100644 index 00000000000..5307e95cc83 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.Pad.rst @@ -0,0 +1,40 @@ +mindspore.ops.Pad +================== + +.. py:class:: mindspore.ops.Pad(paddings) + + 根据参数 `paddings` 对输入进行填充。 + + 例如, 仅填充输入Tensor的最后一个维度,则填充方式为(padding_left, padding_right);填充输入Tensor的最后两个维度, + 则填充方式为(padding_left, padding_right, padding_top, padding_bottom);填充最后3个维度,则填充方式为 + (padding_left, padding_right, padding_top, padding_bottom, padding_front, padding_back)。 + + .. math:: + \begin{aligned} + &\text{ input_x_shape} = (N_{1},N_{2},...,N_{n}) \\ + &\begin{aligned} + \text{output_shape = }(&N_{1}+paddings[0,0]+paddings[0,1], \\ + & N_{2}+paddings[1,0]+paddings[1,1], \\ + &... , \\ + & N_{n}+paddings[n-1,0]+paddings[n-1,1]) + \end{aligned} + \end{aligned} + + **参数:** + + - **paddings** (tuple) - 填充大小,其shape为(N, 2),N是输入数据的维度,填充的元素为int类型。对于 `x` 的第 `D` 个维度,paddings[D, 0]表示输入Tensor的第 `D` 维度扩展前的大小,paddings[D, 1]表示在输入Tensor的第 `D` 个维度后面要扩展的大小。 + + **输入:** + + - **input_x** (Tensor) - Pad的输入,任意维度的Tensor。 + + **输出:** + + 填充后的Tensor。 + + **异常:** + + - **TypeError** - `paddings` 不是tuple。 + - **TypeError** - `input_x` 不是Tensor。 + - **ValueError** - `paddings` 的shape不是 :math:`(N, 2)` 。 + - **ValueError** - `paddings` 的大小不等于2 * len(input_x)。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.Padding.rst b/docs/api/api_python/ops/mindspore.ops.Padding.rst new file mode 100644 index 00000000000..be854c93381 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.Padding.rst @@ -0,0 +1,24 @@ +mindspore.ops.Padding +===================== + +.. py:class:: mindspore.ops.Padding(pad_dim_size=8) + + 将输入Tensor的最后一个维度从1扩展到pad_dim_size,其填充值为0。 + + **参数:** + + - **pad_dim_size** (int) - 指定填充的大小,待扩展的 `x` 的最后一个维度的值,必须为正数。默认值:8。 + + **输入:** + + - **x** (Tensor) - 输入Tensor,其shape为 :math:`(x_1, x_2, ..., x_R)` 。`x` 的秩必须至少为2。 `x` 的最后一个维度必须为1。数据类型为Number。 + + **输出:** + + Tensor,其shape是 :math:`(z_1, z_2, ..., z_N)` 。 + + **异常:** + + - **TypeError** - `pad_dim_size` 不是int。 + - **ValueError** - `pad_dim_size` 小于1。 + - **ValueError** - `x` 的最后一个维度不等于1。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.Print.rst b/docs/api/api_python/ops/mindspore.ops.Print.rst new file mode 100644 index 00000000000..c8a70a376e7 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.Print.rst @@ -0,0 +1,23 @@ +mindspore.ops.Print +=================== + +.. py:class:: mindspore.ops.Print + + 将输入Tensor或string进行打印输出。 + + 默认打印在屏幕上。也可以保存在文件中,通过 `context` 设置 `print_file_path` 参数。一旦设置,输出将保存在指定文件中。通过函数 :func:`mindspore.parse_print` 可以重新加载数据。获取更多信息,请查看 :func:`mindspore.context.set_context` 和 :func:`mindspore.parse_print` 。 + + .. note:: + 在PyNative模式下,请使用Python print函数。在Graph模式下,bool、int和float将被转换为Tensor进行打印,str保持不变。 + + **输入:** + + - **input_x** (Union[Tensor, bool, int, float, str]) - Print的输入。支持多个输入,用','分隔。 + + **输出:** + + Tensor,数据类型和shape与 `input_x` 相同。 + + **异常:** + + - **TypeError** - `input_x` 不是Tensor、bool、int、float或str。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ReLU.rst b/docs/api/api_python/ops/mindspore.ops.ReLU.rst new file mode 100644 index 00000000000..192a7ddccf8 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.ReLU.rst @@ -0,0 +1,27 @@ +mindspore.ops.ReLU +=================== + +.. py:class:: mindspore.ops.ReLU + + 线性修正单元激活函数(Rectified Linear Unit)。 + + 返回 :math:`\max(x,\ 0)` 的值,负值神经元将被设置为0。 + + .. math:: + ReLU(x) = (x)^+ = max(0, x) + + .. note:: + 一般来说,与 `ReLUV2` 相比,此算子更常用。且 `ReLUV2` 会多输出一个掩码。 + + **输入:** + + - **input_x** (Tensor) - ReLU的输入,任意维度的Tensor。其数据类型为Number。 + + **输出:** + + Tensor,数据类型和shape与 `input_x` 相同。 + + **异常:** + + - **iTypeError** - `input_x` 的数据类型不是Number。 + - **iTypeError** - `input_x` 不是Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ReduceMax.rst b/docs/api/api_python/ops/mindspore.ops.ReduceMax.rst new file mode 100644 index 00000000000..592982369e2 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.ReduceMax.rst @@ -0,0 +1,33 @@ +mindspore.ops.ReduceMax +======================== + +.. py:class:: mindspore.ops.ReduceMax(keep_dims=False) + + 默认情况下,输出张量各维度上的最大值,以达到对所有维度进行归约的目的。也可以对指定维度进行求最大值归约。 + + 通过指定 `keep_dims` 参数,来控制输出和输入的维度是否相同。 + + **参数:** + + - **keep_dims (bool)** - 如果为True,则保留计算的维度,长度为1。如果为False,则不保留计算维度。默认值:False,输出结果会降低维度。 + + **输入:** + + - **x** (Tensor[Number]) - ReduceMax的输入,任意维度的Tensor,秩应小于8。其数据类型为number。 + - **axis** (Union[int, tuple(int), list(int)]) - 指定计算维度。默认值:(),即计算所有元素的最大值。只允许常量值,取值范围[-rank(x), rank(x))。 + + **输出:** + + Tensor,shape与输入 `x` 相同。 + + - 如果轴为(),且keep_dims为False,则输出一个0维Tensor,表示输入Tensor中所有元素的最大值。 + + - 如果轴为int,取值为2,并且keep_dims为False,则输出的shape为 :math:`(x_1, x_3, ..., x_R)` 。 + + - 如果轴为tuple(int),取值为(2, 3),并且keep_dims为False,则输出的shape为 :math:`(x_1, x_4, ..., x_R)` 。 + + **异常:** + + - **TypeError** - `keep_dims` 不是bool。 + - **TypeError** - `x` 不是tensor。 + - **ValueError** - `axis` 不是int、tuple或list。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ReduceMean.rst b/docs/api/api_python/ops/mindspore.ops.ReduceMean.rst new file mode 100644 index 00000000000..3ece083ec18 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.ReduceMean.rst @@ -0,0 +1,33 @@ +mindspore.ops.ReduceMean +========================= + +.. py:class:: mindspore.ops.ReduceMean(keep_dims=False) + + 默认情况下,输出张量各维度上的平均值,以达到对所有维度进行归约的目的。也可以对指定维度进行求平均值归约。 + + 通过指定 `keep_dims` 参数,来控制输出和输入的维度是否相同。 + + **参数:** + + - **keep_dims** (bool) - 如果为True,则保留计算的维度,长度为1。如果为False,则不保留计算维度。默认值:False,输出结果会降低维度。 + + **输入:** + + - **x** (Tensor[Number]) - ReduceMean的输入,任意维度的Tensor,秩应小于8。其数据类型为number。 + - **axis** (Union[int, tuple(int), list(int)]) - 指定计算维度。默认值:(),即计算所有元素的平均值。只允许常量值,取值范围[-rank(`x`), rank(`x`))。 + + **输出:** + + Tensor,shape与输入 `x` 相同。 + + - 如果轴为(),且keep_dims为False,则输出一个0维Tensor,表示输入Tensor中所有元素的平均值。 + + - 如果轴为int,取值为2,并且keep_dims为False,则输出的shape为 :math:`(x_1, x_3, ..., x_R)` 。 + + - 如果轴为int,取值为2,并且keep_dims为False,则输出的shape为 :math:`(x_1, x_4, ..., x_R)` 。 + + **异常:** + + - ** TypeError** - `keep_dims` 不是bool。 + - ** TypeError** - `x` 不是Tensor。 + - ** ValueError** - `axis` 不是int、tuple或list。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ReduceSum.rst b/docs/api/api_python/ops/mindspore.ops.ReduceSum.rst new file mode 100644 index 00000000000..a11c4fce92c --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.ReduceSum.rst @@ -0,0 +1,33 @@ +mindspore.ops.ReduceSum +========================= + +.. py:class:: mindspore.ops.ReduceSum(keep_dims=False) + + 默认情况下,输出张量各维度上的和,以达到对所有维度进行归约的目的。也可以对指定维度进行求和归约。 + + 通过指定 `keep_dims` 参数,来控制输出和输入的维度是否相同。 + + **参数:** + + - **keep_dims** (bool) - 如果为True,则保留计算维度,长度为1。如果为False,则不保留计算维度。默认值:False,输出结果会降低维度。 + + **输入:** + + - **x** (Tensor[Number]) - ReduceSum的输入,任意维度的Tensor,秩应小于8。其数据类型为Number。 + - **axis** (Union[int, tuple(int), list(int)]) - 指定计算维度。默认值:(),即计算所有元素的和。只允许常量值,取值范围[-rank(`x`), rank(`x`))。 + + **输出:** + + Tensor,具有与输入 `x` 相同的shape。 + + - 如果轴为(),且keep_dims为False,则输出一个0维Tensor,表示输入Tensor中所有元素的和。 + + - 如果轴为int,取值为2,并且keep_dims为False,则输出的shape为 :math:`(x_1, x_3, ..., x_R)` 。 + + - 如果轴为tuple(int),取值为(2, 3),并且keep_dims为False,则输出的shape为 :math:`(x_1, x_4, ..., x_R)` 。 + + **异常:** + + - **TypeError** - `keep_dims` 不是bool。 + - **TypeError** - `x` 不是Tensor。 + - **ValueError** - `axis` 取值为None。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ResizeBilinear.rst b/docs/api/api_python/ops/mindspore.ops.ResizeBilinear.rst new file mode 100644 index 00000000000..98d6dc3bdcc --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.ResizeBilinear.rst @@ -0,0 +1,29 @@ +mindspore.ops.ResizeBilinear +============================= + +.. py:class:: mindspore.ops.ResizeBilinear(size, align_corners=False) + + 使用双线性插值调整图像大小到指定的大小。 + + 调整输入图像的高和宽,且输入图像的数据类型可以不同,但输出的数据类型只能是float32. + + **参数:** + + - **size** (Union[tuple[int], list[int]]) - 指定图像的新尺寸,输入格式为:2个int元素 :math:`(new\_height, new\_width)` 的tuple或者list。 + - **align_corners** (bool) - 如果为True,则通过 :math:`(new\_height - 1) / (height - 1)` 调整输入,这将精确对齐图像的4个角和调整图像大小。如果为False,则按 :math:`new\_height / height` 调整输入。默认值:False。 + + **输入:** + + - **x** (Tensor) - ResizeBilinear的输入,四维的Tensor,其shape为 :math:`(batch, channels, height, width)` ,数据类型为float32或float16。 + + **输出:** + + Tensor,调整大小后的图像。shape为 :math:`(batch, channels, new\_height, new\_width)` 的四维Tensor,数据类型与输入 `x` 相同。 + + **异常:** + + - **TypeError** - `size` 既不是tuple,也不是list。 + - **TypeError** - `align_corners` 不是bool。 + - **TypeError** - `x` 的数据类型既不是float16也不是float32。 + - **TypeError** - `x` 不是Tensor。 + - **ValueError** - `x` 的shape长度不等于4。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ResizeNearestNeighbor.rst b/docs/api/api_python/ops/mindspore.ops.ResizeNearestNeighbor.rst new file mode 100644 index 00000000000..7627626b2de --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.ResizeNearestNeighbor.rst @@ -0,0 +1,25 @@ +mindspore.ops.ResizeNearestNeighbor +===================================== + +.. py:class:: mindspore.ops.ResizeNearestNeighbor(size, align_corners=False) + + 使用最近邻插值算法调整输入Tensor为指定大小。最近邻插值算法的具体操作为:选择最近点的值,而不考虑相邻点的值,从而产生分段常数插值。 + + **参数:** + + - **size** (Union[tuple, list]) - 指定输入Tensor的新大小。size的维度必须为2。 + - **align_corners** (bool) - 输入和输出Tensor的4个角像素是否居中对齐。默认值:False。 + + **输入:** + + - **input_x** (Tensor) - ResizeNearestNeighbor的输入,四维的Tensor,其shape为 :math:`(N, C, H, W)` 。 + + **输出:** + + Tensor,输出Tensor的shape为 :math:`(N, C, NEW\_H, NEW\_W)` 。数据类型与 `input_x` 相同。 + + **异常:** + + - **TypeError** - `size` 既不是tuple,也不是list。 + - **TypeError** - `align_corners` 不是bool。 + - **ValueError** - `size` 的shape长度不等于2。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ReverseSequence.rst b/docs/api/api_python/ops/mindspore.ops.ReverseSequence.rst new file mode 100644 index 00000000000..322ef028ef6 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.ReverseSequence.rst @@ -0,0 +1,24 @@ +mindspore.ops.ReverseSequence +============================== + +.. py:class:: mindspore.ops.ReverseSequence(seq_dim, batch_dim=0) + + 对输入序列进行部分反转。 + + **参数:** + + - **seq_dim** (int) - 指定反转的维度,此值为必填参数。 + - **batch_dim** (int) - 指定切片维度。默认值:0。 + + ** 输入:** + + - **x** (Tensor) - 输入需反转的数据,其数据类型支持包括bool在内的所有Number类型。 + - **seq_lengths** (Tensor) - 指定反转长度,为一维向量,其数据类型为int32或int64。 + + **输出:** + + shape和数据类型与输入的相同。 + + **异常:** + + - **TypeError** - `seq_dim` 或 `batch_dim` 不是int。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ReverseV2.rst b/docs/api/api_python/ops/mindspore.ops.ReverseV2.rst new file mode 100644 index 00000000000..05106bc46b0 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.ReverseV2.rst @@ -0,0 +1,26 @@ +mindspore.ops.ReverseV2 +======================== + +.. py:class:: mindspore.ops.ReverseV2(axis) + + 对输入Tensor按指定维度反转。 + + .. warning:: + "axis"的取值范围为[-dims, dims - 1],"dims"表示"input_x"的维度长度。 + + **参数:** + + - **axis** (Union[tuple(int), list(int)) - 指定反转的轴。 + + **输入:** + + - **input_x** (Tensor) - 输入需反转的任意维度的Tensor。数据类型为Number,不包括float64。 + + **输出:** + + Tensor,shape和数据类型与输入 `input_x` 相同。 + + **异常:** + + - **TypeError** - `axis` 既不是list也不是tuple。 + - **TypeError** - `axis` 的元素不是int。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.Round.rst b/docs/api/api_python/ops/mindspore.ops.Round.rst new file mode 100644 index 00000000000..60fef1a1dfc --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.Round.rst @@ -0,0 +1,21 @@ +mindspore.ops.Round +==================== + +.. py:class:: mindspore.ops.Round + + 对输入数据进行四舍五入到最接近的整数数值。 + + .. math:: + out_i \approx x_i + + **输入:** + + - **x** (Tensor) - 输入Tensor。 + + **输出:** + + Tensor,shape和数据类型与输入 `x` 相同。 + + **异常:** + + - **TypeError** - `x` 不是Tensor。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.ScalarToArray.rst b/docs/api/api_python/ops/mindspore.ops.ScalarToArray.rst new file mode 100644 index 00000000000..63259658cc0 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.ScalarToArray.rst @@ -0,0 +1,18 @@ +mindspore.ops.ScalarToArray +============================= + +.. py:class:: mindspore.ops.ScalarToArray + + 将Scalar转换为 `Tensor` 。 + + **输入:** + + - **input_x** (Union[int, float]) - ScalarToArray的输入,是Scalar且只能是常量值。 + + **输出:** + + Tensor,0维Tensor,其值和输入一致。 + + **异常:** + + - **TypeError** - `input_x` 既不是int也不是float。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.op_info_register.rst b/docs/api/api_python/ops/mindspore.ops.op_info_register.rst new file mode 100644 index 00000000000..cff24dca949 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.op_info_register.rst @@ -0,0 +1,18 @@ +mindspore.ops.op_info_register +=============================== + +.. py:function:: mindspore.ops.op_info_register(op_info) + + 用于注册算子的装饰器。 + + .. note:: + 'op_info'应通过json格式的字符串表示算子信息。'op_info'将添加到算子库'oplib'中。 + + **参数:** + + - **op_info** (str or dict) - json格式的算子信息。 + + **返回:** + + Function,返回算子信息注册的装饰器。 + \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.repeat_elements.rst b/docs/api/api_python/ops/mindspore.ops.repeat_elements.rst new file mode 100644 index 00000000000..edb0a3924e5 --- /dev/null +++ b/docs/api/api_python/ops/mindspore.ops.repeat_elements.rst @@ -0,0 +1,16 @@ +mindspore.ops.repeat_elements +=============================== + +.. py:function:: mindspore.ops.repeat_elements(x, rep, axis=0) + + 根据指定轴复制输入Tensor的元素,类似np.repeat的功能。 + + **参数:** + + - **x** (Tensor) - 输入Tensor。类型为float16、float32、int8、uint8、int16、int32或int64。 + - **rep** (int) - 指定复制次数,为正数。 + - **axis** (int) - 指定复制轴,默认为0。 + + **输出:** + + Tensor,值沿指定轴复制。如果 `x` 的shape为 :math:`(s1, s2, ..., sn)` ,轴为i,则输出的shape为 :math:`(s1, s2, ..., si * rep, ..., sn)` 。输出的数据类型与 `x` 相同。 \ No newline at end of file