diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index 5b5e9de51..63c9d0e41 100644 --- a/docs/build/html/.buildinfo +++ b/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: 101437d3a6497705badb11e599f96b45 +config: 177bbfa0562989b62a154f2dd1ab02a1 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/install.rst b/docs/build/html/_sources/install.rst index b82b2838c..682f09f38 100644 --- a/docs/build/html/_sources/install.rst +++ b/docs/build/html/_sources/install.rst @@ -11,10 +11,34 @@ silicon computer is pip install mlx +To install from PyPI you must meet the following requirements: + +- Using an M series chip (Apple silicon) +- Using a native Python >= 3.8 +- MacOS >= 13.3 + .. note:: MLX is only available on devices running MacOS >= 13.3 It is highly recommended to use MacOS 14 (Sonoma) +Troubleshooting +^^^^^^^^^^^^^^^ + +*My OS and Python versions are in the required range but pip still does not find +a matching distribution.* + +Probably you are using a non-native Python. The output of + +.. code-block:: shell + + python -c "import platform; print(platform.processor())" + +should be ``arm``. If it is ``i386`` (and you have M series machine) then you +are using a non-native Python. Switch your Python to a native Python. A good +way to do this is with +`Conda `_. + + Build from source ----------------- @@ -61,6 +85,7 @@ To make sure the install is working run the tests with: .. code-block:: shell + pip install ".[testing]" python -m unittest discover python/tests C++ API diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js index 9012603b7..f8f4859e3 100644 --- a/docs/build/html/_static/documentation_options.js +++ b/docs/build/html/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.0.3', + VERSION: '0.0.4', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/build/html/cpp/ops.html b/docs/build/html/cpp/ops.html index 4d97b7a65..2167066d3 100644 --- a/docs/build/html/cpp/ops.html +++ b/docs/build/html/cpp/ops.html @@ -9,7 +9,7 @@ - Operations — MLX 0.0.3 documentation + Operations — MLX 0.0.4 documentation @@ -134,8 +134,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/dev/extensions.html b/docs/build/html/dev/extensions.html index cb3a13b80..9a47ae5f3 100644 --- a/docs/build/html/dev/extensions.html +++ b/docs/build/html/dev/extensions.html @@ -9,7 +9,7 @@ - Developer Documentation — MLX 0.0.3 documentation + Developer Documentation — MLX 0.0.4 documentation @@ -133,8 +133,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/examples/linear_regression.html b/docs/build/html/examples/linear_regression.html index 932db4c26..a096950bf 100644 --- a/docs/build/html/examples/linear_regression.html +++ b/docs/build/html/examples/linear_regression.html @@ -9,7 +9,7 @@ - Linear Regression — MLX 0.0.3 documentation + Linear Regression — MLX 0.0.4 documentation @@ -134,8 +134,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/examples/llama-inference.html b/docs/build/html/examples/llama-inference.html index aada78d30..6658e6034 100644 --- a/docs/build/html/examples/llama-inference.html +++ b/docs/build/html/examples/llama-inference.html @@ -9,7 +9,7 @@ - LLM inference — MLX 0.0.3 documentation + LLM inference — MLX 0.0.4 documentation @@ -134,8 +134,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/examples/mlp.html b/docs/build/html/examples/mlp.html index 7bf055a43..5ab1e11f8 100644 --- a/docs/build/html/examples/mlp.html +++ b/docs/build/html/examples/mlp.html @@ -9,7 +9,7 @@ - Multi-Layer Perceptron — MLX 0.0.3 documentation + Multi-Layer Perceptron — MLX 0.0.4 documentation @@ -134,8 +134,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index bd40f287d..4332ef3da 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -8,7 +8,7 @@ - Index — MLX 0.0.3 documentation + Index — MLX 0.0.4 documentation @@ -131,8 +131,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/index.html b/docs/build/html/index.html index ef7b2e990..c5927c04e 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -9,7 +9,7 @@ - MLX — MLX 0.0.3 documentation + MLX — MLX 0.0.4 documentation @@ -133,8 +133,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + diff --git a/docs/build/html/install.html b/docs/build/html/install.html index 45ed70943..f630b7de6 100644 --- a/docs/build/html/install.html +++ b/docs/build/html/install.html @@ -9,7 +9,7 @@ - Build and Install — MLX 0.0.3 documentation + Build and Install — MLX 0.0.4 documentation @@ -134,8 +134,8 @@ - MLX 0.0.3 documentation - Home - + MLX 0.0.4 documentation - Home + @@ -536,7 +536,10 @@ document.write(`