From a44fb3e8a630a932dc54b771cd47cd7aaf9da32f Mon Sep 17 00:00:00 2001 From: huanxiaoling <3174348550@qq.com> Date: Wed, 30 Nov 2022 15:01:50 +0800 Subject: [PATCH] modify the format of files 1130 --- .../ops/mindspore.ops.TruncatedNormal.rst | 2 +- .../ops/mindspore.ops.UpperBound.rst | 2 +- .../ops/mindspore.ops.func_coo_cos.rst | 1 + .../ops/mindspore.ops.func_coo_isinf.rst | 6 +-- .../ops/mindspore.ops.func_coo_sigmoid.rst | 12 ++--- .../ops/mindspore.ops.func_coo_sin.rst | 1 + .../ops/mindspore.ops.func_coo_tanh.rst | 10 ++--- .../api_python/ops/mindspore.ops.func_cos.rst | 1 + .../ops/mindspore.ops.func_csr_cos.rst | 1 + .../ops/mindspore.ops.func_csr_isinf.rst | 6 +-- .../ops/mindspore.ops.func_csr_sigmoid.rst | 12 ++--- .../ops/mindspore.ops.func_csr_sin.rst | 1 + .../ops/mindspore.ops.func_csr_tanh.rst | 10 ++--- .../ops/mindspore.ops.func_logdet.rst | 4 +- .../api_python/ops/mindspore.ops.func_sin.rst | 1 + .../ops/mindspore.ops.func_where.rst | 2 +- .../mindspore/ops/function/math_func.py | 2 +- .../ops/function/sparse_unary_func.py | 44 +++++++++---------- 18 files changed, 62 insertions(+), 56 deletions(-) diff --git a/docs/api/api_python/ops/mindspore.ops.TruncatedNormal.rst b/docs/api/api_python/ops/mindspore.ops.TruncatedNormal.rst index 06885eeba72..0bf8f99aef5 100644 --- a/docs/api/api_python/ops/mindspore.ops.TruncatedNormal.rst +++ b/docs/api/api_python/ops/mindspore.ops.TruncatedNormal.rst @@ -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,其数值取自正态分布。 diff --git a/docs/api/api_python/ops/mindspore.ops.UpperBound.rst b/docs/api/api_python/ops/mindspore.ops.UpperBound.rst index 2938b48baad..e27cba11dd1 100644 --- a/docs/api/api_python/ops/mindspore.ops.UpperBound.rst +++ b/docs/api/api_python/ops/mindspore.ops.UpperBound.rst @@ -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` 中上界的索引。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_coo_cos.rst b/docs/api/api_python/ops/mindspore.ops.func_coo_cos.rst index 34c0852761d..2951f1163d2 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_coo_cos.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_coo_cos.rst @@ -19,3 +19,4 @@ mindspore.ops.coo_cos 异常: - **TypeError** - 如果 `x` 不是COOTensor。 + - **TypeError** - 如果 `x` 的数据类型不是float16、float32或者float64、complex64、complex128。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_coo_isinf.rst b/docs/api/api_python/ops/mindspore.ops.func_coo_isinf.rst index e559f3d1fb1..6dd3ee5889a 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_coo_isinf.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_coo_isinf.rst @@ -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。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_coo_sigmoid.rst b/docs/api/api_python/ops/mindspore.ops.func_coo_sigmoid.rst index 11486327427..95496a55561 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_coo_sigmoid.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_coo_sigmoid.rst @@ -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。 \ No newline at end of file + - **TypeError** - `x` 的数据类型不是float16、float32、float64、complex64或complex128。 + - **TypeError** - `x` 不是COOTensor。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_coo_sin.rst b/docs/api/api_python/ops/mindspore.ops.func_coo_sin.rst index e7c7275226f..162f1d9ac87 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_coo_sin.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_coo_sin.rst @@ -16,3 +16,4 @@ mindspore.ops.coo_sin 异常: - **TypeError** - 如果 `x` 不是COOTensor。 + - **TypeError** - 如果 `x` 的数据类型不是float16、float32或者float64、complex64、complex128。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_coo_tanh.rst b/docs/api/api_python/ops/mindspore.ops.func_coo_tanh.rst index 42451a83aea..1ded45db390 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_coo_tanh.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_coo_tanh.rst @@ -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。 \ No newline at end of file + - **TypeError** - `x` 的数据类型既不是float16也不是float32。 + - **TypeError** - `x` 不是COOTensor。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_cos.rst b/docs/api/api_python/ops/mindspore.ops.func_cos.rst index 52bc40f0306..f7968865b50 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_cos.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_cos.rst @@ -19,3 +19,4 @@ mindspore.ops.cos 异常: - **TypeError** - 如果 `x` 不是Tensor。 + - **TypeError** - 如果 `x` 的数据类型不是float16、float32或者float64、complex64、complex128。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_csr_cos.rst b/docs/api/api_python/ops/mindspore.ops.func_csr_cos.rst index 003e8219005..0da400ee0c0 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_csr_cos.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_csr_cos.rst @@ -19,3 +19,4 @@ mindspore.ops.csr_cos 异常: - **TypeError** - 如果 `x` 不是CSRTensor。 + - **TypeError** - 如果 `x` 的数据类型不是float16、float32或者float64、complex64、complex128。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_csr_isinf.rst b/docs/api/api_python/ops/mindspore.ops.func_csr_isinf.rst index ee765ebb490..35873269d1b 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_csr_isinf.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_csr_isinf.rst @@ -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。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_csr_sigmoid.rst b/docs/api/api_python/ops/mindspore.ops.func_csr_sigmoid.rst index 62b33d3452c..43cf0f92f6b 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_csr_sigmoid.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_csr_sigmoid.rst @@ -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。 \ No newline at end of file + - **TypeError** - `x` 的数据类型不是float16、float32、float64、complex64或complex128。 + - **TypeError** - `x` 不是CSRTensor。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_csr_sin.rst b/docs/api/api_python/ops/mindspore.ops.func_csr_sin.rst index f819d88b811..ae14938b57f 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_csr_sin.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_csr_sin.rst @@ -16,3 +16,4 @@ mindspore.ops.csr_sin 异常: - **TypeError** - 如果 `x` 不是CSRTensor。 + - **TypeError** - 如果 `x` 的数据类型不是float16、float32或者float64、complex64、complex128。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_csr_tanh.rst b/docs/api/api_python/ops/mindspore.ops.func_csr_tanh.rst index 01df69158d5..56925d4dd6f 100755 --- a/docs/api/api_python/ops/mindspore.ops.func_csr_tanh.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_csr_tanh.rst @@ -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。 \ No newline at end of file + - **TypeError** - `x` 的数据类型既不是float16也不是float32。 + - **TypeError** - `x` 不是CSRTensor。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_logdet.rst b/docs/api/api_python/ops/mindspore.ops.func_logdet.rst index 17f3f73b5a3..20b6df38d52 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_logdet.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_logdet.rst @@ -8,8 +8,8 @@ 参数: - **x** (Tensor) - 任意维度的Tensor。 - 返回: + 返回: Tensor,`x` 的对数行列式。如果行列式小于0,则返回nan。如果行列式等于0,则返回-inf。 - 异常: + 异常: - **TypeError** - 如果 `x` 的dtype不是float32、float64、Complex64或Complex128。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_sin.rst b/docs/api/api_python/ops/mindspore.ops.func_sin.rst index 4a4457b7dbd..ce11542cda0 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_sin.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_sin.rst @@ -16,3 +16,4 @@ mindspore.ops.sin 异常: - **TypeError** - 如果 `x` 不是Tensor。 + - **TypeError** - 如果 `x` 的数据类型不是float16、float32或者float64、complex64、complex128。 diff --git a/docs/api/api_python/ops/mindspore.ops.func_where.rst b/docs/api/api_python/ops/mindspore.ops.func_where.rst index fde53b95370..be20c9c3034 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_where.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_where.rst @@ -18,4 +18,4 @@ mindspore.ops.where Tensor,其中的元素从 `x` 和 `y` 中选取。 异常: - -**ValueError** - `condition` 不可以被广播成 `x` 的shape。 + - **ValueError** - `condition` 不可以被广播成 `x` 的shape。 diff --git a/mindspore/python/mindspore/ops/function/math_func.py b/mindspore/python/mindspore/ops/function/math_func.py index f1324865f1d..559a0b77b90 100644 --- a/mindspore/python/mindspore/ops/function/math_func.py +++ b/mindspore/python/mindspore/ops/function/math_func.py @@ -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. diff --git a/mindspore/python/mindspore/ops/function/sparse_unary_func.py b/mindspore/python/mindspore/ops/function/sparse_unary_func.py index 20b3536a220..5e655b4fdbd 100755 --- a/mindspore/python/mindspore/ops/function/sparse_unary_func.py +++ b/mindspore/python/mindspore/ops/function/sparse_unary_func.py @@ -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``