Nigel
/
mindspore
forked from mindspore-Ecosystem/mindspore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

!32055 fix doc string 

Merge pull request !32055 from hezhenhao1/code_docs
This commit is contained in:
i-robot 2022-03-28 03:16:22 +00:00 committed by Gitee
parent 1997743520 db66e321dc
commit 44f2e803a2
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
mindspore/python/mindspore/scipy/sparse/linalg.py
View File

@ -458,6 +458,8 @@ def cg(A, b, x0=None, *, tol=1e-5, atol=0.0, maxiter=None, M=None, callback=None
- `cg` is not supported on Windows platform yet. - `cg` is not supported on Windows platform yet.
- Currently, when `A` is a CSRTensor, the derivatives of `cg` is not supported on PyNative mode.
Args: Args:
A (Union[Tensor, CSRTensor, function]): 2D Tensor, CSRTensor or function that calculates the linear A (Union[Tensor, CSRTensor, function]): 2D Tensor, CSRTensor or function that calculates the linear
map (matrix-vector product) :math:`Ax` when called like :math:`A(x)`. map (matrix-vector product) :math:`Ax` when called like :math:`A(x)`.
@ -471,7 +473,7 @@ def cg(A, b, x0=None, *, tol=1e-5, atol=0.0, maxiter=None, M=None, callback=None
atol (float, optional): The same as `tol`. Default: 0.0. atol (float, optional): The same as `tol`. Default: 0.0.
maxiter (int): Maximum number of iterations. Iteration will stop after maxiter maxiter (int): Maximum number of iterations. Iteration will stop after maxiter
steps even if the specified tolerance has not been achieved. Default: None. steps even if the specified tolerance has not been achieved. Default: None.
M (Union[Tensor, function]): Preconditioner for A. The preconditioner should approximate the M (Union[Tensor, CSRTensor, function]): Preconditioner for A. The preconditioner should approximate the
inverse of A. Effective preconditioning dramatically improves the inverse of A. Effective preconditioning dramatically improves the
rate of convergence, which implies that fewer iterations are needed rate of convergence, which implies that fewer iterations are needed
to reach a given error tolerance. Default: None. to reach a given error tolerance. Default: None.