Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Small docs fixes #2314

Merged
merged 4 commits into from
Jan 18, 2024
Merged

Small docs fixes #2314

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f36b720
Took out random env:
htahir1 Jan 17, 2024
736fc78
Merge branch 'develop' into doc/smalledit
htahir1 Jan 17, 2024
d271272
Update docs/book/user-guide/advanced-guide/configuring-zenml/environm…
htahir1 Jan 18, 2024
13797c7
Merge branch 'develop' into doc/smalledit
strickvl Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions docs/book/user-guide/advanced-guide/configuring-zenml/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,21 @@ export ZENML_LOGGING_VERBOSITY=INFO

Choose from `INFO`, `WARN`, `ERROR`, `CRITICAL`, `DEBUG`.

## Disable step logs

Usually, ZenML [stores step logs in the artifact store](../pipelining-features/managing-steps.md#enable-or-disable-logs-storing),
but this can sometimes cause performance bottlenecks, especially if the code utilizes
progress bars.

If you want to configure whether logged output from steps is stored or not, set
the `ZENML_DISABLE_STEP_LOGS_STORAGE` environment variable to `true`. Note that
this will mean that logs from your steps will no longer be stored and thus won't
be visible on the dashboard any more.

```bash
export ZENML_DISABLE_STEP_LOGS_STORAGE=false
```

## ZenML repository path

To configure where ZenML will install and look for its repository, set the
Expand All @@ -36,30 +46,30 @@ but the quick summary is that you can set this to `false` if you want to opt out
of analytics.

```bash
export ZENML_ANALYTICS_OPT_IN=true
export ZENML_ANALYTICS_OPT_IN=false
```

## Debug mode

Setting to `true` switches to developer mode:

```bash
ZENML_DEBUG=false
export ZENML_DEBUG=true
```

## Active stack

Setting the `ZENML_ACTIVE_STACK_ID` to a specific UUID will make the
corresponding stack the active stack:
```bash
ZENML_ACTIVE_STACK_ID=<UUID-OF-YOUR-STACK>
export ZENML_ACTIVE_STACK_ID=<UUID-OF-YOUR-STACK>
```

## Prevent pipeline execution

When `true`, this prevents a pipeline from executing:
```bash
ZENML_PREVENT_PIPELINE_EXECUTION=false
export ZENML_PREVENT_PIPELINE_EXECUTION=false
```

## Disable rich traceback
Expand All @@ -68,7 +78,7 @@ Set to `false` to disable the [`rich` traceback](https://rich.readthedocs.io/en/


```bash
ZENML_ENABLE_RICH_TRACEBACK=true
export ZENML_ENABLE_RICH_TRACEBACK=true
```

## ZenML global config path
Expand All @@ -80,19 +90,12 @@ state for a number of settings, set the environment variable as follows:
export ZENML_CONFIG_PATH=/path/to/somewhere
```

## Integration logs

Setting this to `false` disables integrations logs suppression:
```bash
export ZENML_SUPPRESS_LOGS=false
```

## Server configuration

For more information on server configuration, see the [ZenML Server
documentation](../../../deploying-zenml/zenml-self-hosted/deploy-with-docker.md)
For more information on server configuration, see the [ZenML Server documentation](../../../deploying-zenml/zenml-self-hosted/deploy-with-docker.md)
for more, especially the section entitled "ZenML server configuration options".


## Client configuration

Setting the `ZENML_STORE_URL` and `ZENML_STORE_API_KEY` environment
Expand All @@ -107,6 +110,4 @@ export ZENML_STORE_API_KEY=<API_KEY>
```

<!-- For scarf -->
<figure><img alt="ZenML Scarf" referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=f0b4f458-0a54-4fcd-aa95-d5ee424815bc" /></figure>


<figure><img alt="ZenML Scarf" referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=f0b4f458-0a54-4fcd-aa95-d5ee424815bc" /></figure>