-
Notifications
You must be signed in to change notification settings - Fork 420
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add installation instructions for Macs running on Apple Silicon #2774
Conversation
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. I personally would probably not read the docs before installing/trying, so I have an additional suggestion:
When someone is running zenml up
, we could detect that they're on macos and then check whether this environment variable is set, and if not warn them?
Or maybe point them towards a page to read up on the environment variable? At least when I read it initially, I remember reading that setting this can have some negative effect as well, might be worth also linking in the docs. (Quite old info though, haven't done any recent research). If it's unproblematic, we could even set it ourselves when spinning up a server
Also think its great to have this here, but it should be a warning in the code as well in case we don't have that yet. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🦭
…o/zenml into doc/add-env-var-mac-connectivity
Not sure if it was too much to just error out of the process, but it felt better than just to emit a warning message... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🦭
Adds information on installation for Mac users running on M1 / M2 systems (i.e. Apple Silicon). (Also adds a note about Windows support to FAQ).