mlx/docs
Luca Arnaboldi fffe072028
Implementation of mlx.random.multivariate_normal (#502) (#877)
* Implementation of mlx.random.multivariate_normal (#502)

* Update python/src/random.cpp

Co-authored-by: Awni Hannun <awni.hannun@gmail.com>

* Update python/src/random.cpp

Co-authored-by: Awni Hannun <awni.hannun@gmail.com>

* Update python/src/random.cpp

Co-authored-by: Awni Hannun <awni.hannun@gmail.com>

* Updated typo in docstring

* Restricted multivariate_normal to  float32

* Generic mean and variance shapes

* Review edits

* Update mlx/random.cpp

Co-authored-by: Awni Hannun <awni.hannun@gmail.com>

* Update python/src/random.cpp

Co-authored-by: Awni Hannun <awni.hannun@gmail.com>

* Update python/src/random.cpp

Co-authored-by: Awni Hannun <awni.hannun@gmail.com>

* Update python/src/random.cpp

Co-authored-by: Awni Hannun <awni.hannun@gmail.com>

* Test for ndim of mean and cov

* nits

* smaller size for test

* fix broadcasted sampling

---------

Co-authored-by: Awni Hannun <awni.hannun@gmail.com>
Co-authored-by: Awni Hannun <awni@apple.com>
2024-04-09 13:50:12 -07:00
..
src Implementation of mlx.random.multivariate_normal (#502) (#877) 2024-04-09 13:50:12 -07:00
.clang-format angelos's commit files 2023-11-29 10:42:59 -08:00
.gitignore Support LR schedulers (#334) 2024-02-15 11:26:20 -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 Spelling (#342) 2024-01-01 21:08:17 -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.