🐞Debug and solve issues

A guide to debug common issues and get help.

If you stumbled upon this page, chances are you're facing issues with using ZenML. This page documents suggestions and best practices to let you debug, get help, and solve issues quickly.

When to get help?

We suggest going through the following checklist before asking for help:

Search on Slack using the built-in Slack search function at the top of the page.

Search on GitHub issues.

Search the docs using the search bar in the top right corner of the page.

Check out the common errors section below.

Understand the problem by studying the additional logs and client/server logs.

Chances are you'd find your answers there. If you can't find any clue, then it's time to post your question on Slack.

How to post on Slack?

When posting on Slack it's useful to provide the following information (when applicable) so that we get a complete picture before jumping into solutions.

1. System Information

Let us know relevant information about your system. We recommend running the following in your terminal and attaching the output to your question.

zenml info -a -s

You can optionally include information about specific packages where you're having problems by using the -p option. For example, if you're having problems with the tensorflow package, you can run:

zenml info -p tensorflow

The output should look something like this:

ZENML_LOCAL_VERSION: 0.40.2

ZENML_SERVER_VERSION: 0.40.2

ZENML_SERVER_DATABASE: mysql

ZENML_SERVER_DEPLOYMENT_TYPE: alpha

ZENML_CONFIG_DIR: /Users/my_username/Library/Application Support/zenml

ZENML_LOCAL_STORE_DIR: /Users/my_username/Library/Application Support/zenml/local_stores

ZENML_SERVER_URL: https://someserver.zenml.io

ZENML_ACTIVE_REPOSITORY_ROOT: /Users/my_username/coding/zenml/repos/zenml

PYTHON_VERSION: 3.9.13

ENVIRONMENT: native

SYSTEM_INFO: {'os': 'mac', 'mac_version': '13.2'}

ACTIVE_WORKSPACE: default

ACTIVE_STACK: default

ACTIVE_USER: some_user