From 026ef9aae4ba33743e34bff554529a2b6ff7ab54 Mon Sep 17 00:00:00 2001 From: Chris Costes Date: Sun, 7 Jan 2024 22:11:04 -0500 Subject: [PATCH] Update Install Instructions (#397) * Add note to install instructions for building from source to ensure native arm64 environment and tools. * Add troubleshooting info. * remove cmake bits --------- Co-authored-by: Awni Hannun --- docs/src/install.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/src/install.rst b/docs/src/install.rst index 92669ab6e..1883329fb 100644 --- a/docs/src/install.rst +++ b/docs/src/install.rst @@ -48,6 +48,9 @@ Build Requirements - `cmake `_ -- version 3.24 or later, and ``make`` - Xcode >= 14.3 (Xcode >= 15.0 for macOS 14 and above) +.. note:: + Ensure your shell environment is native ``arm``, not ``x86`` via Rosetta. If + the output of ``uname -p`` is ``x86``, see the :ref:`troubleshooting section ` below. Python API ^^^^^^^^^^ @@ -169,6 +172,7 @@ should point to the path to the built metal library. Troubleshooting ^^^^^^^^^^^^^^^ + Metal not found ~~~~~~~~~~~~~~~ @@ -189,3 +193,23 @@ Then set the active developer directory: .. code-block:: shell sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer + +x86 Shell +~~~~~~~~~ + +.. _build shell: + +If the ouptut of ``uname -p`` is ``x86`` then your shell is running as x86 via +Rosetta instead of natively. + +To fix this, find the application in Finder (``/Applications`` for iTerm, +``/Applications/Utilities`` for Terminal), right-click, and click “Get Info”. +Uncheck “Open using Rosetta”, close the “Get Info” window, and restart your +terminal. + +Verify the terminal is now running natively the following command: + +.. code-block:: shell + + $ uname -p + arm