[DOCS] TVM install addenda for M1 Macs #8568
Conversation
AndrewZhaoLuo
requested review from
areusch,
comaniac,
jroesch,
junrushao,
merrymercy,
tqchen and
yzhliu
as code owners
|
cc @hogepodge |
docs/install/from_source.rst
Outdated
| @@ -73,6 +73,16 @@ linux operating systems, execute (in a terminal): | |||
| sudo apt-get update | |||
| sudo apt-get install -y python3 python3-dev python3-setuptools gcc libtinfo-dev zlib1g-dev build-essential cmake libedit-dev libxml2-dev | |||
|
|
|||
| On macOS, whether using an Intel or M1 Mac we can use homebrew. Make sure to follow the post installation steps for each of the below commaands. | |||
There was a problem hiding this comment.
I would go so far as to say "only Homebrew installations have been tested."
docs/install/from_source.rst
Outdated
| @@ -73,6 +73,16 @@ linux operating systems, execute (in a terminal): | |||
| sudo apt-get update | |||
| sudo apt-get install -y python3 python3-dev python3-setuptools gcc libtinfo-dev zlib1g-dev build-essential cmake libedit-dev libxml2-dev | |||
|
|
|||
| On macOS, whether using an Intel or M1 Mac we can use homebrew. Make sure to follow the post installation steps for each of the below commaands. | |||
| Furthermore, avoid using python 3.9.X+ which is not supported at the time of this writing. With this, you should have the ability to compile a | |||
There was a problem hiding this comment.
is there a link to a bug stating the problem?
There was a problem hiding this comment.
Looking this issue up online, it seems like support was added earlier this year, so information is conflicting.
There was a problem hiding this comment.
Eh there definitely are still issues however since 3.9 changed the python IR which TVM apparently manipulates in some parts.
There was a problem hiding this comment.
Huh, if it's a general problem, we should state that as part of the overall requirements. I don't mind having that be part of this patch, and if there is more information we need to file an issue against TVM.
There was a problem hiding this comment.
Yep, I personally don't have enough background to make a good issue. But maybe others do @areusch @tkonolige
There was a problem hiding this comment.
#8577 <-- made a dummy issue to link against in the meantime. Made some changes to the wording to make it a general requirement
|
@areusch @hogepodge PTAL |
docs/install/from_source.rst
Outdated
| @@ -293,6 +303,17 @@ like ``virtualenv``. | |||
|
|
|||
| pip3 install --user tornado psutil xgboost cloudpickle | |||
|
|
|||
| Note on M1 macs, you may have trouble installing xgboost / scipy. A workaround for this is to do the following commands: | |||
There was a problem hiding this comment.
I like to explain why there might be an issue. For example, it looks like OPENBLAS needs to be installed and configured. Stating that helps future readers and contributors understand what the problem is, and possibly update the instructions if the issue is resolved. So, for example:
"scipy and xgboost requires some additional dependencies to be installed, including openblas and its dependencies. Use the following commands to install scipy and xgboost with the required dependencies and configuration."
docs/install/from_source.rst
Outdated
| @@ -73,6 +74,15 @@ linux operating systems, execute (in a terminal): | |||
| sudo apt-get update | |||
| sudo apt-get install -y python3 python3-dev python3-setuptools gcc libtinfo-dev zlib1g-dev build-essential cmake libedit-dev libxml2-dev | |||
|
|
|||
| On macOS, whether using an Intel or M1 Mac, we support using homebrew. Make sure to follow the post installation steps for each of the below commaands. | |||
There was a problem hiding this comment.
sp: commaands
Suggested edit:
"Use Homebrew to install the required dependencies for macOS running either the Intel or M1 processors. You must follow the post-installation steps specified by Homebrew to ensure the dependencies are correctly installed and configured."
|
Hey guys, how is everything with this PR? If it looks good, let's https://tvm.apache.org/docs/contribute/code_review.html#approve-and-request-changes-explicitly |
|
It should be good. @hogepodge @areusch ? |
* instructiosn for m1 mac * typos * above to below * nits, link against python issue on github * correct link * more cleanup * correct source * address chrishoge suggestions Co-authored-by: Andrew Zhao Luo <andrewzhaoluo@system76-pc.localdomain>
* instructiosn for m1 mac * typos * above to below * nits, link against python issue on github * correct link * more cleanup * correct source * address chrishoge suggestions Co-authored-by: Andrew Zhao Luo <andrewzhaoluo@system76-pc.localdomain>
Testing:
Ran
restviewon the doc and made sure it looked ok-ish.Tested this on a sort-of-fresh M1 mac and can confirm these instructions work.