mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-24 17:31:16 +08:00
Install docs + python versions (#53)
* install + python versions * add link in install docs * add link
This commit is contained in:
parent
43e336cff2
commit
dfbc52ce56
@ -11,10 +11,34 @@ silicon computer is
|
|||||||
|
|
||||||
pip install mlx
|
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::
|
.. note::
|
||||||
MLX is only available on devices running MacOS >= 13.3
|
MLX is only available on devices running MacOS >= 13.3
|
||||||
It is highly recommended to use MacOS 14 (Sonoma)
|
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 <https://stackoverflow.com/questions/65415996/how-to-specify-the-architecture-or-platform-for-a-new-conda-environment-apple>`_.
|
||||||
|
|
||||||
|
|
||||||
Build from source
|
Build from source
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
@ -60,6 +84,7 @@ For developing use an editable install:
|
|||||||
To make sure the install is working run the tests with:
|
To make sure the install is working run the tests with:
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
|
|
||||||
pip install ".[testing]"
|
pip install ".[testing]"
|
||||||
python -m unittest discover python/tests
|
python -m unittest discover python/tests
|
||||||
|
|
||||||
|
@ -14,5 +14,5 @@ if __name__ == "__main__":
|
|||||||
package_dir={"": "."},
|
package_dir={"": "."},
|
||||||
package_data={"mlx_sample_extensions": ["*.so", "*.dylib", "*.metallib"]},
|
package_data={"mlx_sample_extensions": ["*.so", "*.dylib", "*.metallib"]},
|
||||||
zip_safe=False,
|
zip_safe=False,
|
||||||
python_requires=">=3.7",
|
python_requires=">=3.8",
|
||||||
)
|
)
|
||||||
|
2
setup.py
2
setup.py
@ -149,5 +149,5 @@ if __name__ == "__main__":
|
|||||||
ext_modules=[CMakeExtension("mlx.core")],
|
ext_modules=[CMakeExtension("mlx.core")],
|
||||||
cmdclass={"build_ext": CMakeBuild},
|
cmdclass={"build_ext": CMakeBuild},
|
||||||
zip_safe=False,
|
zip_safe=False,
|
||||||
python_requires=">=3.7",
|
python_requires=">=3.8",
|
||||||
)
|
)
|
||||||
|
Loading…
Reference in New Issue
Block a user