mirror of
https://github.com/ml-explore/mlx.git
synced 2025-07-22 09:31:14 +08:00
deee214a95
* initial commit with workong optmimizer * update ACKNOWLEDGMENTS.md * nits and adding it to test * nits * G.astype(mx.bfloat16) to G.astype(G.dtype) * G.ndim >= 2 to assert G.ndim == 2 * remove coments * replace with mx.addmm * remove comments * format * nits * match muon * fix addmm --------- Co-authored-by: Awni Hannun <awni@apple.com> |
||
|---|---|---|
| .. | ||
| src | ||
| .clang-format | ||
| .gitignore | ||
| .nojekyll | ||
| Doxyfile | ||
| index.html | ||
| Makefile | ||
| README.md | ||
| requirements.txt | ||
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.