* readme wip

* more readme

* examples

* spell

* comments + nits
This commit is contained in:
Awni Hannun
2023-11-29 16:23:42 -08:00
committed by GitHub
parent adb992a780
commit d1926c4752
4 changed files with 80 additions and 31 deletions

View File

@@ -9,7 +9,7 @@ MLX with your own Apple silicon computer is
.. code-block:: shell
pip install apple-mlx -i https://pypi.apple.com/simple
pip install mlx
Build from source
-----------------
@@ -46,6 +46,17 @@ Then simply build and install it using pip:
env CMAKE_BUILD_PARALLEL_LEVEL="" pip install .
For developing use an editable install:
.. code-block:: shell
env CMAKE_BUILD_PARALLEL_LEVEL="" pip install -e .
To make sure the install is working run the tests with:
.. code-block:: shell
python -m unittest discover python/tests
C++ API
^^^^^^^

View File

@@ -13,7 +13,7 @@ The main differences between MLX and NumPy are:
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 suppoorted devices (CPU,
- **Multi-device**: Operations can run on any of the supported devices (CPU,
GPU, ...)
The design of MLX is strongly inspired by frameworks like `PyTorch