mindspore-Ecosystem
/
mindspore
21
0
Fork 27
Code Issues Pull Requests 6 Projects Releases Wiki Activity

!46260 modify the format of files 1130 

Merge pull request !46260 from 宦晓玲/code_docs_1130
This commit is contained in:
i-robot 2022-11-30 08:50:04 +00:00 committed by Gitee
parent 3c800dc56f a44fb3e8a6
commit d9cae8189d
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
18 changed files with 62 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/api_python/ops/mindspore.ops.TruncatedNormal.rst
View File

@ -1,7 +1,7 @@
mindspore.ops.TruncatedNormal
==============================
.. py:class:: mindspore.ops.TruncatedNormal(seed=0, seed2=0, dtype=mindspore.float32)
.. py:class:: mindspore.ops.TruncatedNormal(seed=0, seed2=0, dtype=mstype.float32)
返回一个具有指定shape的Tensor，其数值取自正态分布。

2
docs/api/api_python/ops/mindspore.ops.UpperBound.rst
View File

@ -1,7 +1,7 @@
mindspore.ops.UpperBound
=========================
.. py:class:: mindspore.ops.UpperBound(out_type=mindspore.dtype.int32)
.. py:class:: mindspore.ops.UpperBound(out_type=mstype.int32)
返回一个Tensor，该Tensor包含用于查找 `values` 的值的在升序排列的 `sorted_x` 中上界的索引。

1
docs/api/api_python/ops/mindspore.ops.func_coo_cos.rst
View File

@ -19,3 +19,4 @@ mindspore.ops.coo_cos
异常：
- **TypeError** - 如果 `x` 不是COOTensor。
- **TypeError** - 如果 `x` 的数据类型不是float16、float32或者float64、complex64、complex128。

6
docs/api/api_python/ops/mindspore.ops.func_coo_isinf.rst
View File

@ -1,7 +1,7 @@
mindspore.ops.coo_isinf
========================
.. py:function:: mindspore.ops.coo_isinf(input: COOTensor)
.. py:function:: mindspore.ops.coo_isinf(x: COOTensor)
确定输入COOTensor每个位置上的元素是否为无穷大或无穷小。
@ -14,10 +14,10 @@ mindspore.ops.coo_isinf
其中 :math:`Inf` 表示不是一个数字。
参数：
- **input** (COOTensor) - IsInf的输入，shape： :math:`(N, *)` ，其中 :math:`*` 表示任意数量的附加维度。
- **x** (COOTensor) - IsInf的输入，shape： :math:`(N, *)` ，其中 :math:`*` 表示任意数量的附加维度。
返回：
COOTensor，shape与相同的输入，数据的类型为bool。
异常：
- **TypeError** - 如果 `input` 不是COOTensor。
- **TypeError** - 如果 `x` 不是COOTensor。

12
docs/api/api_python/ops/mindspore.ops.func_coo_sigmoid.rst
View File

@ -1,7 +1,7 @@
mindspore.ops.coo_sigmoid
==========================
.. py:function:: mindspore.ops.coo_sigmoid(input_x: COOTensor)
.. py:function:: mindspore.ops.coo_sigmoid(x: COOTensor)
Sigmoid激活函数，COOTensor逐元素计算Sigmoid激活函数。Sigmoid函数定义为：
@ -9,14 +9,14 @@ mindspore.ops.coo_sigmoid
\text{coo_sigmoid}(x_i) = \frac{1}{1 + \exp(-x_i)}
其中， :math:`x_i` 是input_x的一个元素。
其中， :math:`x_i` 是x的一个元素。
参数：
- **input_x** (COOTensor) - 任意维度的COOTensor，数据类型为float16、float32、float64、complex64或complex128。
- **x** (COOTensor) - 任意维度的COOTensor，数据类型为float16、float32、float64、complex64或complex128。
返回：
COOTensor，数据类型和shape与 `input_x` 的相同。
COOTensor，数据类型和shape与 `x` 的相同。
异常：
- **TypeError** - `input_x` 的数据类型不是float16、float32、float64、complex64或complex128。
- **TypeError** - `input_x` 不是COOTensor。
- **TypeError** - `x` 的数据类型不是float16、float32、float64、complex64或complex128。
- **TypeError** - `x` 不是COOTensor。

1
docs/api/api_python/ops/mindspore.ops.func_coo_sin.rst
View File

@ -16,3 +16,4 @@ mindspore.ops.coo_sin
异常：
- **TypeError** - 如果 `x` 不是COOTensor。
- **TypeError** - 如果 `x` 的数据类型不是float16、float32或者float64、complex64、complex128。

10
docs/api/api_python/ops/mindspore.ops.func_coo_tanh.rst
View File

@ -1,7 +1,7 @@
mindspore.ops.coo_tanh
=======================
.. py:function:: mindspore.ops.coo_tanh(input_x: COOTensor)
.. py:function:: mindspore.ops.coo_tanh(x: COOTensor)
Tanh激活函数。
@ -13,11 +13,11 @@
其中 :math:`x_i` 是输入COOTensor的元素。
参数：
- **input_x** (COOTensor) - Tanh的输入，任意维度的COOTensor，其数据类型为float16或float32。
- **x** (COOTensor) - Tanh的输入，任意维度的COOTensor，其数据类型为float16或float32。
返回：
COOTensor，数据类型和shape与 `input_x` 相同。
COOTensor，数据类型和shape与 `x` 相同。
异常：
- **TypeError** - `input_x` 的数据类型既不是float16也不是float32。
- **TypeError** - `input_x` 不是COOTensor。
- **TypeError** - `x` 的数据类型既不是float16也不是float32。
- **TypeError** - `x` 不是COOTensor。

1
docs/api/api_python/ops/mindspore.ops.func_cos.rst
View File

@ -19,3 +19,4 @@ mindspore.ops.cos
异常：
- **TypeError** - 如果 `x` 不是Tensor。
- **TypeError** - 如果 `x` 的数据类型不是float16、float32或者float64、complex64、complex128。

1
docs/api/api_python/ops/mindspore.ops.func_csr_cos.rst
View File

@ -19,3 +19,4 @@ mindspore.ops.csr_cos
异常：
- **TypeError** - 如果 `x` 不是CSRTensor。
- **TypeError** - 如果 `x` 的数据类型不是float16、float32或者float64、complex64、complex128。

6
docs/api/api_python/ops/mindspore.ops.func_csr_isinf.rst
View File

@ -1,7 +1,7 @@
mindspore.ops.csr_isinf
========================
.. py:function:: mindspore.ops.csr_isinf(input: CSRTensor)
.. py:function:: mindspore.ops.csr_isinf(x: CSRTensor)
确定输入CSRTensor每个位置上的元素是否为无穷大或无穷小。
@ -14,10 +14,10 @@ mindspore.ops.csr_isinf
其中 :math:`Inf` 表示不是一个数字。
参数：
- **input** (CSRTensor) - IsInf的输入，shape： :math:`(N, *)` ，其中 :math:`*` 表示任意数量的附加维度。
- **x** (CSRTensor) - IsInf的输入，shape： :math:`(N, *)` ，其中 :math:`*` 表示任意数量的附加维度。
返回：
CSRTensor，shape与相同的输入，数据的类型为bool。
异常：
- **TypeError** - 如果 `input` 不是CSRTensor。
- **TypeError** - 如果 `x` 不是CSRTensor。

12
docs/api/api_python/ops/mindspore.ops.func_csr_sigmoid.rst
View File

@ -1,7 +1,7 @@
mindspore.ops.csr_sigmoid
==========================
.. py:function:: mindspore.ops.csr_sigmoid(input_x: CSRTensor)
.. py:function:: mindspore.ops.csr_sigmoid(x: CSRTensor)
Sigmoid激活函数，CSRTensor逐元素计算Sigmoid激活函数。Sigmoid函数定义为：
@ -9,14 +9,14 @@ mindspore.ops.csr_sigmoid
\text{csr_sigmoid}(x_i) = \frac{1}{1 + \exp(-x_i)}
其中， :math:`x_i` 是input_x的一个元素。
其中， :math:`x_i` 是x的一个元素。
参数：
- **input_x** (CSRTensor) - 任意维度的CSRTensor，数据类型为float16、float32、float64、complex64或complex128。
- **x** (CSRTensor) - 任意维度的CSRTensor，数据类型为float16、float32、float64、complex64或complex128。
返回：
CSRTensor，数据类型和shape与 `input_x` 的相同。
CSRTensor，数据类型和shape与 `x` 的相同。
异常：
- **TypeError** - `input_x` 的数据类型不是float16、float32、float64、complex64或complex128。
- **TypeError** - `input_x` 不是CSRTensor。
- **TypeError** - `x` 的数据类型不是float16、float32、float64、complex64或complex128。
- **TypeError** - `x` 不是CSRTensor。

1
docs/api/api_python/ops/mindspore.ops.func_csr_sin.rst
View File

@ -16,3 +16,4 @@ mindspore.ops.csr_sin
异常：
- **TypeError** - 如果 `x` 不是CSRTensor。
- **TypeError** - 如果 `x` 的数据类型不是float16、float32或者float64、complex64、complex128。

10
docs/api/api_python/ops/mindspore.ops.func_csr_tanh.rst
View File

@ -1,7 +1,7 @@
mindspore.ops.csr_tanh
=======================
.. py:function:: mindspore.ops.csr_tanh(input_x: CSRTensor)
.. py:function:: mindspore.ops.csr_tanh(x: CSRTensor)
Tanh激活函数。
@ -13,11 +13,11 @@
其中 :math:`x_i` 是输入CSRTensor的元素。
参数：
- **input_x** (CSRTensor) - Tanh的输入，任意维度的CSRTensor，其数据类型为float16或float32。
- **x** (CSRTensor) - Tanh的输入，任意维度的CSRTensor，其数据类型为float16或float32。
返回：
CSRTensor，数据类型和shape与 `input_x` 相同。
CSRTensor，数据类型和shape与 `x` 相同。
异常：
- **TypeError** - `input_x` 的数据类型既不是float16也不是float32。
- **TypeError** - `input_x` 不是CSRTensor。
- **TypeError** - `x` 的数据类型既不是float16也不是float32。
- **TypeError** - `x` 不是CSRTensor。

4
docs/api/api_python/ops/mindspore.ops.func_logdet.rst
View File

@ -8,8 +8,8 @@
参数：
- **x** (Tensor) - 任意维度的Tensor。
返回:
返回：
Tensor，`x` 的对数行列式。如果行列式小于0，则返回nan。如果行列式等于0，则返回-inf。
异常:
异常：
- **TypeError** - 如果 `x` 的dtype不是float32、float64、Complex64或Complex128。

1
docs/api/api_python/ops/mindspore.ops.func_sin.rst
View File

@ -16,3 +16,4 @@ mindspore.ops.sin
异常：
- **TypeError** - 如果 `x` 不是Tensor。
- **TypeError** - 如果 `x` 的数据类型不是float16、float32或者float64、complex64、complex128。

2
docs/api/api_python/ops/mindspore.ops.func_where.rst
View File

@ -18,4 +18,4 @@ mindspore.ops.where
Tensor，其中的元素从 `x` 和 `y` 中选取。
异常：
-**ValueError** - `condition` 不可以被广播成 `x` 的shape。
- **ValueError** - `condition` 不可以被广播成 `x` 的shape。

2
mindspore/python/mindspore/ops/function/math_func.py
View File

@ -2195,7 +2195,7 @@ def inverse(x):
"""
Compute the inverse of the input matrix.
Inputs:
Args:
- **x** (Tensor) - A matrix to be calculated. Input `x` must be at least two dimensions, and the size of
the last two dimensions must be the same size.

44
mindspore/python/mindspore/ops/function/sparse_unary_func.py
View File

@ -1634,14 +1634,14 @@ def csr_tanh(x: CSRTensor) -> CSRTensor:
where :math:`x_i` is an element of the input CSRTensor.
Args:
input_x (CSRTensor): Input CSRTensor, with float16 or float32 data type.
x (CSRTensor): Input CSRTensor, with float16 or float32 data type.
Returns:
CSRTensor, with the same type and shape as the `input_x`.
CSRTensor, with the same type and shape as the `x`.
Raises:
TypeError: If dtype of `input_x` is neither float16 nor float32.
TypeError: If `input_x` is not a CSRTensor.
TypeError: If dtype of `x` is neither float16 nor float32.
TypeError: If `x` is not a CSRTensor.
Supported Platforms:
``Ascend`` ``GPU`` ``CPU``
@ -1674,14 +1674,14 @@ def coo_tanh(x: COOTensor) -> COOTensor:
where :math:`x_i` is an element of the input COOTensor.
Args:
input_x (COOTensor): Input COOTensor, with float16 or float32 data type.
x (COOTensor): Input COOTensor, with float16 or float32 data type.
Returns:
COOTensor, with the same type and shape as the `input_x`.
COOTensor, with the same type and shape as the `x`.
Raises:
TypeError: If dtype of `input_x` is neither float16 nor float32.
TypeError: If `input_x` is not a COOTensor.
TypeError: If dtype of `x` is neither float16 nor float32.
TypeError: If `x` is not a COOTensor.
Supported Platforms:
``Ascend`` ``GPU`` ``CPU``
@ -1929,13 +1929,13 @@ def csr_isinf(x: CSRTensor) -> CSRTensor:
where :math:`Inf` means not a number.
Args:
input (CSRTensor): The input csr_tensor.
x (CSRTensor): The input csr_tensor.
Returns:
CSRTensor, has the same shape of input, and the dtype is bool.
Raises:
TypeError: If `input` is not a CSRTensor.
TypeError: If `x` is not a CSRTensor.
Supported Platforms:
``CPU`` ``GPU``
@ -1969,13 +1969,13 @@ def coo_isinf(x: COOTensor) -> COOTensor:
where :math:`Inf` means not a number.
Args:
input (COOTensor): The input coo_tensor.
x (COOTensor): The input coo_tensor.
Returns:
COOTensor, has the same shape of input, and the dtype is bool.
Raises:
TypeError: If `input` is not a COOTensor.
TypeError: If `x` is not a COOTensor.
Supported Platforms:
``CPU`` ``GPU``
@ -2083,17 +2083,17 @@ def csr_sigmoid(x: CSRTensor) -> CSRTensor:
\text{csr_sigmoid}(x_i) = \frac{1}{1 + \exp(-x_i)}
where :math:`x_i` is an element of the input_x.
where :math:`x_i` is an element of the x.
Args:
input_x (CSRTensor): Input CSRTensor, the data type is float16, float32, float64, complex64 or complex128.
x (CSRTensor): Input CSRTensor, the data type is float16, float32, float64, complex64 or complex128.
Returns:
CSRTensor, with the same type and shape as the input_x.
CSRTensor, with the same type and shape as the x.
Raises:
TypeError: If dtype of `input_x` is not float16, float32, float64, complex64 or complex128.
TypeError: If `input_x` is not a CSRTensor.
TypeError: If dtype of `x` is not float16, float32, float64, complex64 or complex128.
TypeError: If `x` is not a CSRTensor.
Supported Platforms:
``Ascend`` ``GPU`` ``CPU``
@ -2123,17 +2123,17 @@ def coo_sigmoid(x: COOTensor) -> COOTensor:
\text{coo_sigmoid}(x_i) = \frac{1}{1 + \exp(-x_i)}
where :math:`x_i` is an element of the input_x.
where :math:`x_i` is an element of the x.
Args:
input_x (COOTensor): Input COOTensor, the data type is float16, float32, float64, complex64 or complex128.
x (COOTensor): Input COOTensor, the data type is float16, float32, float64, complex64 or complex128.
Returns:
COOTensor, with the same type and shape as the input_x.
COOTensor, with the same type and shape as the x.
Raises:
TypeError: If dtype of `input_x` is not float16, float32, float64, complex64 or complex128.
TypeError: If `input_x` is not a COOTensor.
TypeError: If dtype of `x` is not float16, float32, float64, complex64 or complex128.
TypeError: If `x` is not a COOTensor.
Supported Platforms:
``Ascend`` ``GPU`` ``CPU``