docs

docs/build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 5b1e2769941ea186df86318a9fdcef20
+config: ca5399f2afd200078e823a6122fcf759
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/index.rst

@@ -0,0 +1,73 @@
+MLX
+===
+
+MLX is a NumPy-like array framework designed for efficient and flexible
+machine learning on Apple silicon.
+
+The Python API closely follows NumPy with a few exceptions. MLX also has a
+fully featured C++ API which closely follows the Python API.
+
+The main differences between MLX and NumPy are:
+
+ - **Composable function transformations**: MLX has composable function
+   transformations for automatic differentiation, automatic vectorization,
+   and computation graph optimization.
+ - **Lazy computation**: Computations in MLX are lazy. Arrays are only
+   materialized when needed.
+ - **Multi-device**: Operations can run on any of the supported devices (CPU,
+   GPU, ...)
+
+The design of MLX is strongly inspired by frameworks like `PyTorch
+<https://pytorch.org/>`_, `Jax <https://github.com/google/jax>`_, and
+`ArrayFire <https://arrayfire.org/>`_. A noteable difference from these
+frameworks and MLX is the *unified memory model*. Arrays in MLX live in shared
+memory. Operations on MLX arrays can be performed on any of the supported
+device types without performing data copies. Currently supported device types
+are the CPU and GPU.
+
+.. toctree::
+   :caption: Install
+   :maxdepth: 1
+
+   install
+
+.. toctree::
+   :caption: Usage 
+   :maxdepth: 1
+
+   quick_start
+   using_streams
+
+.. toctree::
+   :caption: Examples
+   :maxdepth: 1
+
+   examples/linear_regression
+   examples/mlp
+   examples/llama-inference
+
+.. toctree::
+   :caption: Python API Reference
+   :maxdepth: 1
+
+   python/array
+   python/devices_and_streams
+   python/ops
+   python/random
+   python/transforms
+   python/fft
+   python/nn
+   python/optimizers
+   python/tree_utils
+
+.. toctree::
+   :caption: C++ API Reference
+   :maxdepth: 1
+
+   cpp/ops
+
+.. toctree::
+   :caption: Further Reading
+   :maxdepth: 1
+
+   dev/extensions

docs/build/html/_sources/index.rst.txt

@@ -1,49 +0,0 @@
-MLX
-===
-
-.. toctree::
-   :caption: Install
-   :maxdepth: 1
-
-   install
-
-.. toctree::
-   :caption: Usage 
-   :maxdepth: 1
-
-   quick_start
-   using_streams
-
-.. toctree::
-   :caption: Examples
-   :maxdepth: 1
-
-   examples/linear_regression
-   examples/mlp
-   examples/llama-inference
-
-.. toctree::
-   :caption: Python API Reference
-   :maxdepth: 1
-
-   python/array
-   python/devices_and_streams
-   python/ops
-   python/random
-   python/transforms
-   python/fft
-   python/nn
-   python/optimizers
-   python/tree_utils
-
-.. toctree::
-   :caption: C++ API Reference
-   :maxdepth: 1
-
-   cpp/ops
-
-.. toctree::
-   :caption: Further Reading
-   :maxdepth: 1
-
-   dev/extensions