mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-25 01:41:17 +08:00
![]() * 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 |
||
---|---|---|
.. | ||
src | ||
.clang-format | ||
.gitignore | ||
.nojekyll | ||
index.html | ||
Makefile | ||
README.md |
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.