!46631 fix docs master

Merge pull request !46631 from 李林杰/code_docs_1209_fix_docs_master
This commit is contained in:
i-robot 2022-12-09 09:31:38 +00:00 committed by Gitee
commit b908a1c1a2
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
13 changed files with 55 additions and 25 deletions

View File

@ -19,13 +19,13 @@
- **keep_dims** (bool) - 表示是否减少维度。如果为True则输出维度和输入维度相同。如果为False则减少输出维度。默认值False。 - **keep_dims** (bool) - 表示是否减少维度。如果为True则输出维度和输入维度相同。如果为False则减少输出维度。默认值False。
输入: 输入:
- **x** (Tensor) - 输入任意维度的Tensor。将输入Tensor的shape设为 :math:`(x_1, x_2, ..., x_N)` - **x** (Tensor) - 输入任意维度的Tensor。将输入Tensor的shape设为 :math:`(x_1, x_2, ..., x_N)`不支持复数类型。
输出: 输出:
tuple (Tensor)表示2个Tensor组成的tuple包含对应的索引和输入Tensor的最小值。 tuple (Tensor)表示2个Tensor组成的tuple包含对应的索引和输入Tensor的最小值。
- **index** (Tensor) - 输入Tensor最小值的索引。如果 `keep_dims` 为True则输出Tensor的shape为 :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)` 。否则shape为 :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` - **index** (Tensor) - 输入Tensor最小值的索引数据类型为int32。如果 `keep_dims` 为True则输出Tensor的shape为 :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)` 。否则shape为 :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)`
- **values** (Tensor) - 输入Tensor的最小值其shape与索引相同。 - **values** (Tensor) - 输入Tensor的最小值其shape与 `index` 相同,数据类型与 `x` 相同。
异常: 异常:
- **TypeError** - `x` 不是Tensor。 - **TypeError** - `x` 不是Tensor。

View File

@ -5,6 +5,9 @@ mindspore.ops.MatrixTriangularSolve
返回一个新Tensor其为含上三角矩阵或下三角矩阵的线性方程组的解。 返回一个新Tensor其为含上三角矩阵或下三角矩阵的线性方程组的解。
.. note::
在GPU上支持广播机制。
参数: 参数:
- **lower** (bool可选) - 如果为True `matrix` 的最内矩阵为下三角矩阵。默认值True。 - **lower** (bool可选) - 如果为True `matrix` 的最内矩阵为下三角矩阵。默认值True。
- **adjoint** (bool可选) - 如果为True使用 `matrix` 的伴随求解。默认值False。 - **adjoint** (bool可选) - 如果为True使用 `matrix` 的伴随求解。默认值False。
@ -19,6 +22,7 @@ mindspore.ops.MatrixTriangularSolve
异常: 异常:
- **TypeError** - 如果 `matrix``rhs` 不是Tensor。 - **TypeError** - 如果 `matrix``rhs` 不是Tensor。
- **TypeError** - 如果 `lower``adjoint` 不是bool型。 - **TypeError** - 如果 `lower``adjoint` 不是bool型。
- **ValueError** - 如果 `matrix``rhs` 的batch大小不相等。 - **ValueError** - 如果在GPU平台上 `matrix``rhs` 的batch大小不满足广播条件或者在
其他平台上 `matrix``rhs` 的batch大小不相等。
- **ValueError** - 如果 `matrix` 的最内两维不相等。 - **ValueError** - 如果 `matrix` 的最内两维不相等。
- **ValueError** - 如果 `matrix``rhs` 的倒数第二维不相等。 - **ValueError** - 如果 `matrix``rhs` 的倒数第二维不相等。

View File

@ -11,7 +11,7 @@
- **dtype** (mindspore.dtype) - 输出的数据类型。默认值mindspore.int32。 - **dtype** (mindspore.dtype) - 输出的数据类型。默认值mindspore.int32。
输入: 输入:
- **n** (Tensor[int32]) - shape为 :math:`(1,)` 的输入Tensor须在[0, `max_length`]内取值。 - **n** (Tensor) - shape为 :math:`(1,)` 的输入Tensor其数据类型为int32或int64,须在[0, `max_length`]内取值。
输出: 输出:
- **output** (Tensor) - shape: (`max_length`,),数据类型为 `dtype` - **output** (Tensor) - shape: (`max_length`,),数据类型为 `dtype`
@ -21,3 +21,6 @@
- **TypeError** - `n` 不是Tensor。 - **TypeError** - `n` 不是Tensor。
- **TypeError** - `n` 包含非int元素。 - **TypeError** - `n` 包含非int元素。
- **TypeError** - `n` 包含负数。 - **TypeError** - `n` 包含负数。
- **TypeError** - `dtype` 不被支持。
- **ValueError** - `n` 超出 `dtype` 的有效范围。
- **ValueError** - `n` 大于 `max_length`

View File

@ -9,11 +9,11 @@ mindspore.ops.acos
out_i = cos^{-1}(x_i) out_i = cos^{-1}(x_i)
参数: 参数:
- **x** (Tensor) - Tensor的shape为 :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度。数据类型应该是以下类型之一float16、float32、float64。 - **x** (Tensor) - Tensor的shape为 :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度。
返回: 返回:
Tensorshape和数据类型与 `x` 相同。 Tensorshape和数据类型与 `x` 相同。
异常: 异常:
- **TypeError** - 如果 `x` 不是Tensor。 - **TypeError** - 如果 `x` 不是Tensor。
- **TypeError** - 如果 `x` 的数据类型不是float16、float32或float64 - **TypeError** - 如果 `x` 的数据类型不是float16、float32、float64、complex64或complex128

View File

@ -9,11 +9,11 @@ mindspore.ops.asin
out_i = sin^{-1}(x_i) out_i = sin^{-1}(x_i)
参数: 参数:
- **x** (Tensor) - Tensor的shape为 :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度。数据类型应该是以下类型之一float16、float32、float64。 - **x** (Tensor) - Tensor的shape为 :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度。
返回: 返回:
Tensor数据类型和shape与 `x` 相同。 Tensor数据类型和shape与 `x` 相同。
异常: 异常:
- **TypeError** - 如果 `x` 不是Tensor。 - **TypeError** - 如果 `x` 不是Tensor。
- **TypeError** - 如果 `x` 的数据类型不是float16、float32、float64。 - **TypeError** - 如果 `x` 的数据类型不是float16、float32、float64、complex64或complex128

View File

@ -9,13 +9,13 @@ mindspore.ops.cos
out_i = cos(x_i) out_i = cos(x_i)
.. warning:: .. warning::
目前支持float16、float32数据类型。如果使用float64可能会存在精度丢失的问题。 如果使用float64可能会存在精度丢失的问题。
参数: 参数:
- **x** (Tensor) - Tensor的shape为 :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度。 - **x** (Tensor) - Tensor的shape为 :math:`(N,*)` ,其中 :math:`*` 表示任意数量的附加维度。
返回: 返回:
Tensorshape与 `x` 相同。 Tensorshape和数据类型`x` 相同。
异常: 异常:
- **TypeError** - 如果 `x` 不是Tensor。 - **TypeError** - 如果 `x` 不是Tensor。

View File

@ -10,11 +10,11 @@ mindspore.ops.erfc
erfc(x) = 1 - \frac{2} {\sqrt{\pi}} \int\limits_0^{x} e^{-t^{2}} dt erfc(x) = 1 - \frac{2} {\sqrt{\pi}} \int\limits_0^{x} e^{-t^{2}} dt
参数: 参数:
- **x** (Tensor) - 互补误差函数的输入Tensor。维度必须小于8数据类型必须为float16或float32 - **x** (Tensor) - 互补误差函数的输入Tensor。维度必须小于8数据类型必须为float16、float32或float64
返回: 返回:
Tensor具有与 `x` 相同的数据类型和shape。 Tensor具有与 `x` 相同的数据类型和shape。
异常: 异常:
- **TypeError** - `x` 不是Tensor。 - **TypeError** - `x` 不是Tensor。
- **TypeError** - `x` 的数据类型既不是float16也不是float32 - **TypeError** - `x` 的数据类型既不是float16、float32或float64

View File

@ -15,17 +15,17 @@ mindspore.ops.min
- "axis"的取值范围为[-dims, dims - 1]。"dims"为"x"的维度长度。 - "axis"的取值范围为[-dims, dims - 1]。"dims"为"x"的维度长度。
参数: 参数:
- **x** (Tensor) - 输入任意维度的Tensor。将输入Tensor的shape设为 :math:`(x_1, x_2, ..., x_N)` 。数类型为mindspore.uint16mindspore.uint32mindspore.int16mindspore.int32mindspore.float16或者mindspore.float32 - **x** (Tensor) - 输入任意维度的Tensor。将输入Tensor的shape设为 :math:`(x_1, x_2, ..., x_N)`不支持复数类型。
- **axis** (int) - 指定计算维度。默认值0。 - **axis** (int) - 指定计算维度。默认值0。
- **keep_dims** (bool) - 表示是否减少维度如果为True输出将与输入保持相同的维度如果为False输出将减少维度。默认值False。 - **keep_dims** (bool) - 表示是否减少维度如果为True输出将与输入保持相同的维度如果为False输出将减少维度。默认值False。
返回: 返回:
tuple (Tensor)表示2个Tensor组成的tuple包含对应的索引和输入Tensor的最小值。 tuple (Tensor)表示2个Tensor组成的tuple包含对应的索引和输入Tensor的最小值。
- **index** (Tensor) - 输入Tensor最小值的索引。如果 `keep_dims` 为True则输出Tensor的shape为 :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)` 。否则shape为 :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` - **index** (Tensor) - 输入Tensor最小值的索引其数据类型为int32。如果 `keep_dims` 为True则输出Tensor的shape为 :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)` 。否则shape为 :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)`
- **output_x** (Tensor) - 输入Tensor的最小值其shape与索引相同。 - **output_x** (Tensor) - 输入Tensor的最小值其shape与 `index` 相同,数据类型与 `x` 相同。
异常: 异常:
- **TypeError** - `input_x` 的数据类型非uint16uint32int16int32float16float32 - **TypeError** - `input_x` 不是Tensor
- **TypeError** - `keep_dims` 不是bool。 - **TypeError** - `keep_dims` 不是bool。
- **TypeError** - `axis` 不是int。 - **TypeError** - `axis` 不是int。

View File

@ -9,10 +9,10 @@ mindspore.ops.neg
out_{i} = - x_{i} out_{i} = - x_{i}
参数: 参数:
- **x** (Tensor) - Neg的输入shape :math:`(N, *)` ,其中 :math:`*` 表示任意数量的附加维度。秩应小于8。其数据类型为数值型。 - **x** (Tensor) - Neg的输入Tensor其秩应在[0, 7]范围内,数据类型为数值型。
返回: 返回:
Tensorshape和类型与输入相同。 Tensorshape和数据类型与输入相同。
异常: 异常:
- **TypeError** - `x` 不是Tensor。 - **TypeError** - `x` 不是Tensor。

View File

@ -12,7 +12,7 @@ mindspore.ops.sin
- **x** (Tensor) - Tensor的shape为 :math:`(N,*)` 其中 :math:`*` 表示任意数量的附加维度。 - **x** (Tensor) - Tensor的shape为 :math:`(N,*)` 其中 :math:`*` 表示任意数量的附加维度。
返回: 返回:
Tensorshape与 `x` 相同。 Tensorshape和数据类型`x` 相同。
异常: 异常:
- **TypeError** - 如果 `x` 不是Tensor。 - **TypeError** - 如果 `x` 不是Tensor。

View File

@ -5036,7 +5036,8 @@ def min(x, axis=0, keep_dims=False):
- **index** (Tensor) - The index for the minimum value of the input tensor, with dtype int32. If `keep_dims` - **index** (Tensor) - The index for the minimum value of the input tensor, with dtype int32. If `keep_dims`
is true, the shape of output tensors is :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)`. is true, the shape of output tensors is :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)`.
Otherwise, the shape is :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` . Otherwise, the shape is :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` .
- **values** (Tensor) - The minimum value of input tensor, with the same shape as index, and same dtype as x. - **values** (Tensor) - The minimum value of input tensor, with the same
shape as `index`, and same dtype as `x`.
Raises: Raises:
TypeError: If `x` is not Tensor. TypeError: If `x` is not Tensor.

View File

@ -2062,7 +2062,8 @@ class ArgMinWithValue(Primitive):
- **index** (Tensor) - The index for the minimum value of the input tensor, with dtype int32. If `keep_dims` - **index** (Tensor) - The index for the minimum value of the input tensor, with dtype int32. If `keep_dims`
is true, the shape of output tensors is :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)`. is true, the shape of output tensors is :math:`(x_1, x_2, ..., x_{axis-1}, 1, x_{axis+1}, ..., x_N)`.
Otherwise, the shape is :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` . Otherwise, the shape is :math:`(x_1, x_2, ..., x_{axis-1}, x_{axis+1}, ..., x_N)` .
- **values** (Tensor) - The minimum value of input tensor, with the same shape as index, and same dtype as x. - **values** (Tensor) - The minimum value of input tensor, with the same
shape as `index`, and same dtype as `x`.
Raises: Raises:
TypeError: If `x` is not Tensor. TypeError: If `x` is not Tensor.
@ -5737,7 +5738,27 @@ class Sort(Primitive):
""" """
Sorts the elements of the input tensor along the given dimension in the specified order. Sorts the elements of the input tensor along the given dimension in the specified order.
Refer to :func:`mindspore.ops.sort` for more details. .. warning::
Currently, the data types of Float16 is well supported.
Using Float32 might cause loss of accuracy.
Args:
axis (int): The dimension to sort along. Default: -1.
descending (bool): Controls the sort order. If descending is True then the elements
are sorted in descending order by value. Default: False.
Inputs:
x(Tensor): The input tensor of any dimension, with a type of float16 or float32.
Outputs:
y1(Tensor) - A tensor whose values are the sorted values, with the same shape and data type as input.
y2(Tensor) - The indices of the elements in the original input tensor. Data type is int32.
Raises:
TypeError: If `axis` is not an int.
TypeError: If `descending` is not a bool.
TypeError: If dtype of `x` is neither float16 nor float32.
ValueError: If `axis` is not in range of [-len(x.shape), len(x.shape)).
Supported Platforms: Supported Platforms:
``Ascend`` ``GPU`` ``CPU`` ``Ascend`` ``GPU`` ``CPU``

View File

@ -70,7 +70,8 @@ class Randperm(Primitive):
dtype (mindspore.dtype): The type of output. Default: mindspore.int32. dtype (mindspore.dtype): The type of output. Default: mindspore.int32.
Inputs: Inputs:
- **n** (Tensor) - The input tensor with shape (1,) and dtype int32 or int64. 'n' must be in [0, `max_length`]. - **n** (Tensor) - The input tensor with shape (1,) with and dtype int32 or int64.
`n` must be in range [0, `max_length`].
Outputs: Outputs:
- **output** (Tensor) - The output Tensor with shape: (`max_length`,) and type: `dtype`. - **output** (Tensor) - The output Tensor with shape: (`max_length`,) and type: `dtype`.