Enums

zenml.enums

ArtifactStoreFlavor (StackComponentFlavor)

All supported artifact store flavors.

Source code in zenml/enums.py

class ArtifactStoreFlavor(StackComponentFlavor):
    """All supported artifact store flavors."""

    AZURE = "azure"
    LOCAL = "local"
    GCP = "gcp"
    S3 = "s3"

ContainerRegistryFlavor (StackComponentFlavor)

All supported container registry flavors.

Source code in zenml/enums.py

class ContainerRegistryFlavor(StackComponentFlavor):
    """All supported container registry flavors."""

    DEFAULT = "default"

ExecutionStatus (StrEnum)

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

Source code in zenml/enums.py

class ExecutionStatus(StrEnum):
    """Enum that represents the current status of a step or pipeline run."""

    FAILED = "failed"
    COMPLETED = "completed"
    RUNNING = "running"
    CACHED = "cached"

LoggingLevels (Enum)

Enum for logging levels.

Source code in zenml/enums.py

class LoggingLevels(Enum):
    """Enum for logging levels."""

    NOTSET = logging.NOTSET
    ERROR = logging.ERROR
    WARN = logging.WARN
    INFO = logging.INFO
    DEBUG = logging.DEBUG
    CRITICAL = logging.CRITICAL

MetadataContextTypes (Enum)

All possible types that contexts can have within pipeline nodes

Source code in zenml/enums.py

class MetadataContextTypes(Enum):
    """All possible types that contexts can have within pipeline nodes"""

    STACK = "stack"
    PIPELINE_REQUIREMENTS = "pipeline_requirements"

MetadataStoreFlavor (StackComponentFlavor)

All supported metadata store flavors.

Source code in zenml/enums.py

class MetadataStoreFlavor(StackComponentFlavor):
    """All supported metadata store flavors."""

    SQLITE = "sqlite"
    MYSQL = "mysql"
    KUBEFLOW = "kubeflow"

OrchestratorFlavor (StackComponentFlavor)

All supported orchestrator flavors.

Source code in zenml/enums.py

class OrchestratorFlavor(StackComponentFlavor):
    """All supported orchestrator flavors."""

    LOCAL = "local"
    KUBEFLOW = "kubeflow"
    AIRFLOW = "airflow"
    VERTEX = "vertex"

SecretSchemaType (StrEnum)

All supported secret schema types.

Source code in zenml/enums.py

class SecretSchemaType(StrEnum):
    """All supported secret schema types."""

    AWS = "aws"
    ARBITRARY = "arbitrary"

SecretsManagerFlavor (StackComponentFlavor)

All supported orchestrator flavors.

Source code in zenml/enums.py

class SecretsManagerFlavor(StackComponentFlavor):
    """All supported orchestrator flavors."""

    LOCAL = "local"
    LOCAL_SQLITE = "local_sqlite"
    AWS = "aws"

StackComponentFlavor (StrEnum)

Abstract base class for all stack component flavors.

Source code in zenml/enums.py

class StackComponentFlavor(StrEnum):
    """Abstract base class for all stack component flavors."""

    @staticmethod
    def for_type(
        component_type: StackComponentType,
    ) -> Type["StackComponentFlavor"]:
        """Get the corresponding flavor child-type for a component type."""
        if component_type == StackComponentType.ARTIFACT_STORE:
            return ArtifactStoreFlavor
        elif component_type == StackComponentType.METADATA_STORE:
            return MetadataStoreFlavor
        elif component_type == StackComponentType.CONTAINER_REGISTRY:
            return ContainerRegistryFlavor
        elif component_type == StackComponentType.ORCHESTRATOR:
            return OrchestratorFlavor
        elif component_type == StackComponentType.STEP_OPERATOR:
            return StepOperatorFlavor
        elif component_type == StackComponentType.SECRETS_MANAGER:
            return SecretsManagerFlavor
        else:
            raise ValueError(
                f"Unsupported Stack Component Type {component_type.value}"
            )

StackComponentType (StrEnum)

All possible types a StackComponent can have.

Source code in zenml/enums.py

class StackComponentType(StrEnum):
    """All possible types a `StackComponent` can have."""

    ORCHESTRATOR = "orchestrator"
    METADATA_STORE = "metadata_store"
    ARTIFACT_STORE = "artifact_store"
    CONTAINER_REGISTRY = "container_registry"
    STEP_OPERATOR = "step_operator"
    SECRETS_MANAGER = "secrets_manager"

    @property
    def plural(self) -> str:
        """Returns the plural of the enum value."""
        if self == StackComponentType.CONTAINER_REGISTRY:
            return "container_registries"

        return f"{self.value}s"

StepOperatorFlavor (StackComponentFlavor)

All supported step operator flavors.

Source code in zenml/enums.py

class StepOperatorFlavor(StackComponentFlavor):
    """All supported step operator flavors."""

    AZUREML = "azureml"
    SAGEMAKER = "sagemaker"
    VERTEX = "vertex"

StoreType (StrEnum)

Repository Store Backend Types

Source code in zenml/enums.py

class StoreType(StrEnum):
    """Repository Store Backend Types"""

    LOCAL = "local"
    SQL = "sql"
    REST = "rest"