Nripesh Niketan
79c859e2e0
* feat: implement `clip_grad_norm` * pre-commit * Add test for clip_grad_norm function in test_optimizers.py * small fixes * fix * lint * Update tree_reduce * Update python/mlx/utils.py Co-authored-by: Awni Hannun <awni.hannun@gmail.com> * Update python/mlx/utils.py Co-authored-by: Awni Hannun <awni.hannun@gmail.com> * Update python/mlx/utils.py Co-authored-by: Awni Hannun <awni.hannun@gmail.com> * Update python/mlx/utils.py Co-authored-by: Awni Hannun <awni.hannun@gmail.com> * Update python/mlx/utils.py Co-authored-by: Awni Hannun <awni.hannun@gmail.com> * Update python/mlx/utils.py Co-authored-by: Awni Hannun <awni.hannun@gmail.com> * Refactor clip_grad_norm function to include documentation and improve readability * format docstring * Add acknowlegements * text wrap * pre-commit * nits in docs --------- Co-authored-by: Awni Hannun <awni.hannun@gmail.com> Co-authored-by: Awni Hannun <awni@apple.com>
Build the Docs
Setup (do once)
Install Doxygen:
brew install doxygen
Install Python packages:
pip install -r requirements.txt
Build
Build the docs from mlx/docs/
doxygen && 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.