mlx/docs
Enoch Kan 0b28399638
added mse_loss, nll_loss and kl_div_loss (#98)
* added mse_loss, nll_loss and kl_div_loss

* fixed axis not defined error in nll_loss

* fixed axis not defined in kl_div_loss

* added tests for mse, nll and kl_div

* modified docstrings and added reduce helper func

* updated docstring in kl_div_loss and moved helper func

* added new kl divergence implementation

* added reduction to test

* updated docstring of kl_div_loss with correct spelling

* added losses to nn.rst in docs
2023-12-09 14:25:03 -08:00
..
src added mse_loss, nll_loss and kl_div_loss (#98) 2023-12-09 14:25:03 -08:00
.clang-format angelos's commit files 2023-11-29 10:42:59 -08:00
.gitignore awni's commit files 2023-11-29 10:30:41 -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.