Skip to content

Commit 3646195

Browse files
committed
Docs
1 parent aafac74 commit 3646195

File tree

5 files changed

+21
-34
lines changed

5 files changed

+21
-34
lines changed

docs/book/getting-started/hello-world.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This guide will help you build and deploy your first ZenML pipeline, starting lo
1616
Start by installing ZenML in a fresh Python environment:
1717

1818
```bash
19-
pip install zenml
19+
pip install 'zenml[server]'
2020
zenml login
2121
```
2222

docs/book/getting-started/installation.md

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,51 +9,41 @@ icon: cauldron
99
{% step %}
1010
#### Install ZenML
1111

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+
1214
{% 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:
1517

1618
```shell
1719
pip install zenml
1820
```
1921

2022
{% 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+
```
2227
{% endhint %}
2328
{% endtab %}
2429

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:
2732

2833
```shell
29-
pip install "zenml[server]"
34+
pip install 'zenml[server]'
3035
```
3136

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:
4139
```bash
4240
export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES
43-
44-
pip install zenml
4541
```
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 %}
4644

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.
4845
{% endtab %}
4946

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 %}
5747
{% endtabs %}
5848
{% endstep %}
5949

@@ -96,11 +86,12 @@ If you would like to run the ZenML server with Docker:
9686
docker run -it -d -p 8080:8080 zenmldocker/zenml-server
9787
```
9888

99-
## Deploying the server
89+
## Starting the local server
10090

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:
10292

10393
```shell
94+
# Make sure to have the `server` extra installed
10495
pip install "zenml[server]"
10596
zenml login --local # opens the dashboard locally
10697
```

docs/book/user-guide/best-practices/project-templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Do you have a personal project powered by ZenML that you would like to see here?
2020
First, to use the templates, you need to have ZenML and its `templates` extras installed:
2121

2222
```bash
23-
pip install zenml[templates]
23+
pip install 'zenml[templates]'
2424
```
2525

2626
{% hint style="warning" %}

src/zenml/cli/__init__.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@
1313
# permissions and limitations under the License.
1414
"""ZenML CLI.
1515
16-
The ZenML CLI tool is usually downloaded and installed via PyPI and a
17-
``pip install zenml`` command. Please see the Installation & Setup
18-
section above for more information about that process.
19-
2016
How to use the CLI
2117
------------------
2218

src/zenml/cli/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ def init(
167167
except ImportError:
168168
error(
169169
"You need to install the ZenML project template requirements "
170-
"to use templates. Please run `pip install zenml[templates]` "
170+
"to use templates. Please run `pip install 'zenml[templates]'` "
171171
"and try again."
172172
)
173173
return

0 commit comments

Comments
 (0)