You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/book/getting-started/installation.md
+18-27Lines changed: 18 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,51 +9,41 @@ icon: cauldron
9
9
{% step %}
10
10
#### Install ZenML
11
11
12
+
ZenML currently supports **Python 3.9, 3.10, 3.11, and 3.12**. Please make sure that you are using a supported Python version.
13
+
12
14
{% tabs %}
13
-
{% tab title="Direct (pip)" %}
14
-
**ZenML** is a Python package that can be installed directly via `pip`:
15
+
{% tab title="Base package" %}
16
+
**ZenML** is a Python package that can be installed using `pip` or other Python package managers:
15
17
16
18
```shell
17
19
pip install zenml
18
20
```
19
21
20
22
{% hint style="warning" %}
21
-
Note that ZenML currently supports **Python 3.9, 3.10, 3.11, and 3.12**. Please make sure that you are using a supported Python version.
23
+
Installing the base package only allows you to connect to a [deployed ZenML server](./deploying-zenml/). If you want to use ZenML purely locally, install it with the `local` extra:
24
+
```shell
25
+
pip install 'zenml[local]'
26
+
```
22
27
{% endhint %}
23
28
{% endtab %}
24
29
25
-
{% tab title="Dashboard" %}
26
-
ZenML comes bundled with a web dashboard that lives inside a [sister repository](https://github.com/zenml-io/zenml-dashboard). In order to get access to the dashboard **locally**, you need to launch the [ZenML Server and Dashboard locally](deploying-zenml/). For this, you need to install the optional dependencies for the ZenML Server:
30
+
{% tab title="Local Dashboard" %}
31
+
If you want to use the [ZenML dashboard](https://github.com/zenml-io/zenml-dashboard)locally, you need to install ZenML with the `server` extra:
27
32
28
33
```shell
29
-
pip install "zenml[server]"
34
+
pip install 'zenml[server]'
30
35
```
31
36
32
-
{% hint style="info" %}
33
-
We highly encourage you to install ZenML in a virtual environment. At ZenML, we like to use [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/) or [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv) to manage our Python virtual environments.
34
-
{% endhint %}
35
-
{% endtab %}
36
-
37
-
{% tab title="MacOS Silicon (M1, M2)" %}
38
-
A change in how forking works on Macs running on Apple Silicon means that you\
39
-
should set the following environment variable, which will ensure that your connections to the server remain unbroken:
40
-
37
+
{% hint style="warning" %}
38
+
If you want to run a local server while running on a Mac with Apple Silicon (M1, M2, M3, M4), you should set the following environment variable:
41
39
```bash
42
40
export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES
43
-
44
-
pip install zenml
45
41
```
42
+
You can read more about this [here](http://sealiesoftware.com/blog/archive/2017/6/5/Objective-C_and_fork_in_macOS_1013.html).
43
+
{% endhint %}
46
44
47
-
You can read more about this [here](http://sealiesoftware.com/blog/archive/2017/6/5/Objective-C_and_fork_in_macOS_1013.html). This environment variable is needed if you are working with a local server on your Mac, but if you're just using ZenML as a client / CLI and connecting to a deployed server, then you don't need to set it.
48
45
{% endtab %}
49
46
50
-
{% tab title="Nightly Builds" %}
51
-
ZenML also publishes nightly builds under the [`zenml-nightly` package name](https://pypi.org/project/zenml-nightly/). These are built from the latest [`develop` branch](https://github.com/zenml-io/zenml/tree/develop) (to which work ready for release is published) and are not guaranteed to be stable. To install the nightly build, run:
52
-
53
-
```shell
54
-
pip install zenml-nightly
55
-
```
56
-
{% endtab %}
57
47
{% endtabs %}
58
48
{% endstep %}
59
49
@@ -96,11 +86,12 @@ If you would like to run the ZenML server with Docker:
96
86
docker run -it -d -p 8080:8080 zenmldocker/zenml-server
97
87
```
98
88
99
-
## Deploying the server
89
+
## Starting the local server
100
90
101
-
Though ZenML can run entirely as a pip package on a local system, complete with the dashboard. You can do this easily:
91
+
By default, ZenML runs without a server connected to a local database on your machine. If you want to access the dashboard locally, you need to start a local server:
0 commit comments