From 0cea88bcc5e98e81a24d92eed8870a6976999f05 Mon Sep 17 00:00:00 2001 From: Nick Date: Sat, 25 Jan 2025 16:02:36 -0800 Subject: [PATCH] Use @ matrix multiplication syntax to document matrix-matrix multiplication (#1793) Co-authored-by: Nick Thompson --- python/src/linalg.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/python/src/linalg.cpp b/python/src/linalg.cpp index e3dfcb32a0..2fd35d1654 100644 --- a/python/src/linalg.cpp +++ b/python/src/linalg.cpp @@ -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",