mlx/docs/src/python/linalg.rst

.. _linalg:

Linear Algebra
==============

.. currentmodule:: mlx.core.linalg

.. autosummary:: 
   :toctree: _autosummary 

    inv
    tri_inv
    norm
    cholesky
    cholesky_inv
    qr
    svd
linalg.norm (#187) * implemented vector_norm in cpp added linalg to mlx * implemented vector_norm python binding * renamed vector_norm to norm, implemented norm without provided ord * completed the implementation of the norm * added tests * removed unused import in linalg.cpp * updated python bindings * added some tests for python bindings * handling inf, -inf as numpy does, more extensive tests of compatibility with numpy * added better docs and examples * refactored mlx.linalg.norm bindings * reused existing util for implementation of linalg.norm * more tests * fixed a bug with no ord and axis provided * removed unused imports * some style and API consistency updates to linalg norm * remove unused includes * fix python tests * fixed a bug with frobenius norm of a complex-valued matrix * complex for vector too --------- Co-authored-by: Awni Hannun <awni@apple.com> 2023-12-27 11:42:04 +08:00			`.. _linalg:`

			`Linear Algebra`
			`==============`

			`.. currentmodule:: mlx.core.linalg`

			`.. autosummary::`
			`:toctree: _autosummary`

Add missing docs for some ops (#1110) 2024-05-14 21:09:05 +08:00			`inv`
CPU mx.linalg.cholesky_inverse and mx.linalg.tri_inv (#1307) * add cholesky inv + tri inv * always run tri_inv on cpu * consistent naming 2024-08-09 06:18:02 +08:00			`tri_inv`
linalg.norm (#187) * implemented vector_norm in cpp added linalg to mlx * implemented vector_norm python binding * renamed vector_norm to norm, implemented norm without provided ord * completed the implementation of the norm * added tests * removed unused import in linalg.cpp * updated python bindings * added some tests for python bindings * handling inf, -inf as numpy does, more extensive tests of compatibility with numpy * added better docs and examples * refactored mlx.linalg.norm bindings * reused existing util for implementation of linalg.norm * more tests * fixed a bug with no ord and axis provided * removed unused imports * some style and API consistency updates to linalg norm * remove unused includes * fix python tests * fixed a bug with frobenius norm of a complex-valued matrix * complex for vector too --------- Co-authored-by: Awni Hannun <awni@apple.com> 2023-12-27 11:42:04 +08:00			`norm`
Some fixes in docs (#1141) * fixes in docs * nit 2024-05-21 02:51:47 +08:00			`cholesky`
CPU mx.linalg.cholesky_inverse and mx.linalg.tri_inv (#1307) * add cholesky inv + tri inv * always run tri_inv on cpu * consistent naming 2024-08-09 06:18:02 +08:00			`cholesky_inv`
QR factorization (#310) * add qr factorization --------- Co-authored-by: Awni Hannun <awni@apple.com> 2024-01-27 01:27:31 +08:00			`qr`
Add missing docs for some ops (#1110) 2024-05-14 21:09:05 +08:00			`svd`