mirror of
https://github.com/ml-explore/mlx.git
synced 2025-08-31 20:14:36 +08:00
37fc9db82c
* Added adafactor * Added Adafactor and ran pre-commit * modified operations * Added docstrings * Switched two ops to fix a bug * added underscore for internal functions and removed the plus sign in the last return statment * Removed parameter rms from the optimizer state because its not needed * Added simple MNIST test for Adafactor and temporary training log * remove test files * nits in docs * comment nit --------- Co-authored-by: Awni Hannun <awni@apple.com>
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.