This commit is contained in:
Awni Hannun
2023-12-06 08:13:20 -08:00
committed by CircleCI Docs
parent 901a4ba68a
commit e4d33acace
209 changed files with 664 additions and 621 deletions

View File

@@ -11,6 +11,10 @@ silicon computer is
pip install mlx
.. note::
MLX is only available on devices running MacOS >= 13.3
It is highly recommended to use MacOS 14 (Sonoma)
Build from source
-----------------
@@ -19,6 +23,7 @@ Build Requirements
- A C++ compiler with C++17 support (e.g. Clang >= 5.0)
- `cmake <https://cmake.org/>`_ -- version 3.24 or later, and ``make``
- Xcode >= 14.3 (Xcode >= 15.0 for MacOS 14 and above)
Python API
@@ -111,3 +116,21 @@ should point to the path to the built metal library.
- ON
* - MLX_BUILD_PYTHON_BINDINGS
- OFF
.. note::
If you have multiple Xcode installations and wish to use
a specific one while building, you can do so by adding the
following environment variable before building
.. code-block:: shell
export DEVELOPER_DIR="/path/to/Xcode.app/Contents/Developer/"
Further, you can use the following command to find out which
MacOS SDK will be used
.. code-block:: shell
xcrun -sdk macosx --show-sdk-version