Skip to content

Commit

Permalink
Updated API documents
Browse files Browse the repository at this point in the history
  • Loading branch information
veyron95 committed Sep 23, 2021
1 parent a99dcd8 commit af2dac6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
3 changes: 1 addition & 2 deletions python/paddle/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,5 @@
'broadcast_tensors',
'einsum',
'set_flags',
'get_flags',
'solve'
'get_flags'
]
4 changes: 4 additions & 0 deletions python/paddle/tensor/linalg.py
Original file line number Diff line number Diff line change
Expand Up @@ -1921,18 +1921,22 @@ def solve(x, y, name=None):
Out = X^-1 * Y
Specifically,
- This system of linear equations has one solution if and only if input 'X' is invertible.
Args:
x (Tensor): A square matrix or a batch of square matrices. Its shape should be `[*, M, M]`, where `*` is zero or
more batch dimensions. Its data type should be float32 or float64.
y (Tensor): A vector/matrix or a batch of vectors/matrices. Its shape should be `[*, M, K]`, where `*` is zero or
more batch dimensions. Its data type should be float32 or float64.
name(str, optional): Name for the operation (optional, default is None).
For more information, please refer to :ref:`api_guide_Name`.
Returns:
Tensor: The solution of a square system of linear equations with a unique solution for input 'x' and 'y'.
Its data type should be the same as that of `x`.
Examples:
.. code-block:: python
# a square system of linear equations:
# 2*X0 + X1 = 9
# X0 + 2*X1 = 8
Expand Down

0 comments on commit af2dac6

Please sign in to comment.