mlx/docs
Awni Hannun c4230747a1
redesign for faster cpu/gpu synch (#1869)
* redesign for faster cpu/gpu synch

* load + more async CPU

* use command encoder API and move more ops to use it

* make fence back-end generic + CPU only fence

* faster build

* fix async eval

* fixes + handle temporaries

* fix / improve cpu conv

* remove unused status, fix siblings

* fix extensions

* fix

* fix no cpu build

* format

* comments

* fix perf regression, remove unecessary abort

* fix events, task limit cpu

* fix waiting

* fix donation / temporaries in normalization
2025-03-06 19:23:38 -08:00
..
src redesign for faster cpu/gpu synch (#1869) 2025-03-06 19:23:38 -08:00
.clang-format angelos's commit files 2023-11-29 10:42:59 -08:00
.gitignore Support LR schedulers (#334) 2024-02-15 11:26:20 -08:00
.nojekyll jagrit's commit files 2023-11-29 10:52:08 -08:00
Doxyfile Cpp docs (#1036) 2024-04-26 12:56:05 -07: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 Cpp docs (#1036) 2024-04-26 12:56:05 -07:00
requirements.txt Update requirements.txt (#1291) 2024-07-26 12:59:52 -07:00

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.