zenml-nightly 0.68.1.dev20241106__py3-none-any.whl → 0.70.0.dev20241116__py3-none-any.whl

zenml/models/v2/core/artifact_version.py

@@ -34,7 +34,7 @@ from pydantic import (
 
 from zenml.config.source import Source, SourceWithValidator
 from zenml.constants import STR_FIELD_MAX_LENGTH, TEXT_FIELD_MAX_LENGTH
-from zenml.enums import ArtifactType, GenericFilterOps
+from zenml.enums import ArtifactSaveType, ArtifactType, GenericFilterOps
 from zenml.logger import get_logger
 from zenml.metadata.metadata_types import MetadataType
 from zenml.models.v2.base.filter import StrFilter
@@ -57,9 +57,6 @@ if TYPE_CHECKING:
         ArtifactVisualizationResponse,
     )
     from zenml.models.v2.core.pipeline_run import PipelineRunResponse
-    from zenml.models.v2.core.run_metadata import (
-        RunMetadataResponse,
-    )
     from zenml.models.v2.core.step_run import StepRunResponse
 
 logger = get_logger(__name__)
@@ -107,6 +104,9 @@ class ArtifactVersionRequest(WorkspaceScopedRequest):
     visualizations: Optional[List["ArtifactVisualizationRequest"]] = Field(
         default=None, title="Visualizations of the artifact."
     )
+    save_type: ArtifactSaveType = Field(
+        title="The save type of the artifact version.",
+    )
     metadata: Optional[Dict[str, MetadataType]] = Field(
         default=None, title="Metadata of the artifact version."
     )
@@ -193,6 +193,9 @@ class ArtifactVersionResponseBody(WorkspaceScopedResponseBody):
         title="The ID of the pipeline run that generated this artifact version.",
         default=None,
     )
+    save_type: ArtifactSaveType = Field(
+        title="The save type of the artifact version.",
+    )
     artifact_store_id: Optional[UUID] = Field(
         title="ID of the artifact store in which this artifact is stored.",
         default=None,
@@ -230,7 +233,7 @@ class ArtifactVersionResponseMetadata(WorkspaceScopedResponseMetadata):
     visualizations: Optional[List["ArtifactVisualizationResponse"]] = Field(
         default=None, title="Visualizations of the artifact."
     )
-    run_metadata: Dict[str, "RunMetadataResponse"] = Field(
+    run_metadata: Dict[str, MetadataType] = Field(
         default={}, title="Metadata of the artifact."
     )
 
@@ -313,6 +316,15 @@ class ArtifactVersionResponse(
         """
         return self.get_body().producer_pipeline_run_id
 
+    @property
+    def save_type(self) -> ArtifactSaveType:
+        """The `save_type` property.
+
+        Returns:
+            the value of the property.
+        """
+        return self.get_body().save_type
+
     @property
     def artifact_store_id(self) -> Optional[UUID]:
         """The `artifact_store_id` property.
@@ -343,7 +355,7 @@ class ArtifactVersionResponse(
         return self.get_metadata().visualizations
 
     @property
-    def run_metadata(self) -> Dict[str, "RunMetadataResponse"]:
+    def run_metadata(self) -> Dict[str, MetadataType]:
         """The `metadata` property.
 
         Returns:
@@ -462,6 +474,7 @@ class ArtifactVersionFilter(WorkspaceScopedTaggableFilter):
         "user",
         "model",
         "pipeline_run",
+        "run_metadata",
     ]
     artifact_id: Optional[Union[UUID, str]] = Field(
         default=None,
@@ -533,6 +546,10 @@ class ArtifactVersionFilter(WorkspaceScopedTaggableFilter):
         description="Name/ID of a pipeline run that is associated with this "
         "artifact version.",
     )
+    run_metadata: Optional[Dict[str, str]] = Field(
+        default=None,
+        description="The run_metadata to filter the artifact versions by.",
+    )
 
     model_config = ConfigDict(protected_namespaces=())
 
@@ -552,6 +569,7 @@ class ArtifactVersionFilter(WorkspaceScopedTaggableFilter):
             ModelSchema,
             ModelVersionArtifactSchema,
             PipelineRunSchema,
+            RunMetadataSchema,
             StepRunInputArtifactSchema,
             StepRunOutputArtifactSchema,
             StepRunSchema,
@@ -633,6 +651,23 @@ class ArtifactVersionFilter(WorkspaceScopedTaggableFilter):
             )
             custom_filters.append(pipeline_run_filter)
 
+        if self.run_metadata is not None:
+            from zenml.enums import MetadataResourceTypes
+
+            for key, value in self.run_metadata.items():
+                additional_filter = and_(
+                    RunMetadataSchema.resource_id == ArtifactVersionSchema.id,
+                    RunMetadataSchema.resource_type
+                    == MetadataResourceTypes.ARTIFACT_VERSION,
+                    RunMetadataSchema.key == key,
+                    self.generate_custom_query_conditions_for_column(
+                        value=value,
+                        table=RunMetadataSchema,
+                        column="value",
+                    ),
+                )
+                custom_filters.append(additional_filter)
+
         return custom_filters
 
 
@@ -671,7 +706,7 @@ class LazyArtifactVersionResponse(ArtifactVersionResponse):
         )
 
     @property
-    def run_metadata(self) -> Dict[str, "RunMetadataResponse"]:
+    def run_metadata(self) -> Dict[str, MetadataType]:
         """The `metadata` property in lazy loading mode.
 
         Returns:

zenml/models/v2/core/model_version.py

@@ -29,6 +29,7 @@ from pydantic import BaseModel, ConfigDict, Field, PrivateAttr, field_validator
 
 from zenml.constants import STR_FIELD_MAX_LENGTH, TEXT_FIELD_MAX_LENGTH
 from zenml.enums import ModelStages
+from zenml.metadata.metadata_types import MetadataType
 from zenml.models.v2.base.filter import AnyQuery
 from zenml.models.v2.base.page import Page
 from zenml.models.v2.base.scoped import (
@@ -49,9 +50,6 @@ if TYPE_CHECKING:
     from zenml.models.v2.core.artifact_version import ArtifactVersionResponse
     from zenml.models.v2.core.model import ModelResponse
     from zenml.models.v2.core.pipeline_run import PipelineRunResponse
-    from zenml.models.v2.core.run_metadata import (
-        RunMetadataResponse,
-    )
     from zenml.zen_stores.schemas import BaseSchema
 
     AnySchema = TypeVar("AnySchema", bound=BaseSchema)
@@ -193,7 +191,7 @@ class ModelVersionResponseMetadata(WorkspaceScopedResponseMetadata):
         max_length=TEXT_FIELD_MAX_LENGTH,
         default=None,
     )
-    run_metadata: Dict[str, "RunMetadataResponse"] = Field(
+    run_metadata: Dict[str, MetadataType] = Field(
         description="Metadata linked to the model version",
         default={},
     )
@@ -304,7 +302,7 @@ class ModelVersionResponse(
         return self.get_metadata().description
 
     @property
-    def run_metadata(self) -> Optional[Dict[str, "RunMetadataResponse"]]:
+    def run_metadata(self) -> Dict[str, MetadataType]:
         """The `run_metadata` property.
 
         Returns:
@@ -592,6 +590,7 @@ class ModelVersionFilter(WorkspaceScopedTaggableFilter):
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
         *WorkspaceScopedTaggableFilter.FILTER_EXCLUDE_FIELDS,
         "user",
+        "run_metadata",
     ]
 
     name: Optional[str] = Field(
@@ -621,6 +620,10 @@ class ModelVersionFilter(WorkspaceScopedTaggableFilter):
         default=None,
         description="Name/ID of the user that created the model version.",
     )
+    run_metadata: Optional[Dict[str, str]] = Field(
+        default=None,
+        description="The run_metadata to filter the model versions by.",
+    )
 
     _model_id: UUID = PrivateAttr(None)
 
@@ -653,6 +656,7 @@ class ModelVersionFilter(WorkspaceScopedTaggableFilter):
 
         from zenml.zen_stores.schemas import (
             ModelVersionSchema,
+            RunMetadataSchema,
             UserSchema,
         )
 
@@ -667,6 +671,23 @@ class ModelVersionFilter(WorkspaceScopedTaggableFilter):
             )
             custom_filters.append(user_filter)
 
+        if self.run_metadata is not None:
+            from zenml.enums import MetadataResourceTypes
+
+            for key, value in self.run_metadata.items():
+                additional_filter = and_(
+                    RunMetadataSchema.resource_id == ModelVersionSchema.id,
+                    RunMetadataSchema.resource_type
+                    == MetadataResourceTypes.MODEL_VERSION,
+                    RunMetadataSchema.key == key,
+                    self.generate_custom_query_conditions_for_column(
+                        value=value,
+                        table=RunMetadataSchema,
+                        column="value",
+                    ),
+                )
+                custom_filters.append(additional_filter)
+
         return custom_filters
 
     def apply_filter(

zenml/models/v2/core/pipeline_run.py

@@ -30,6 +30,7 @@ from pydantic import BaseModel, ConfigDict, Field
 from zenml.config.pipeline_configurations import PipelineConfiguration
 from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.enums import ExecutionStatus
+from zenml.metadata.metadata_types import MetadataType
 from zenml.models.v2.base.scoped import (
     WorkspaceScopedRequest,
     WorkspaceScopedResponse,
@@ -51,9 +52,6 @@ if TYPE_CHECKING:
     from zenml.models.v2.core.pipeline_build import (
         PipelineBuildResponse,
     )
-    from zenml.models.v2.core.run_metadata import (
-        RunMetadataResponse,
-    )
     from zenml.models.v2.core.schedule import ScheduleResponse
     from zenml.models.v2.core.stack import StackResponse
     from zenml.models.v2.core.step_run import StepRunResponse
@@ -190,7 +188,7 @@ class PipelineRunResponseBody(WorkspaceScopedResponseBody):
 class PipelineRunResponseMetadata(WorkspaceScopedResponseMetadata):
     """Response metadata for pipeline runs."""
 
-    run_metadata: Dict[str, "RunMetadataResponse"] = Field(
+    run_metadata: Dict[str, MetadataType] = Field(
         default={},
         title="Metadata associated with this pipeline run.",
     )
@@ -450,7 +448,7 @@ class PipelineRunResponse(
         return self.get_body().model_version_id
 
     @property
-    def run_metadata(self) -> Dict[str, "RunMetadataResponse"]:
+    def run_metadata(self) -> Dict[str, MetadataType]:
         """The `run_metadata` property.
 
         Returns:
@@ -589,6 +587,7 @@ class PipelineRunFilter(WorkspaceScopedTaggableFilter):
         "stack_component",
         "pipeline_name",
         "templatable",
+        "run_metadata",
     ]
     name: Optional[str] = Field(
         default=None,
@@ -667,6 +666,10 @@ class PipelineRunFilter(WorkspaceScopedTaggableFilter):
         default=None,
         description="Name/ID of the user that created the run.",
     )
+    run_metadata: Optional[Dict[str, str]] = Field(
+        default=None,
+        description="The run_metadata to filter the pipeline runs by.",
+    )
     # TODO: Remove once frontend is ready for it. This is replaced by the more
     # generic `pipeline` filter below.
     pipeline_name: Optional[str] = Field(
@@ -696,7 +699,6 @@ class PipelineRunFilter(WorkspaceScopedTaggableFilter):
     templatable: Optional[bool] = Field(
         default=None, description="Whether the run is templatable."
     )
-
     model_config = ConfigDict(protected_namespaces=())
 
     def get_custom_filters(
@@ -720,6 +722,7 @@ class PipelineRunFilter(WorkspaceScopedTaggableFilter):
             PipelineDeploymentSchema,
             PipelineRunSchema,
             PipelineSchema,
+            RunMetadataSchema,
             ScheduleSchema,
             StackComponentSchema,
             StackCompositionSchema,
@@ -889,5 +892,21 @@ class PipelineRunFilter(WorkspaceScopedTaggableFilter):
                 )
 
             custom_filters.append(templatable_filter)
+        if self.run_metadata is not None:
+            from zenml.enums import MetadataResourceTypes
+
+            for key, value in self.run_metadata.items():
+                additional_filter = and_(
+                    RunMetadataSchema.resource_id == PipelineRunSchema.id,
+                    RunMetadataSchema.resource_type
+                    == MetadataResourceTypes.PIPELINE_RUN,
+                    RunMetadataSchema.key == key,
+                    self.generate_custom_query_conditions_for_column(
+                        value=value,
+                        table=RunMetadataSchema,
+                        column="value",
+                    ),
+                )
+                custom_filters.append(additional_filter)
 
         return custom_filters

zenml/models/v2/core/run_metadata.py

@@ -13,21 +13,15 @@
 #  permissions and limitations under the License.
 """Models representing run metadata."""
 
-from typing import Any, Dict, Optional, Union
+from typing import Dict, Optional
 from uuid import UUID
 
-from pydantic import Field, field_validator
+from pydantic import Field
 
-from zenml.constants import STR_FIELD_MAX_LENGTH, TEXT_FIELD_MAX_LENGTH
 from zenml.enums import MetadataResourceTypes
 from zenml.metadata.metadata_types import MetadataType, MetadataTypeEnum
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedFilter,
     WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
 )
 
 # ------------------ Request Model ------------------
@@ -51,212 +45,3 @@ class RunMetadataRequest(WorkspaceScopedRequest):
     types: Dict[str, "MetadataTypeEnum"] = Field(
         title="The types of the metadata to be created.",
     )
-
-
-# ------------------ Update Model ------------------
-
-# There is no update model for run metadata.
-
-# ------------------ Response Model ------------------
-
-
-class RunMetadataResponseBody(WorkspaceScopedResponseBody):
-    """Response body for run metadata."""
-
-    key: str = Field(title="The key of the metadata.")
-    value: MetadataType = Field(
-        title="The value of the metadata.", union_mode="smart"
-    )
-    type: MetadataTypeEnum = Field(title="The type of the metadata.")
-
-    @field_validator("key", "type")
-    @classmethod
-    def str_field_max_length_check(cls, value: Any) -> Any:
-        """Checks if the length of the value exceeds the maximum str length.
-
-        Args:
-            value: the value set in the field
-
-        Returns:
-            the value itself.
-
-        Raises:
-            AssertionError: if the length of the field is longer than the
-                maximum threshold.
-        """
-        assert len(str(value)) < STR_FIELD_MAX_LENGTH, (
-            "The length of the value for this field can not "
-            f"exceed {STR_FIELD_MAX_LENGTH}"
-        )
-        return value
-
-    @field_validator("value")
-    @classmethod
-    def text_field_max_length_check(cls, value: Any) -> Any:
-        """Checks if the length of the value exceeds the maximum text length.
-
-        Args:
-            value: the value set in the field
-
-        Returns:
-            the value itself.
-
-        Raises:
-            AssertionError: if the length of the field is longer than the
-                maximum threshold.
-        """
-        assert len(str(value)) < TEXT_FIELD_MAX_LENGTH, (
-            "The length of the value for this field can not "
-            f"exceed {TEXT_FIELD_MAX_LENGTH}"
-        )
-        return value
-
-
-class RunMetadataResponseMetadata(WorkspaceScopedResponseMetadata):
-    """Response metadata for run metadata."""
-
-    resource_id: UUID = Field(
-        title="The ID of the resource that this metadata belongs to.",
-    )
-    resource_type: MetadataResourceTypes = Field(
-        title="The type of the resource that this metadata belongs to.",
-    )
-    stack_component_id: Optional[UUID] = Field(
-        title="The ID of the stack component that this metadata belongs to."
-    )
-
-
-class RunMetadataResponseResources(WorkspaceScopedResponseResources):
-    """Class for all resource models associated with the run metadata entity."""
-
-
-class RunMetadataResponse(
-    WorkspaceScopedResponse[
-        RunMetadataResponseBody,
-        RunMetadataResponseMetadata,
-        RunMetadataResponseResources,
-    ]
-):
-    """Response model for run metadata."""
-
-    def get_hydrated_version(self) -> "RunMetadataResponse":
-        """Get the hydrated version of this run metadata.
-
-        Returns:
-            an instance of the same entity with the metadata field attached.
-        """
-        from zenml.client import Client
-
-        return Client().zen_store.get_run_metadata(self.id)
-
-    # Body and metadata properties
-    @property
-    def key(self) -> str:
-        """The `key` property.
-
-        Returns:
-            the value of the property.
-        """
-        return self.get_body().key
-
-    @property
-    def value(self) -> MetadataType:
-        """The `value` property.
-
-        Returns:
-            the value of the property.
-        """
-        return self.get_body().value
-
-    @property
-    def type(self) -> MetadataTypeEnum:
-        """The `type` property.
-
-        Returns:
-            the value of the property.
-        """
-        return self.get_body().type
-
-    @property
-    def resource_id(self) -> UUID:
-        """The `resource_id` property.
-
-        Returns:
-            the value of the property.
-        """
-        return self.get_metadata().resource_id
-
-    @property
-    def resource_type(self) -> MetadataResourceTypes:
-        """The `resource_type` property.
-
-        Returns:
-            the value of the property.
-        """
-        return MetadataResourceTypes(self.get_metadata().resource_type)
-
-    @property
-    def stack_component_id(self) -> Optional[UUID]:
-        """The `stack_component_id` property.
-
-        Returns:
-            the value of the property.
-        """
-        return self.get_metadata().stack_component_id
-
-
-# ------------------ Filter Model ------------------
-
-
-class RunMetadataFilter(WorkspaceScopedFilter):
-    """Model to enable advanced filtering of run metadata."""
-
-    resource_id: Optional[Union[str, UUID]] = Field(
-        default=None, union_mode="left_to_right"
-    )
-    resource_type: Optional[MetadataResourceTypes] = None
-    stack_component_id: Optional[Union[str, UUID]] = Field(
-        default=None, union_mode="left_to_right"
-    )
-    key: Optional[str] = None
-    type: Optional[Union[str, MetadataTypeEnum]] = Field(
-        default=None, union_mode="left_to_right"
-    )
-
-
-# -------------------- Lazy Loader --------------------
-
-
-class LazyRunMetadataResponse(RunMetadataResponse):
-    """Lazy run metadata response.
-
-    Used if the run metadata is accessed from the model in
-    a pipeline context available only during pipeline compilation.
-    """
-
-    id: Optional[UUID] = None  # type: ignore[assignment]
-    lazy_load_artifact_name: Optional[str] = None
-    lazy_load_artifact_version: Optional[str] = None
-    lazy_load_metadata_name: Optional[str] = None
-    lazy_load_model_name: str
-    lazy_load_model_version: Optional[str] = None
-
-    def get_body(self) -> None:  # type: ignore[override]
-        """Protects from misuse of the lazy loader.
-
-        Raises:
-            RuntimeError: always
-        """
-        raise RuntimeError(
-            "Cannot access run metadata body before pipeline runs."
-        )
-
-    def get_metadata(self) -> None:  # type: ignore[override]
-        """Protects from misuse of the lazy loader.
-
-        Raises:
-            RuntimeError: always
-        """
-        raise RuntimeError(
-            "Cannot access run metadata metadata before pipeline runs."
-        )