!45451 modify format

Merge pull request !45451 from 俞涵/code_docs_1110
This commit is contained in:
i-robot 2022-11-14 01:51:17 +00:00 committed by Gitee
commit 2e2d70f6cf
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
23 changed files with 35 additions and 97 deletions

View File

@ -3,6 +3,4 @@ mindspore.Tensor.absolute
.. py:method:: mindspore.Tensor.absolute()
Tensor.abs()的别名。
详情请参考 :func:`mindspore.ops.abs`
:func:`mindspore.Tensor.abs` 的别名。

View File

@ -3,15 +3,4 @@ mindspore.Tensor.addcdiv
.. py:method:: mindspore.Tensor.addcdiv(x1, x2, value)
逐元素执行x1除以x2将结果乘以标量value并将其添加到输入。
.. math::
y[i] = input\_data[i] + value[i] * (x1[i] / x2[i])
参数:
- **x1** (Tensor) - 分子张量。
- **x2** (Tensor) - 分母张量。
- **value** (Tensor) - x1/x2的倍数。
返回:
Tensorshape和数据类型与当前Tensor相同。
详情请参考 :func:`mindspore.ops.addcdiv`

View File

@ -3,15 +3,4 @@ mindspore.Tensor.addcmul
.. py:method:: mindspore.Tensor.addcmul(x1, x2, value)
逐元素执行x1乘以x2将结果乘以标量value并将其添加到输入。
.. math::
y[i] = input\_data[i] + value[i] * (x1[i] * x2[i])
参数:
- **x1** (Tensor) - 要相乘的张量。
- **x2** (Tensor) - 要相乘的张量。
- **value** (Tensor) - x1*x2的倍数。
返回:
Tensorshape和数据类型与当前Tensor相同。
详情请参考 :func:`mindspore.ops.addcmul`

View File

@ -3,6 +3,4 @@ mindspore.Tensor.arccos
.. py:method:: mindspore.Tensor.arccos()
Tensor.acos()的别名。
详情请参考 :func:`mindspore.ops.acos`
:func:`mindspore.Tensor.acos` 的别名。

View File

@ -3,6 +3,4 @@ mindspore.Tensor.arcsinh
.. py:method:: mindspore.Tensor.arcsinh()
Tensor.asinh()的别名。
详情请参考 :func:`mindspore.ops.asinh`
:func:`mindspore.Tensor.asinh` 的别名。

View File

@ -3,6 +3,4 @@ mindspore.Tensor.arctanh
.. py:method:: mindspore.Tensor.arctanh()
Tensor.atanh()的别名。
详情请参考 :func:`mindspore.ops.atanh`
:func:`mindspore.Tensor.atanh` 的别名。

View File

@ -3,4 +3,4 @@ mindspore.Tensor.det
.. py:method:: mindspore.Tensor.det()
参考 `Tensor.matrix_determinant() <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/Tensor/mindspore.Tensor.matrix_determinant.html>`_
:func:`mindspore.Tensor.matrix_determinant` 的别名

View File

@ -3,13 +3,4 @@ mindspore.Tensor.erfinv
.. py:method:: mindspore.Tensor.erfinv()
计算输入的逆误差函数。逆误差函数在 `(-1, 1)` 范围内定义为:
.. math::
erfinv(erf(x)) = x
返回:
Tensor具有与当前Tensor相同的数据类型和shape。
异常:
- **TypeError** - 当前Tensor的数据类型不是float16、float32、float64。
详情请参考 :func:`mindspore.ops.erfinv`

View File

@ -3,4 +3,4 @@ mindspore.Tensor.ndimension
.. py:method:: mindspore.Tensor.ndimension()
参考 `Tensor.ndim() <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/Tensor/mindspore.Tensor.ndim.html>`_
:func:`mindspore.Tensor.ndim` 的别名

View File

@ -3,6 +3,4 @@ mindspore.Tensor.nelement
.. py:method:: mindspore.Tensor.nelement()
numel()的别名。
详情请参考 :func:`mindspore.ops.numel`
:func:`mindspore.Tensor.numel` 的别名。

View File

@ -3,4 +3,4 @@ mindspore.Tensor.numpy
.. py:method:: mindspore.Tensor.numpy()
参考 `Tensor.asnumpy() <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/Tensor/mindspore.Tensor.asnumpy.html>`_
:func:`mindspore.Tensor.ndim` 的别名

View File

@ -10,9 +10,9 @@ mindspore.Tensor.poisson
\text{out}_i \sim \text{Poisson}(\text{input}_i)out*i*Poisson(input*i*)
参数:
- **shape** (tuple) - 要生成的随机张量的形状。只允许使用常量值。
- **seed** (int, option) - 设置随机种子0到2**32
- **seed2** (int, option) - 将随机seed2设置为0到2**32
- **shape** (tuple) - 要生成的随机张量的形状。只允许使用常量值。
- **seed** (int, option) - 设置随机种子0到2**32
- **seed2** (int, option) - 将随机seed2设置为0到2**32
返回:
Tensor形状与input_Tensor相同。

View File

@ -3,5 +3,5 @@ mindspore.Tensor.subtract
.. py:method:: mindspore.Tensor.subtract(other, *, alpha=1)
获取更多详情请查看::func:`mindspore.ops.subtract`
详情请参考 :func:`mindspore.ops.subtract`

View File

@ -3,7 +3,4 @@ mindspore.Tensor.true_divide
.. py:method:: mindspore.Tensor.true_divide(value)
当Tensor.div()的 :math:`rounding\_mode=None` 时的别名。
参考 `Tensor.div() <https://www.mindspore.cn/docs/zh-CN/master/api_python/mindspore/Tensor/mindspore.Tensor.div.html>`_
:func:`mindspore.Tensor.div`:math:`rounding\_mode=None` 的别名。

View File

@ -3,17 +3,4 @@ mindspore.Tensor.unbind
.. py:method:: mindspore.Tensor.unbind(dim=0)
根据指定轴对输入矩阵进行分解。
若输入Tensor在指定的轴上的rank为 `R` 则输出Tensor的rank为 `(R-1)`
给定一个shape为 :math:`(x_1, x_2, ..., x_R)` 的Tensor。如果存在 :math:`0 \le axis` 则输出Tensor的shape为 :math:`(x_1, x_2, ..., x_{axis}, x_{axis+2}, ..., x_R)`
参数:
- **dim** (int) - 指定矩阵分解的轴。取值范围为[-R, R)默认值0。
返回:
Tensor对象组成的tuple。每个Tensor对象的shape相同。
异常:
- **ValueError** - `dim` 超出[-R, R)范围。
详情请参考 :func:`mindspore.ops.unbind`

View File

@ -1,7 +1,7 @@
mindspore.ops.addbmm
=====================
.. py:class:: mindspore.ops.addbmm(x, batch1, batch2, *, beta=1, alpha=1)
.. py:function:: mindspore.ops.addbmm(x, batch1, batch2, *, beta=1, alpha=1)
`batch1``batch2` 应用批量矩阵乘法后进行reduced add。矩阵 `x` 和最终的结果相加。
`alpha``beta` 分别是 `batch1``batch2` 矩阵乘法和 `x` 的乘数。如果 `beta` 是0那么 `x` 将会被忽略。

View File

@ -1,7 +1,7 @@
mindspore.ops.addmm
====================
.. py:class:: mindspore.ops.addmm(x, mat1, mat2, *, beta=1, alpha=1)
.. py:function:: mindspore.ops.addmm(x, mat1, mat2, *, beta=1, alpha=1)
`mat1``mat2` 应用矩阵乘法。矩阵 `x` 和最终的结果相加。 `alpha``beta` 分别是 `mat1``mat2` 矩阵乘法和 `x` 的乘数。如果 `beta` 是0那么 `x` 将会被忽略。

View File

@ -1,7 +1,7 @@
mindspore.ops.adjoint
======================
.. py:class:: mindspore.ops.adjoint(x)
.. py:function:: mindspore.ops.adjoint(x)
计算张量的共轭,并转置最后两个维度。

View File

@ -1,7 +1,7 @@
mindspore.ops.blackman_window
=============================
.. py:function:: mindspore.ops.blackman_window(window_length, periodic=True, dtype=mstype.float32)
.. py:function:: mindspore.ops.blackman_window(window_length, periodic=True, *, dtype=None)
布莱克曼窗口函数。
@ -15,7 +15,9 @@ mindspore.ops.blackman_window
参数:
- **window_length** (Tensor) - 返回窗口的大小数据类型为int32int64。输入数据的值为[0,1000000]的整数。
- **periodic** (bool) - 如果为True返回一个窗口作为周期函数使用。如果为False返回一个对称窗口。默认值True。
- **dtype** (mindspore.dtype) - 输出数据类型目前只支持float16、float32和float64。默认值mindspore.float32。
关键字参数:
- **dtype** (mindspore.dtype) - 输出数据类型目前只支持float16、float32和float64。默认值None。
返回:
1D Tensor大小为 `window_length` ,数据类型与 `dtype` 一致。

View File

@ -7,7 +7,7 @@ mindspore.ops.masked_fill
参数:
- **input_x** (Tensor) - 输入Tensor其数据类型为bool, uint8, int8, int16, int32,
int64, float16, float32, float64, complex64或complex128。
int64, float16, float32, float64, complex64或complex128。
- **mask** (Tensor[bool]) - 输入的掩码其数据类型为bool。
- **value** (Union[float, Tensor]) - 用来填充的值,其数据类型与 `input_x` 相同。
@ -18,8 +18,7 @@ mindspore.ops.masked_fill
- **TypeError** - `mask` 的数据类型不是bool。
- **TypeError** - `input_x``mask` 不是Tensor。
- **ValueError** - `input_x``mask` 的shape不可广播。
- **TypeError** - `input_x``value` 的数据类型不是bool, uint8, int8, int16, int32,
int64, float16, float32, float64, complex64或complex128。
- **TypeError** - `input_x``value` 的数据类型不是bool, uint8, int8, int16, int32, int64, float16, float32, float64, complex64或complex128。
- **TypeError** - `value` 的数据类型与 `input_x` 不同。
- **TypeError** - `value` 既不是float也不是Tensor。

View File

@ -1,7 +1,7 @@
mindspore.ops.subtract
=======================
.. py:class:: mindspore.ops.subtract(x, other, *, alpha=1)
.. py:function:: mindspore.ops.subtract(x, other, *, alpha=1)
对Tensor进行逐元素的减法。

View File

@ -1,7 +1,7 @@
mindspore.ops.true_divide
==========================
.. py:class:: mindspore.ops.true_divide(dividend, divisor)
.. py:function:: mindspore.ops.true_divide(dividend, divisor)
ops.div()在 :math:`rounding\_mode=None` 时的别名。

View File

@ -584,6 +584,7 @@ class Tensor(Tensor_):
Args:
seed (int, option): set the random seed (0 to 2**32)
seed2 (int, option): set the random seed2 (0 to 2**32)
Inputs:
- **shape** (tuple) - The shape of random tensor to be generated. Only constant value is allowed.
@ -639,8 +640,7 @@ class Tensor(Tensor_):
def ndimension(self):
r"""
Refer to `Tensor.ndim()
<https://www.mindspore.cn/docs/en/master/api_python/mindspore/Tensor/mindspore.Tensor.ndim.html>`_.
Alias for :func:`mindspore.Tensor.ndim`.
"""
return len(self._shape)
@ -1343,8 +1343,7 @@ class Tensor(Tensor_):
def arccos(self):
r"""
Alias for Tensor.acos().
For details, please refer to :func:`mindspore.ops.acos`.
Alias for :func:`mindspore.Tensor.acos`.
"""
return self.acos()
@ -1419,8 +1418,7 @@ class Tensor(Tensor_):
def absolute(self):
"""
Alias for Tensor.abs().
For details, please refer to :func:`mindspore.ops.abs`.
Alias for :func:`mindspore.Tensor.abs`.
"""
return self.abs()
@ -1783,9 +1781,7 @@ class Tensor(Tensor_):
def nelement(self):
r"""
Alias for numel().
For details, please refer to :func:`mindspore.ops.numel`.
Alias for :func:`mindspore.Tensor.numel`.
"""
self._init_check()
return tensor_operator_registry.get('nelement')(self)
@ -3735,8 +3731,7 @@ class Tensor(Tensor_):
def arcsinh(self):
r"""
Alias for Tensor.asinh().
For details, please refer to :func:`mindspore.ops.asinh`.
Alias for :func:`mindspore.Tensor.asinh`.
"""
self._init_check()
return tensor_operator_registry.get('asinh')(self)
@ -3757,8 +3752,7 @@ class Tensor(Tensor_):
def arctanh(self):
r"""
Alias for Tensor.atanh().
For details, please refer to :func:`mindspore.ops.atanh`.
Alias for :func:`mindspore.Tensor.atanh`.
"""
self._init_check()
return tensor_operator_registry.get('atanh')(self)