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

update svd api docs

This commit is contained in:
huanghui 2022-05-31 10:06:10 +08:00
parent d7deca2848
commit 7a0f5f661b
4 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/api_python/mindspore/mindspore.Tensor.rst
View File

@ -1077,8 +1077,8 @@ mindspore.Tensor
**返回：**
- **s** (Tensor) - 奇异值。shape为 :math:`(*, P)`。
- **u** (Tensor) - 左奇异向量。如果compute_uv为False，该值为空Tensor。shape为 :math:`(*, M, P)` 。如果full_matrices为true，则shape为 :math:`(*, M, M)` 。
- **v** (Tensor) - 右奇异向量。如果compute_uv为False，该值为空Tensor。shape为 :math:`(*, P, N)` 。如果full_matrices为true，则shape为 :math:`(*, N, N)` 。
- **u** (Tensor) - 左奇异向量。如果compute_uv为False，该值不会返回。shape为 :math:`(*, M, P)` 。如果full_matrices为true，则shape为 :math:`(*, M, M)` 。
- **v** (Tensor) - 右奇异向量。如果compute_uv为False，该值不会返回。shape为 :math:`(*, P, N)` 。如果full_matrices为true，则shape为 :math:`(*, N, N)` 。
**异常：**

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

@ -19,8 +19,8 @@ mindspore.ops.svd
**返回：**
- **s** (Tensor) - 奇异值。shape为 :math:`(*, P)` 。
- **u** (Tensor) - 左奇异向量。如果compute_uv为False，该值为空Tensor。shape为 :math:`(*, M, P)` 。如果full_matrices为true，则shape为 :math:`(*, M, M)` 。
- **v** (Tensor) - 右奇异向量。如果compute_uv为False，该值为空Tensor。shape为 :math:`(*, P, N)` 。如果full_matrices为true，则shape为 :math:`(*, N, N)` 。
- **u** (Tensor) - 左奇异向量。如果compute_uv为False，该值不会返回。shape为 :math:`(*, M, P)` 。如果full_matrices为true，则shape为 :math:`(*, M, M)` 。
- **v** (Tensor) - 右奇异向量。如果compute_uv为False，该值不会返回。shape为 :math:`(*, P, N)` 。如果full_matrices为true，则shape为 :math:`(*, N, N)` 。
**异常：**

6
mindspore/python/mindspore/common/tensor.py
View File

@ -3417,9 +3417,9 @@ class Tensor(Tensor_):
Returns:
- **s** (Tensor) - Singular values. The shape is :math:`(*, P)`.
- **u** (Tensor) - Left singular vectors. If compute_uv is False, u will be an empty tensor.
- **u** (Tensor) - Left singular vectors. If compute_uv is False, u will not be returned.
The shape is :math:`(*, M, P)`. If full_matrices is True, the shape will be :math:`(*, M, M)`.
- **v** (Tensor) - Right singular vectors. If compute_uv is False, v will be an empty tensor.
- **v** (Tensor) - Right singular vectors. If compute_uv is False, v will not be returned.
The shape is :math:`(*, P, N)`. If full_matrices is True, the shape will be :math:`(*, N, N)`.
Raises:
@ -3428,7 +3428,7 @@ class Tensor(Tensor_):
TypeError: If the type of input is not one of the following dtype: mstype.float32, mstype.float64.
Supported Platforms:
``GPU``
``GPU`` ``CPU``
Examples:
>>> import numpy as np

6
mindspore/python/mindspore/ops/function/linalg_func.py
View File

@ -38,9 +38,9 @@ def svd(a, full_matrices=False, compute_uv=True):
Returns:
- **s** (Tensor) - Singular values. The shape is :math:`(*, P)`.
- **u** (Tensor) - Left singular vectors. If compute_uv is False, u will be an empty tensor.
- **u** (Tensor) - Left singular vectors. If compute_uv is False, u will not be returned.
The shape is :math:`(*, M, P)`. If full_matrices is True, the shape will be :math:`(*, M, M)`.
- **v** (Tensor) - Right singular vectors. If compute_uv is False, v will be an empty tensor.
- **v** (Tensor) - Right singular vectors. If compute_uv is False, v will not be returned.
The shape is :math:`(*, P, N)`. If full_matrices is True, the shape will be :math:`(*, N, N)`.
Raises:
@ -49,7 +49,7 @@ def svd(a, full_matrices=False, compute_uv=True):
TypeError: If the type of input is not one of the following dtype: mstype.float32, mstype.float64.
Supported Platforms:
``GPU``
``GPU`` ``CPU``
Examples:
>>> import numpy as np