mlx/docs
Awni Hannun 4ba0c24a8f
Export / import functions to / from a file (#1642)
* export and import functions

* refactor + works for few primitives

* nit

* allow primitives with state

* nit

* nit

* simplify serialize / deserialize

* fix for constants

* python bindings

* maybe fix serialize failure case

* add example

* more primitives, training kind of works

* same result for python and c++

* some fixes

* fix export

* template it up

* some simplificatoin

* rebase

* allow kwargs and multiple functions

* exporter

* more primitives for exporting

* deal with endianness

* handle invalid stream

* add docstring
2024-12-24 11:19:13 -08:00
..
src Export / import functions to / from a file (#1642) 2024-12-24 11:19:13 -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.