zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-12-16 01:49:05 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Some fixes in docs (#1141)

Browse Source 
* fixes in docs

* nit
This commit is contained in:
Awni Hannun
2024-05-20 11:51:47 -07:00
committed by GitHub
parent da83f899bb
commit e6fecbb3e1
5 changed files with 44 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
python/src/linalg.cpp
View File

@@ -235,7 +235,7 @@ void init_linalg(nb::module_& parent_module) {
Returns:
tuple(array, array, array): The ``U``, ``S``, and ``Vt`` matrices, such that
``A = U @ diag(S) @ Vt``
``A = U @ diag(S) @ Vt``
)pbdoc");
m.def(
"inv",
@@ -286,7 +286,8 @@ void init_linalg(nb::module_& parent_module) {
in which case the default stream of the default device is used.
Returns:
array: if ``upper = False``, it returns a lower trinagular ``L``matrix such that ``dot(L, L.T) = a``.
If ``upper = True``, it returns an upper triangular ``U`` matrix such that ``dot(U.T, U) = a``.
array: If ``upper = False``, it returns a lower trinagular ``L`` matrix such
that ``dot(L, L.T) = a``. If ``upper = True``, it returns an upper triangular
``U`` matrix such that ``dot(U.T, U) = a``.
)pbdoc");
}