mlx/docs
Nripesh Niketan e09bf35b28
feat: Add Dropout3d layer to nn.layers (#313)
* feat: Add Dropout3d layer to nn.layers

* acknowledgement

* Add dropout tests to test_nn.py

* run pre-commit

* Add activation functions and dropout3d ops

* Add dropout tests for bfloat16 and float16
2023-12-31 14:01:21 -08:00
..
src feat: Add Dropout3d layer to nn.layers (#313) 2023-12-31 14:01:21 -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.