From dfbc52ce56a5589fe6a17b52ae74af82906411f4 Mon Sep 17 00:00:00 2001 From: Awni Hannun Date: Thu, 7 Dec 2023 07:29:17 -0800 Subject: [PATCH] Install docs + python versions (#53) * install + python versions * add link in install docs * add link --- docs/src/install.rst | 25 +++++++++++++++++++++++++ examples/extensions/setup.py | 2 +- setup.py | 2 +- 3 files changed, 27 insertions(+), 2 deletions(-) diff --git a/docs/src/install.rst b/docs/src/install.rst index 2b61a84ff..682f09f38 100644 --- a/docs/src/install.rst +++ b/docs/src/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 ----------------- @@ -60,6 +84,7 @@ For developing use an editable install: To make sure the install is working run the tests with: .. code-block:: shell + pip install ".[testing]" python -m unittest discover python/tests diff --git a/examples/extensions/setup.py b/examples/extensions/setup.py index a9ceb39d4..74e59cb9a 100644 --- a/examples/extensions/setup.py +++ b/examples/extensions/setup.py @@ -14,5 +14,5 @@ if __name__ == "__main__": package_dir={"": "."}, package_data={"mlx_sample_extensions": ["*.so", "*.dylib", "*.metallib"]}, zip_safe=False, - python_requires=">=3.7", + python_requires=">=3.8", ) diff --git a/setup.py b/setup.py index 1809ba5c6..c459acc89 100644 --- a/setup.py +++ b/setup.py @@ -149,5 +149,5 @@ if __name__ == "__main__": ext_modules=[CMakeExtension("mlx.core")], cmdclass={"build_ext": CMakeBuild}, zip_safe=False, - python_requires=">=3.7", + python_requires=">=3.8", )