Enums

zenml.enums

ZenML enums.

Attributes

PLATFORM_EVENT_REGISTRY: dict[SourceType, type[DescribedValuesEnum]] = {SourceType.PIPELINE: PipelineEvent, SourceType.PIPELINE_RUN: PipelineRunEvent} module-attribute

Classes

APITokenType

Bases: StrEnum

The API token type.

AnalyticsEventSource

Bases: StrEnum

Enum to identify analytics events source.

AnnotationTasks

Bases: StrEnum

Supported annotation tasks.

ArtifactSaveType

Bases: StrEnum

All possible method types of how artifact versions can be saved.

ArtifactType

Bases: StrEnum

All possible types an artifact can have.

AuthScheme

Bases: StrEnum

The authentication scheme.

CliCategories

Bases: StrEnum

All possible categories for CLI commands.

Note: The order of the categories is important. The same order is used to sort the commands in the CLI help output.

ColorVariants

Bases: StrEnum

All possible color variants for frontend.

ContainerEngineType

Bases: StrEnum

Container engine types.

ContainerRegistryFlavor

Bases: StrEnum

Flavors of container registries.

CuratedVisualizationSize

Bases: StrEnum

Layout size options for curated visualizations.

DatabaseBackupStrategy

Bases: StrEnum

All available database backup strategies.

DeploymentStatus

Bases: StrEnum

Status of a deployment.

DescribedValuesEnum

Bases: StrEnum

Enum abstraction displaying enum descriptions.

Functions

described_values() -> list[dict[str, str | None]] classmethod

Helper - returns a list of dictionaries describing the enum values.

Returns:

Type	Description
list[dict[str, str | None]]	A list of dictionary objects with descriptions.

Source code in src/zenml/utils/enum_utils.py

@classmethod
def described_values(cls) -> list[dict[str, str | None]]:
    """Helper - returns a list of dictionaries describing the enum values.

    Returns:
        A list of dictionary objects with descriptions.
    """
    idx = cls.value_description_index()

    return [
        {"value": value, "description": idx.get(value)}
        for value in cls.values()
    ]

value_description_index() -> dict[str, str] abstractmethod classmethod

Helper utility to describe enum values.

Returns:

Type	Description
dict[str, str]	An dictionary with descriptions for each enum value.

Source code in src/zenml/utils/enum_utils.py

@classmethod
@abstractmethod
def value_description_index(cls) -> dict[str, str]:
    """Helper utility to describe enum values.

    Returns:
        An dictionary with descriptions for each enum value.
    """
    pass

DownloadType

Bases: StrEnum

All possible types of downloadable content.

EnvironmentType

Bases: StrEnum

Enum for environment types.

ExecutionMode

Bases: StrEnum

Enum that represents the execution mode of a pipeline run.

ExecutionStatus

Bases: StrEnum

Enum that represents the execution status of a step or pipeline run.

Attributes

is_failed: bool property

Whether the execution status refers to a failed execution.

Returns:

Type	Description
bool	Whether the execution status refers to a failed execution.

is_finished: bool property

Returns whether the execution status is in a finished state.

Returns:

Type	Description
bool	Whether the execution status is finished.

is_successful: bool property

Whether the execution status refers to a successful execution.

Returns:

Type	Description
bool	Whether the execution status refers to a successful execution.

GenericFilterOps

Bases: StrEnum

Ops for all filters for string values on list methods.

GroupType

Bases: StrEnum

Enum representing different types of group.

KubernetesServiceType

Bases: StrEnum

Kubernetes Service types for the Kubernetes deployer.

LoggingLevels

Bases: Enum

Enum for logging levels.

LogicalOperators

Bases: StrEnum

Logical Ops to use to combine filters on list methods.

MetadataResourceTypes

Bases: StrEnum

All possible resource types for adding metadata.

ModelStages

Bases: StrEnum

All possible stages of a Model Version.

OAuthDeviceStatus

Bases: StrEnum

The OAuth device status.

OAuthGrantTypes

Bases: StrEnum

The OAuth grant types.

OnboardingStep

Bases: StrEnum

All onboarding steps.

OperatingSystemType

Bases: StrEnum

Enum for OS types.

PipelineEvent

Bases: DescribedValuesEnum

Enum representing platform target events for pipelines.

Functions

value_description_index() -> dict[str, str] classmethod

Helper utility to describe enum values.

Returns:

Type	Description
dict[str, str]	An dictionary with descriptions for each enum value.

Source code in src/zenml/enums.py

@classmethod
def value_description_index(cls) -> dict[str, str]:
    """Helper utility to describe enum values.

    Returns:
        An dictionary with descriptions for each enum value.
    """
    return {
        cls.RUN_COMPLETED: "A pipeline run of the source pipeline has completed successfully.",
        cls.RUN_FAILED: "A pipeline run of the source pipeline has failed.",
    }

PipelineRunEvent

Bases: DescribedValuesEnum

Enum representing platform target events for pipeline runs.

Functions

value_description_index() -> dict[str, str] classmethod

Helper utility to describe enum values.

Returns:

Type	Description
dict[str, str]	An dictionary with descriptions for each enum value.

Source code in src/zenml/enums.py

@classmethod
def value_description_index(cls) -> dict[str, str]:
    """Helper utility to describe enum values.

    Returns:
        An dictionary with descriptions for each enum value.
    """
    return {
        cls.COMPLETED: "Source pipeline run completed successfully.",
        cls.FAILED: "Source pipeline run failed.",
    }

PipelineRunTriggeredByType

Bases: StrEnum

All possible types that can trigger a pipeline run.

ResourceRequestStatus

Bases: StrEnum

Resource request statuses.

ResponseUpdateStrategy

Bases: StrEnum

All available strategies to handle updated properties in the response.

RunWaitConditionLeaseMode

Bases: StrEnum

Supported lease update modes for wait-condition polling.

RunWaitConditionResolution

Bases: StrEnum

Resolution outcomes for resolved wait conditions.

RunWaitConditionStatus

Bases: StrEnum

Lifecycle states for a wait condition.

RunWaitConditionType

Bases: StrEnum

Supported wait condition types.

SecretResourceTypes

Bases: StrEnum

All possible resource types for adding secrets.

SecretValidationLevel

Bases: StrEnum

Secret validation levels.

SecretsStoreType

Bases: StrEnum

Secrets Store Backend Types.

ServerProviderType

Bases: StrEnum

ZenML server providers.

ServiceState

Bases: StrEnum

Possible states for the service and service endpoint.

SorterOps

Bases: StrEnum

Ops for all filters for string values on list methods.

SourceContextTypes

Bases: StrEnum

Enum for event source types.

SourceType

Bases: StrEnum

Enum representing the source type.

StackComponentType

Bases: StrEnum

All possible types a StackComponent can have.

Attributes

plural: str property

Returns the plural of the enum value.

Returns:

Type	Description
str	The plural of the enum value.

supports_multiple_per_stack: bool property

Whether multiple components of this type can exist in one stack.

Returns:

Type	Description
bool	True if this component type is repeatable within a stack.

StackDeploymentProvider

Bases: StrEnum

All possible stack deployment providers.

StepRunInputArtifactType

Bases: StrEnum

All possible types of a step run input artifact.

StepRuntime

Bases: StrEnum

All possible runtime modes for a step.

StepType

Bases: StrEnum

All supported step types.

StoreType

Bases: StrEnum

Zen Store Backend Types.

StrEnum

Bases: str, Enum

Base enum type for string enum values.

Functions

names() -> List[str] classmethod

Get all enum names as a list of strings.

Returns:

Type	Description
List[str]	A list of all enum names.

Source code in src/zenml/utils/enum_utils.py

@classmethod
def names(cls) -> List[str]:
    """Get all enum names as a list of strings.

    Returns:
        A list of all enum names.
    """
    return [c.name for c in cls]

values() -> List[str] classmethod

Get all enum values as a list of strings.

Returns:

Type	Description
List[str]	A list of all enum values.

Source code in src/zenml/utils/enum_utils.py

@classmethod
def values(cls) -> List[str]:
    """Get all enum values as a list of strings.

    Returns:
        A list of all enum values.
    """
    return [c.value for c in cls]

TaggableResourceTypes

Bases: StrEnum

All possible resource types for tagging.

TriggerFlavor

Bases: StrEnum

Enum representing trigger flavors.

TriggerRunConcurrency

Bases: StrEnum

Enum representing trigger run concurrency.

TriggerType

Bases: StrEnum

Enum representing fundamental trigger types.

VisualizationResourceTypes

Bases: StrEnum

Resource types that support curated visualizations.

Curated visualizations can be attached to these ZenML resources to provide contextual dashboards and visual insights throughout the ML lifecycle:

• DEPLOYMENT: Server-side pipeline deployments - surface visualizations on deployment monitoring dashboards and status pages
• MODEL: ZenML model entities - surface model evaluation dashboards and performance summaries directly on the model detail pages
• PIPELINE: Pipeline definitions - associate visualizations with pipeline configurations for reusable visual documentation
• PIPELINE_RUN: Pipeline execution runs - attach visualizations to specific run results for detailed analysis and debugging
• PIPELINE_SNAPSHOT: Pipeline snapshots - link visualizations to captured pipeline configurations for version comparison and historical analysis
• PROJECT: Project-level overviews - provide high-level project dashboards and KPI visualizations for cross-pipeline insights

VisualizationType

Bases: StrEnum

All currently available visualization types.

ZenMLServiceType

Bases: StrEnum

All possible types a service can have.