zenml-nightly 0.62.0.dev20240729__py3-none-any.whl → 0.63.0.dev20240731__py3-none-any.whl

zenml/enums.py

@@ -338,6 +338,9 @@ class TaggableResourceTypes(StrEnum):
     ARTIFACT_VERSION = "artifact_version"
     MODEL = "model"
     MODEL_VERSION = "model_version"
+    PIPELINE = "pipeline"
+    PIPELINE_RUN = "pipeline_run"
+    RUN_TEMPLATE = "run_template"
 
 
 class ResponseUpdateStrategy(StrEnum):

zenml/integrations/aws/orchestrators/sagemaker_orchestrator.py

@@ -20,6 +20,7 @@ from uuid import UUID
 
 import boto3
 import sagemaker
+from botocore.exceptions import WaiterError
 from sagemaker.network import NetworkConfig
 from sagemaker.processing import ProcessingInput, ProcessingOutput
 from sagemaker.workflow.execution_variables import ExecutionVariables
@@ -373,10 +374,18 @@ class SagemakerOrchestrator(ContainerizedOrchestrator):
             logger.info(
                 "Executing synchronously. Waiting for pipeline to finish..."
             )
-            pipeline_execution.wait(
-                delay=POLLING_DELAY, max_attempts=MAX_POLLING_ATTEMPTS
-            )
-            logger.info("Pipeline completed successfully.")
+            try:
+                pipeline_execution.wait(
+                    delay=POLLING_DELAY, max_attempts=MAX_POLLING_ATTEMPTS
+                )
+                logger.info("Pipeline completed successfully.")
+            except WaiterError:
+                raise RuntimeError(
+                    "Timed out while waiting for pipeline execution to finish. For long-running "
+                    "pipelines we recommend configuring your orchestrator for asynchronous execution. "
+                    "The following command does this for you: \n"
+                    f"`zenml orchestrator update {self.name} --synchronous=False`"
+                )
 
     def _get_region_name(self) -> str:
         """Returns the AWS region name.

zenml/integrations/databricks/flavors/databricks_orchestrator_flavor.py

@@ -20,6 +20,7 @@ from zenml.integrations.databricks import DATABRICKS_ORCHESTRATOR_FLAVOR
 from zenml.logger import get_logger
 from zenml.orchestrators import BaseOrchestratorConfig
 from zenml.orchestrators.base_orchestrator import BaseOrchestratorFlavor
+from zenml.utils.enum_utils import StrEnum
 from zenml.utils.secret_utils import SecretField
 
 if TYPE_CHECKING:
@@ -27,10 +28,17 @@ if TYPE_CHECKING:
         DatabricksOrchestrator,
     )
 
-
 logger = get_logger(__name__)
 
 
+class DatabricksAvailabilityType(StrEnum):
+    """Databricks availability type."""
+
+    ON_DEMAND = "ON_DEMAND"
+    SPOT = "SPOT"
+    SPOT_WITH_FALLBACK = "SPOT_WITH_FALLBACK"
+
+
 class DatabricksOrchestratorSettings(BaseSettings):
     """Databricks orchestrator base settings.
 
@@ -53,11 +61,12 @@ class DatabricksOrchestratorSettings(BaseSettings):
     node_type_id: Optional[str] = None
     policy_id: Optional[str] = None
     autotermination_minutes: Optional[int] = None
-    autoscale: Tuple[int, int] = (2, 3)
+    autoscale: Tuple[int, int] = (0, 1)
     single_user_name: Optional[str] = None
     spark_conf: Optional[Dict[str, str]] = None
     spark_env_vars: Optional[Dict[str, str]] = None
     schedule_timezone: Optional[str] = None
+    availability_type: Optional[DatabricksAvailabilityType] = None
 
 
 class DatabricksOrchestratorConfig(

zenml/integrations/databricks/orchestrators/databricks_orchestrator.py

@@ -52,6 +52,7 @@ from zenml.orchestrators.utils import get_orchestrator_run_name
 from zenml.orchestrators.wheeled_orchestrator import WheeledOrchestrator
 from zenml.stack import StackValidator
 from zenml.utils import io_utils
+from zenml.utils.package_utils import clean_requirements
 from zenml.utils.pipeline_docker_image_builder import (
     PipelineDockerImageBuilder,
 )
@@ -229,6 +230,9 @@ class DatabricksOrchestrator(WheeledOrchestrator):
             ValueError: If the schedule is not set or if the cron expression
                 is not set.
         """
+        settings = cast(
+            DatabricksOrchestratorSettings, self.get_settings(deployment)
+        )
         if deployment.schedule:
             if (
                 deployment.schedule.catchup
@@ -246,7 +250,7 @@ class DatabricksOrchestrator(WheeledOrchestrator):
                 )
             if (
                 deployment.schedule.cron_expression
-                and self.settings_class().schedule_timezone is None
+                and settings.schedule_timezone is None
             ):
                 raise ValueError(
                     "Property `schedule_timezone` must be set when passing "
@@ -321,7 +325,7 @@ class DatabricksOrchestrator(WheeledOrchestrator):
                     f"{deployment_id}_{step_name}",
                     ZENML_STEP_DEFAULT_ENTRYPOINT_COMMAND,
                     arguments,
-                    requirements,
+                    clean_requirements(requirements),
                     depends_on=upstream_steps,
                     zenml_project_wheel=zenml_project_wheel,
                     job_cluster_key=job_cluster_key,
@@ -366,7 +370,7 @@ class DatabricksOrchestrator(WheeledOrchestrator):
 
         # Construct the env variables for the pipeline
         env_vars = environment.copy()
-        spark_env_vars = self.settings_class().spark_env_vars
+        spark_env_vars = settings.spark_env_vars
         if spark_env_vars:
             for key, value in spark_env_vars.items():
                 env_vars[key] = value
@@ -385,6 +389,7 @@ class DatabricksOrchestrator(WheeledOrchestrator):
         job_cluster_key = self.sanitize_name(f"{deployment_id}")
         self._upload_and_run_pipeline(
             pipeline_name=orchestrator_run_name,
+            settings=settings,
             tasks=_construct_databricks_pipeline(
                 databricks_wheel_path, job_cluster_key
             ),
@@ -396,6 +401,7 @@ class DatabricksOrchestrator(WheeledOrchestrator):
     def _upload_and_run_pipeline(
         self,
         pipeline_name: str,
+        settings: DatabricksOrchestratorSettings,
         tasks: List[DatabricksTask],
         env_vars: Dict[str, str],
         job_cluster_key: str,
@@ -409,6 +415,7 @@ class DatabricksOrchestrator(WheeledOrchestrator):
             env_vars: The environment variables.
             job_cluster_key: The ID of the Databricks job cluster.
             schedule: The schedule to run the pipeline
+            settings: The settings for the Databricks orchestrator.
 
         Raises:
             ValueError: If the `Job Compute` policy is not found.
@@ -416,12 +423,12 @@ class DatabricksOrchestrator(WheeledOrchestrator):
 
         """
         databricks_client = self._get_databricks_client()
-        spark_conf = self.settings_class().spark_conf or {}
+        spark_conf = settings.spark_conf or {}
         spark_conf[
             "spark.databricks.driver.dbfsLibraryInstallationAllowed"
         ] = "true"
 
-        policy_id = self.settings_class().policy_id or None
+        policy_id = settings.policy_id or None
         for policy in databricks_client.cluster_policies.list():
             if policy.name == "Job Compute":
                 policy_id = policy.policy_id
@@ -432,17 +439,16 @@ class DatabricksOrchestrator(WheeledOrchestrator):
         job_cluster = JobCluster(
             job_cluster_key=job_cluster_key,
             new_cluster=ClusterSpec(
-                spark_version=self.settings_class().spark_version
+                spark_version=settings.spark_version
                 or DATABRICKS_SPARK_DEFAULT_VERSION,
-                num_workers=self.settings_class().num_workers,
-                node_type_id=self.settings_class().node_type_id
-                or "Standard_D4s_v5",
+                num_workers=settings.num_workers,
+                node_type_id=settings.node_type_id or "Standard_D4s_v5",
                 policy_id=policy_id,
                 autoscale=AutoScale(
-                    min_workers=self.settings_class().autoscale[0],
-                    max_workers=self.settings_class().autoscale[1],
+                    min_workers=settings.autoscale[0],
+                    max_workers=settings.autoscale[1],
                 ),
-                single_user_name=self.settings_class().single_user_name,
+                single_user_name=settings.single_user_name,
                 spark_env_vars=env_vars,
                 spark_conf=spark_conf,
                 workload_type=WorkloadType(
@@ -451,7 +457,7 @@ class DatabricksOrchestrator(WheeledOrchestrator):
             ),
         )
         if schedule and schedule.cron_expression:
-            schedule_timezone = self.settings_class().schedule_timezone
+            schedule_timezone = settings.schedule_timezone
             if schedule_timezone:
                 databricks_schedule = CronSchedule(
                     quartz_cron_expression=schedule.cron_expression,

zenml/models/__init__.py

@@ -199,12 +199,7 @@ from zenml.models.v2.core.pipeline import (
     PipelineResponse,
     PipelineResponseBody,
     PipelineResponseMetadata,
-)
-from zenml.models.v2.core.pipeline_namespace import (
-    PipelineNamespaceResponseBody,
-    PipelineNamespaceResponseMetadata,
-    PipelineNamespaceResponse,
-    PipelineNamespaceFilter,
+    PipelineResponseResources
 )
 from zenml.models.v2.core.pipeline_build import (
     PipelineBuildBase,
@@ -230,6 +225,16 @@ from zenml.models.v2.core.pipeline_run import (
     PipelineRunResponse,
     PipelineRunResponseBody,
     PipelineRunResponseMetadata,
+    PipelineRunResponseResources
+)
+from zenml.models.v2.core.run_template import (
+    RunTemplateRequest,
+    RunTemplateUpdate,
+    RunTemplateResponse,
+    RunTemplateResponseBody,
+    RunTemplateResponseMetadata,
+    RunTemplateResponseResources,
+    RunTemplateFilter,
 )
 from zenml.models.v2.base.base_plugin_flavor import BasePluginFlavorResponse
 from zenml.models.v2.core.run_metadata import (
@@ -424,6 +429,7 @@ ModelVersionPipelineRunResponseBody.model_rebuild()
 OAuthDeviceResponseBody.model_rebuild()
 PipelineResponseBody.model_rebuild()
 PipelineResponseMetadata.model_rebuild()
+PipelineResponseResources.model_rebuild()
 PipelineBuildBase.model_rebuild()
 PipelineBuildResponseBody.model_rebuild()
 PipelineBuildResponseMetadata.model_rebuild()
@@ -433,6 +439,11 @@ PipelineDeploymentResponseMetadata.model_rebuild()
 PipelineDeploymentResponseResources.model_rebuild()
 PipelineRunResponseBody.model_rebuild()
 PipelineRunResponseMetadata.model_rebuild()
+PipelineRunResponseResources.model_rebuild()
+RunTemplateResponseBody.model_rebuild()
+RunTemplateResponseMetadata.model_rebuild()
+RunTemplateResponseResources.model_rebuild()
+RunTemplateResponseBody.model_rebuild()
 RunMetadataResponseBody.model_rebuild()
 RunMetadataResponseMetadata.model_rebuild()
 ScheduleResponseBody.model_rebuild()
@@ -590,10 +601,7 @@ __all__ = [
     "PipelineResponse",
     "PipelineResponseBody",
     "PipelineResponseMetadata",
-    "PipelineNamespaceFilter",
-    "PipelineNamespaceResponse",
-    "PipelineNamespaceResponseBody",
-    "PipelineNamespaceResponseMetadata",
+    "PipelineResponseResources",
     "PipelineBuildBase",
     "PipelineBuildRequest",
     "PipelineBuildFilter",
@@ -612,6 +620,14 @@ __all__ = [
     "PipelineRunResponse",
     "PipelineRunResponseBody",
     "PipelineRunResponseMetadata",
+    "PipelineRunResponseResources",
+    "RunTemplateRequest",
+    "RunTemplateUpdate",
+    "RunTemplateResponse",
+    "RunTemplateResponseBody",
+    "RunTemplateResponseMetadata",
+    "RunTemplateResponseResources",
+    "RunTemplateFilter",
     "RunMetadataRequest",
     "RunMetadataFilter",
     "RunMetadataResponse",

zenml/models/v2/base/filter.py

@@ -36,6 +36,7 @@ from pydantic import (
     field_validator,
     model_validator,
 )
+from sqlalchemy import asc, desc
 from sqlmodel import SQLModel
 
 from zenml.constants import (
@@ -267,6 +268,7 @@ class BaseFilter(BaseModel):
         "size",
         "logical_operator",
     ]
+    CUSTOM_SORTING_OPTIONS: ClassVar[List[str]] = []
 
     # List of fields that are not even mentioned as options in the CLI.
     CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = []
@@ -352,6 +354,8 @@ class BaseFilter(BaseModel):
             )
         elif column in cls.model_fields:
             return value
+        elif column in cls.CUSTOM_SORTING_OPTIONS:
+            return value
         else:
             raise ValueError(
                 "You can only sort by valid fields of this resource"
@@ -861,3 +865,31 @@ class BaseFilter(BaseModel):
             query = query.where(filters)
 
         return query
+
+    def apply_sorting(
+        self,
+        query: AnyQuery,
+        table: Type["AnySchema"],
+    ) -> AnyQuery:
+        """Apply sorting to the query.
+
+        Args:
+            query: The query to which to apply the sorting.
+            table: The query table.
+
+        Returns:
+            The query with sorting applied.
+        """
+        column, operand = self.sorting_params
+
+        if operand == SorterOps.DESCENDING:
+            sort_clause = desc(getattr(table, column))  # type: ignore[var-annotated]
+        else:
+            sort_clause = asc(getattr(table, column))
+
+        # We always add the `id` column as a tiebreaker to ensure a stable,
+        # repeatable order of items, otherwise subsequent pages might contain
+        # the same items.
+        query = query.order_by(sort_clause, asc(table.id))  # type: ignore[arg-type]
+
+        return query

zenml/models/v2/core/pipeline.py

@@ -13,27 +13,35 @@
 #  permissions and limitations under the License.
 """Models representing pipelines."""
 
-from typing import TYPE_CHECKING, Any, List, Optional, Union
+from typing import TYPE_CHECKING, Any, List, Optional, Type, TypeVar, Union
 from uuid import UUID
 
 from pydantic import Field
 
-from zenml.config.pipeline_spec import PipelineSpec
-from zenml.constants import STR_FIELD_MAX_LENGTH, TEXT_FIELD_MAX_LENGTH
+from zenml.constants import (
+    SORT_PIPELINES_BY_LATEST_RUN_KEY,
+    STR_FIELD_MAX_LENGTH,
+    TEXT_FIELD_MAX_LENGTH,
+)
 from zenml.enums import ExecutionStatus
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedFilter,
     WorkspaceScopedRequest,
     WorkspaceScopedResponse,
     WorkspaceScopedResponseBody,
     WorkspaceScopedResponseMetadata,
     WorkspaceScopedResponseResources,
+    WorkspaceScopedTaggableFilter,
 )
+from zenml.models.v2.core.tag import TagResponse
 
 if TYPE_CHECKING:
     from zenml.models.v2.core.pipeline_run import PipelineRunResponse
+    from zenml.zen_stores.schemas import BaseSchema
+
+    AnySchema = TypeVar("AnySchema", bound=BaseSchema)
 
+AnyQuery = TypeVar("AnyQuery", bound=Any)
 
 # ------------------ Request Model ------------------
 
@@ -45,20 +53,15 @@ class PipelineRequest(WorkspaceScopedRequest):
         title="The name of the pipeline.",
         max_length=STR_FIELD_MAX_LENGTH,
     )
-    version: str = Field(
-        title="The version of the pipeline.",
-        max_length=STR_FIELD_MAX_LENGTH,
-    )
-    version_hash: str = Field(
-        title="The version hash of the pipeline.",
-        max_length=STR_FIELD_MAX_LENGTH,
-    )
-    docstring: Optional[str] = Field(
-        title="The docstring of the pipeline.",
+    description: Optional[str] = Field(
+        default=None,
+        title="The description of the pipeline.",
         max_length=TEXT_FIELD_MAX_LENGTH,
+    )
+    tags: Optional[List[str]] = Field(
         default=None,
+        title="Tags of the pipeline.",
     )
-    spec: PipelineSpec = Field(title="The spec of the pipeline.")
 
 
 # ------------------ Update Model ------------------
@@ -67,29 +70,16 @@ class PipelineRequest(WorkspaceScopedRequest):
 class PipelineUpdate(BaseUpdate):
     """Update model for pipelines."""
 
-    name: Optional[str] = Field(
-        title="The name of the pipeline.",
-        max_length=STR_FIELD_MAX_LENGTH,
-        default=None,
-    )
-    version: Optional[str] = Field(
-        title="The version of the pipeline.",
-        max_length=STR_FIELD_MAX_LENGTH,
+    description: Optional[str] = Field(
         default=None,
-    )
-    version_hash: Optional[str] = Field(
-        title="The version hash of the pipeline.",
-        max_length=STR_FIELD_MAX_LENGTH,
-        default=None,
-    )
-    docstring: Optional[str] = Field(
-        title="The docstring of the pipeline.",
+        title="The description of the pipeline.",
         max_length=TEXT_FIELD_MAX_LENGTH,
-        default=None,
     )
-    spec: Optional[PipelineSpec] = Field(
-        title="The spec of the pipeline.",
-        default=None,
+    add_tags: Optional[List[str]] = Field(
+        default=None, title="New tags to add to the pipeline."
+    )
+    remove_tags: Optional[List[str]] = Field(
+        default=None, title="Tags to remove from the pipeline."
     )
 
 
@@ -99,33 +89,32 @@ class PipelineUpdate(BaseUpdate):
 class PipelineResponseBody(WorkspaceScopedResponseBody):
     """Response body for pipelines."""
 
-    status: Optional[List[ExecutionStatus]] = Field(
-        default=None, title="The status of the last 3 Pipeline Runs."
+    latest_run_id: Optional[UUID] = Field(
+        default=None,
+        title="The ID of the latest run of the pipeline.",
     )
-    version: str = Field(
-        title="The version of the pipeline.",
-        max_length=STR_FIELD_MAX_LENGTH,
+    latest_run_status: Optional[ExecutionStatus] = Field(
+        default=None,
+        title="The status of the latest run of the pipeline.",
     )
 
 
 class PipelineResponseMetadata(WorkspaceScopedResponseMetadata):
     """Response metadata for pipelines."""
 
-    version_hash: str = Field(
-        title="The version hash of the pipeline.",
-        max_length=STR_FIELD_MAX_LENGTH,
-    )
-    spec: PipelineSpec = Field(title="The spec of the pipeline.")
-    docstring: Optional[str] = Field(
-        title="The docstring of the pipeline.",
-        max_length=TEXT_FIELD_MAX_LENGTH,
+    description: Optional[str] = Field(
         default=None,
+        title="The description of the pipeline.",
     )
 
 
 class PipelineResponseResources(WorkspaceScopedResponseResources):
     """Class for all resource models associated with the pipeline entity."""
 
+    tags: List[TagResponse] = Field(
+        title="Tags associated with the pipeline.",
+    )
+
 
 class PipelineResponse(
     WorkspaceScopedResponse[
@@ -224,75 +213,46 @@ class PipelineResponse(
             )
         return runs[0]
 
-    # Body and metadata properties
-    @property
-    def status(self) -> Optional[List[ExecutionStatus]]:
-        """The `status` property.
-
-        Returns:
-            the value of the property.
-        """
-        return self.get_body().status
-
-    @property
-    def version(self) -> str:
-        """The `version` property.
-
-        Returns:
-            the value of the property.
-        """
-        return self.get_body().version
-
     @property
-    def spec(self) -> PipelineSpec:
-        """The `spec` property.
+    def latest_run_id(self) -> Optional[UUID]:
+        """The `latest_run_id` property.
 
         Returns:
             the value of the property.
         """
-        return self.get_metadata().spec
+        return self.get_body().latest_run_id
 
     @property
-    def version_hash(self) -> str:
-        """The `version_hash` property.
+    def latest_run_status(self) -> Optional[ExecutionStatus]:
+        """The `latest_run_status` property.
 
         Returns:
             the value of the property.
         """
-        return self.get_metadata().version_hash
+        return self.get_body().latest_run_status
 
     @property
-    def docstring(self) -> Optional[str]:
-        """The `docstring` property.
+    def tags(self) -> List[TagResponse]:
+        """The `tags` property.
 
         Returns:
             the value of the property.
         """
-        return self.get_metadata().docstring
+        return self.get_resources().tags
 
 
 # ------------------ Filter Model ------------------
 
 
-class PipelineFilter(WorkspaceScopedFilter):
+class PipelineFilter(WorkspaceScopedTaggableFilter):
     """Pipeline filter model."""
 
+    CUSTOM_SORTING_OPTIONS = [SORT_PIPELINES_BY_LATEST_RUN_KEY]
+
     name: Optional[str] = Field(
         default=None,
         description="Name of the Pipeline",
     )
-    version: Optional[str] = Field(
-        default=None,
-        description="Version of the Pipeline",
-    )
-    version_hash: Optional[str] = Field(
-        default=None,
-        description="Version hash of the Pipeline",
-    )
-    docstring: Optional[str] = Field(
-        default=None,
-        description="Docstring of the Pipeline",
-    )
     workspace_id: Optional[Union[UUID, str]] = Field(
         default=None,
         description="Workspace of the Pipeline",
@@ -303,3 +263,27 @@ class PipelineFilter(WorkspaceScopedFilter):
         description="User of the Pipeline",
         union_mode="left_to_right",
     )
+
+    def apply_sorting(
+        self,
+        query: AnyQuery,
+        table: Type["AnySchema"],
+    ) -> AnyQuery:
+        """Apply sorting to the query.
+
+        Args:
+            query: The query to which to apply the sorting.
+            table: The query table.
+
+        Returns:
+            The query with sorting applied.
+        """
+        column, _ = self.sorting_params
+
+        if column == SORT_PIPELINES_BY_LATEST_RUN_KEY:
+            # If sorting by the latest run, the sorting is already done in the
+            # base query in `SqlZenStore.list_pipelines(...)` and we don't need
+            # to to anything here
+            return query
+        else:
+            return super().apply_sorting(query=query, table=table)

zenml/models/v2/core/pipeline_build.py

@@ -157,6 +157,9 @@ class PipelineBuildRequest(PipelineBuildBase, WorkspaceScopedRequest):
     """Request model for pipelines builds."""
 
     checksum: Optional[str] = Field(title="The build checksum.", default=None)
+    stack_checksum: Optional[str] = Field(
+        title="The stack checksum.", default=None
+    )
 
     stack: Optional[UUID] = Field(
         title="The stack that was used for this build.", default=None
@@ -164,7 +167,6 @@ class PipelineBuildRequest(PipelineBuildBase, WorkspaceScopedRequest):
     pipeline: Optional[UUID] = Field(
         title="The pipeline that was used for this build.", default=None
     )
-    template_deployment_id: Optional[UUID] = None
 
 
 # ------------------ Update Model ------------------
@@ -196,6 +198,9 @@ class PipelineBuildResponseMetadata(WorkspaceScopedResponseMetadata):
         default=None, title="The Python version used for this build."
     )
     checksum: Optional[str] = Field(default=None, title="The build checksum.")
+    stack_checksum: Optional[str] = Field(
+        default=None, title="The stack checksum."
+    )
     is_local: bool = Field(
         title="Whether the build images are stored in a container "
         "registry or locally.",
@@ -203,7 +208,6 @@ class PipelineBuildResponseMetadata(WorkspaceScopedResponseMetadata):
     contains_code: bool = Field(
         title="Whether any image of the build contains user code.",
     )
-    template_deployment_id: Optional[UUID] = None
 
 
 class PipelineBuildResponseResources(WorkspaceScopedResponseResources):
@@ -409,31 +413,31 @@ class PipelineBuildResponse(
         return self.get_metadata().checksum
 
     @property
-    def is_local(self) -> bool:
-        """The `is_local` property.
+    def stack_checksum(self) -> Optional[str]:
+        """The `stack_checksum` property.
 
         Returns:
             the value of the property.
         """
-        return self.get_metadata().is_local
+        return self.get_metadata().stack_checksum
 
     @property
-    def contains_code(self) -> bool:
-        """The `contains_code` property.
+    def is_local(self) -> bool:
+        """The `is_local` property.
 
         Returns:
             the value of the property.
         """
-        return self.get_metadata().contains_code
+        return self.get_metadata().is_local
 
     @property
-    def template_deployment_id(self) -> Optional[UUID]:
-        """The `template_deployment_id` property.
+    def contains_code(self) -> bool:
+        """The `contains_code` property.
 
         Returns:
             the value of the property.
         """
-        return self.get_metadata().template_deployment_id
+        return self.get_metadata().contains_code
 
 
 # ------------------ Filter Model ------------------