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

Use @ matrix multiplication syntax to document matrix-matrix multiplication (#1793)

Browse Source 
Co-authored-by: Nick Thompson <nicholas_a_thompson@apple.com>
This commit is contained in:
Nick 2025-01-25 16:02:36 -08:00 committed by GitHub
parent 72146fc4cd
commit 0cea88bcc5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
python/src/linalg.cpp
View File

@ -199,7 +199,7 @@ void init_linalg(nb::module_& parent_module) {
in which case the default stream of the default device is used.
Returns:
tuple(array, array): The ``Q`` and ``R`` matrices.
tuple(array, array): ``Q`` and ``R`` matrices such that ``Q @ R = a``.
Example:
>>> A = mx.array([[2., 3.], [1., 2.]])
@ -310,8 +310,8 @@ void init_linalg(nb::module_& parent_module) {
Returns:
array: If ``upper = False``, it returns a lower triangular ``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``.
that ``L @ L.T = a``. If ``upper = True``, it returns an upper triangular
``U`` matrix such that ``U.T @ U = a``.
)pbdoc");
m.def(
"cholesky_inv",