mlx/docs
Gabrijel Boduljak 6b0d30bb85
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-26 19:42:04 -08:00
..
src linalg.norm (#187) 2023-12-26 19:42:04 -08:00
.clang-format angelos's commit files 2023-11-29 10:42:59 -08:00
.gitignore Docs updates (#198) 2023-12-17 13:20:55 -08:00
.nojekyll jagrit's commit files 2023-11-29 10:52:08 -08:00
index.html jagrit's commit files 2023-11-29 10:52:08 -08:00
Makefile angelos's commit files 2023-11-29 10:42:59 -08:00
README.md Doc theme (#5) 2023-12-05 12:08:05 -08:00

Build the Docs

Setup (do once)

Install sphinx for example with conda:

conda install sphinx
pip install sphinx-book-theme

Build

Build the docs from mlx/docs/

make html

View the docs by running a server in mlx/docs/build/html/:

python -m http.server <port>

and point your browser to http://localhost:<port>.

Push to Github Pages

Check-out the gh-pages branch (git switch gh-pages) and build the docs. Then force add the build/html directory:

git add -f build/html

Commit and push the changes to the gh-pages branch.