zenml-nightly 0.75.0.dev20250312__py3-none-any.whl → 0.75.0.dev20250314__py3-none-any.whl

zenml/models/v2/core/stack.py

@@ -32,13 +32,14 @@ from sqlmodel import and_
 
 from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.enums import StackComponentType
-from zenml.models.v2.base.base import BaseRequest, BaseUpdate
+from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedFilter,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
+    UserScopedFilter,
+    UserScopedRequest,
+    UserScopedResponse,
+    UserScopedResponseBody,
+    UserScopedResponseMetadata,
+    UserScopedResponseResources,
 )
 from zenml.models.v2.misc.info_models import (
     ComponentInfo,
@@ -57,11 +58,8 @@ if TYPE_CHECKING:
 # ------------------ Request Model ------------------
 
 
-class StackRequest(BaseRequest):
-    """Request model for a stack."""
-
-    user: Optional[UUID] = None
-    workspace: Optional[UUID] = None
+class StackRequest(UserScopedRequest):
+    """Request model for stack creation."""
 
     name: str = Field(
         title="The name of the stack.", max_length=STR_FIELD_MAX_LENGTH
@@ -131,6 +129,10 @@ class StackRequest(BaseRequest):
         return self
 
 
+class DefaultStackRequest(StackRequest):
+    """Internal stack request model used only for default stacks."""
+
+
 # ------------------ Update Model ------------------
 
 
@@ -165,11 +167,11 @@ class StackUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class StackResponseBody(WorkspaceScopedResponseBody):
+class StackResponseBody(UserScopedResponseBody):
     """Response body for stacks."""
 
 
-class StackResponseMetadata(WorkspaceScopedResponseMetadata):
+class StackResponseMetadata(UserScopedResponseMetadata):
     """Response metadata for stacks."""
 
     components: Dict[StackComponentType, List["ComponentResponse"]] = Field(
@@ -191,13 +193,15 @@ class StackResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class StackResponseResources(WorkspaceScopedResponseResources):
-    """Class for all resource models associated with the stack entity."""
+class StackResponseResources(UserScopedResponseResources):
+    """Response resources for stacks."""
 
 
 class StackResponse(
-    WorkspaceScopedResponse[
-        StackResponseBody, StackResponseMetadata, StackResponseResources
+    UserScopedResponse[
+        StackResponseBody,
+        StackResponseMetadata,
+        StackResponseResources,
     ]
 ):
     """Response model for stacks."""
@@ -324,17 +328,11 @@ class StackResponse(
 # ------------------ Filter Model ------------------
 
 
-class StackFilter(WorkspaceScopedFilter):
-    """Model to enable advanced filtering of all StackModels.
-
-    The Stack Model needs additional scoping. As such the `_scope_user` field
-    can be set to the user that is doing the filtering. The
-    `generate_filter()` method of the baseclass is overwritten to include the
-    scoping.
-    """
+class StackFilter(UserScopedFilter):
+    """Model to enable advanced stack filtering."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *UserScopedFilter.FILTER_EXCLUDE_FIELDS,
         "component_id",
         "component",
     ]

zenml/models/v2/core/step_run.py

@@ -27,19 +27,20 @@ from typing import (
 )
 from uuid import UUID
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import ConfigDict, Field
 
 from zenml.config.step_configurations import StepConfiguration, StepSpec
 from zenml.constants import STR_FIELD_MAX_LENGTH, TEXT_FIELD_MAX_LENGTH
 from zenml.enums import ExecutionStatus, StepRunInputArtifactType
 from zenml.metadata.metadata_types import MetadataType
+from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
 )
 from zenml.models.v2.core.artifact_version import ArtifactVersionResponse
 from zenml.models.v2.core.model_version import ModelVersionResponse
@@ -78,7 +79,7 @@ class StepRunInputResponse(ArtifactVersionResponse):
 # ------------------ Request Model ------------------
 
 
-class StepRunRequest(WorkspaceScopedRequest):
+class StepRunRequest(ProjectScopedRequest):
     """Request model for step runs."""
 
     name: str = Field(
@@ -137,14 +138,6 @@ class StepRunRequest(WorkspaceScopedRequest):
         title="Logs associated with this step run.",
         default=None,
     )
-    deployment: UUID = Field(
-        title="The deployment associated with the step run."
-    )
-    model_version_id: Optional[UUID] = Field(
-        title="The ID of the model version that was "
-        "configured by this step run explicitly.",
-        default=None,
-    )
 
     model_config = ConfigDict(protected_namespaces=())
 
@@ -152,7 +145,7 @@ class StepRunRequest(WorkspaceScopedRequest):
 # ------------------ Update Model ------------------
 
 
-class StepRunUpdate(BaseModel):
+class StepRunUpdate(BaseUpdate):
     """Update model for step runs."""
 
     outputs: Dict[str, List[UUID]] = Field(
@@ -171,16 +164,11 @@ class StepRunUpdate(BaseModel):
         title="The end time of the step run.",
         default=None,
     )
-    model_version_id: Optional[UUID] = Field(
-        title="The ID of the model version that was "
-        "configured by this step run explicitly.",
-        default=None,
-    )
     model_config = ConfigDict(protected_namespaces=())
 
 
 # ------------------ Response Model ------------------
-class StepRunResponseBody(WorkspaceScopedResponseBody):
+class StepRunResponseBody(ProjectScopedResponseBody):
     """Response body for step runs."""
 
     status: ExecutionStatus = Field(title="The status of the step.")
@@ -208,7 +196,7 @@ class StepRunResponseBody(WorkspaceScopedResponseBody):
     model_config = ConfigDict(protected_namespaces=())
 
 
-class StepRunResponseMetadata(WorkspaceScopedResponseMetadata):
+class StepRunResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for step runs."""
 
     # Configuration
@@ -262,7 +250,7 @@ class StepRunResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class StepRunResponseResources(WorkspaceScopedResponseResources):
+class StepRunResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the step run entity."""
 
     model_version: Optional[ModelVersionResponse] = None
@@ -277,7 +265,7 @@ class StepRunResponseResources(WorkspaceScopedResponseResources):
 
 
 class StepRunResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         StepRunResponseBody, StepRunResponseMetadata, StepRunResponseResources
     ]
 ):
@@ -516,11 +504,11 @@ class StepRunResponse(
 # ------------------ Filter Model ------------------
 
 
-class StepRunFilter(WorkspaceScopedFilter):
+class StepRunFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of step runs."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.FILTER_EXCLUDE_FIELDS,
         "model",
         "run_metadata",
     ]

zenml/models/v2/core/tag.py

@@ -16,29 +16,34 @@
 import random
 from typing import Optional
 
-from pydantic import BaseModel, Field
+from pydantic import Field
 
 from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.enums import ColorVariants
-from zenml.models.v2.base.base import (
-    BaseDatedResponseBody,
-    BaseIdentifiedResponse,
-    BaseRequest,
-    BaseResponseMetadata,
-    BaseResponseResources,
+from zenml.models.v2.base.base import BaseUpdate
+from zenml.models.v2.base.scoped import (
+    UserScopedFilter,
+    UserScopedRequest,
+    UserScopedResponse,
+    UserScopedResponseBody,
+    UserScopedResponseMetadata,
+    UserScopedResponseResources,
 )
-from zenml.models.v2.base.filter import BaseFilter
 
 # ------------------ Request Model ------------------
 
 
-class TagRequest(BaseRequest):
+class TagRequest(UserScopedRequest):
     """Request model for tags."""
 
     name: str = Field(
         description="The unique title of the tag.",
         max_length=STR_FIELD_MAX_LENGTH,
     )
+    exclusive: bool = Field(
+        description="The flag signifying whether the tag is an exclusive tag.",
+        default=False,
+    )
     color: ColorVariants = Field(
         description="The color variant assigned to the tag.",
         default_factory=lambda: random.choice(list(ColorVariants)),
@@ -48,35 +53,43 @@ class TagRequest(BaseRequest):
 # ------------------ Update Model ------------------
 
 
-class TagUpdate(BaseModel):
+class TagUpdate(BaseUpdate):
     """Update model for tags."""
 
     name: Optional[str] = None
+    exclusive: Optional[bool] = None
     color: Optional[ColorVariants] = None
 
 
 # ------------------ Response Model ------------------
 
 
-class TagResponseBody(BaseDatedResponseBody):
+class TagResponseBody(UserScopedResponseBody):
     """Response body for tags."""
 
     color: ColorVariants = Field(
         description="The color variant assigned to the tag.",
         default_factory=lambda: random.choice(list(ColorVariants)),
     )
+    exclusive: bool = Field(
+        description="The flag signifying whether the tag is an exclusive tag."
+    )
     tagged_count: int = Field(
         description="The count of resources tagged with this tag."
     )
 
 
-class TagResponseResources(BaseResponseResources):
+class TagResponseMetadata(UserScopedResponseMetadata):
+    """Response metadata for tags."""
+
+
+class TagResponseResources(UserScopedResponseResources):
     """Class for all resource models associated with the tag entity."""
 
 
 class TagResponse(
-    BaseIdentifiedResponse[
-        TagResponseBody, BaseResponseMetadata, TagResponseResources
+    UserScopedResponse[
+        TagResponseBody, TagResponseMetadata, TagResponseResources
     ]
 ):
     """Response model for tags."""
@@ -105,6 +118,15 @@ class TagResponse(
         """
         return self.get_body().color
 
+    @property
+    def exclusive(self) -> bool:
+        """The `exclusive` property.
+
+        Returns:
+            the value of the property.
+        """
+        return self.get_body().exclusive
+
     @property
     def tagged_count(self) -> int:
         """The `tagged_count` property.
@@ -118,7 +140,7 @@ class TagResponse(
 # ------------------ Filter Model ------------------
 
 
-class TagFilter(BaseFilter):
+class TagFilter(UserScopedFilter):
     """Model to enable advanced filtering of all tags."""
 
     name: Optional[str] = Field(
@@ -127,3 +149,7 @@ class TagFilter(BaseFilter):
     color: Optional[ColorVariants] = Field(
         description="The color variant assigned to the tag.", default=None
     )
+    exclusive: Optional[bool] = Field(
+        description="The flag signifying whether the tag is an exclusive tag.",
+        default=None,
+    )

zenml/models/v2/core/trigger.py

@@ -33,12 +33,12 @@ from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.page import Page
 from zenml.models.v2.base.scoped import (
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
 )
 from zenml.models.v2.core.trigger_execution import TriggerExecutionResponse
 
@@ -57,7 +57,7 @@ if TYPE_CHECKING:
 # ------------------ Request Model ------------------
 
 
-class TriggerRequest(WorkspaceScopedRequest):
+class TriggerRequest(ProjectScopedRequest):
     """Model for creating a new trigger."""
 
     name: str = Field(
@@ -145,7 +145,7 @@ class TriggerUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class TriggerResponseBody(WorkspaceScopedResponseBody):
+class TriggerResponseBody(ProjectScopedResponseBody):
     """Response body for triggers."""
 
     action_flavor: str = Field(
@@ -172,7 +172,7 @@ class TriggerResponseBody(WorkspaceScopedResponseBody):
     )
 
 
-class TriggerResponseMetadata(WorkspaceScopedResponseMetadata):
+class TriggerResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for triggers."""
 
     description: str = Field(
@@ -192,7 +192,7 @@ class TriggerResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class TriggerResponseResources(WorkspaceScopedResponseResources):
+class TriggerResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the trigger entity."""
 
     action: "ActionResponse" = Field(
@@ -209,7 +209,7 @@ class TriggerResponseResources(WorkspaceScopedResponseResources):
 
 
 class TriggerResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         TriggerResponseBody, TriggerResponseMetadata, TriggerResponseResources
     ]
 ):
@@ -324,11 +324,11 @@ class TriggerResponse(
 # ------------------ Filter Model ------------------
 
 
-class TriggerFilter(WorkspaceScopedFilter):
+class TriggerFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of all triggers."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.FILTER_EXCLUDE_FIELDS,
         "action_flavor",
         "action_subtype",
         "event_source_flavor",

zenml/models/v2/core/trigger_execution.py

@@ -27,7 +27,7 @@ from zenml.models.v2.base.base import (
     BaseDatedResponseBody,
     BaseResponseResources,
 )
-from zenml.models.v2.base.scoped import WorkspaceScopedFilter
+from zenml.models.v2.base.scoped import ProjectScopedFilter
 
 if TYPE_CHECKING:
     from zenml.models.v2.core.trigger import TriggerResponse
@@ -109,7 +109,7 @@ class TriggerExecutionResponse(
 # ------------------ Filter Model ------------------
 
 
-class TriggerExecutionFilter(WorkspaceScopedFilter):
+class TriggerExecutionFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of all trigger executions."""
 
     trigger_id: Optional[Union[UUID, str]] = Field(

zenml/models/v2/core/user.py

@@ -36,7 +36,7 @@ from zenml.models.v2.base.base import (
     BaseRequest,
     BaseResponseMetadata,
     BaseResponseResources,
-    BaseZenModel,
+    BaseUpdate,
 )
 from zenml.models.v2.base.filter import AnyQuery, BaseFilter
 
@@ -176,7 +176,7 @@ class UserRequest(UserBase, BaseRequest):
 # ------------------ Update Model ------------------
 
 
-class UserUpdate(UserBase, BaseZenModel):
+class UserUpdate(UserBase, BaseUpdate):
     """Update model for users."""
 
     name: Optional[str] = Field(

zenml/models/v2/misc/statistics.py

@@ -0,0 +1,45 @@
+#  Copyright (c) ZenML GmbH 2023. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at:
+#
+#       https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+#  or implied. See the License for the specific language governing
+#  permissions and limitations under the License.
+"""Models representing statistics."""
+
+from pydantic import Field
+
+from zenml.models.v2.base.base import (
+    BaseZenModel,
+)
+
+
+class ProjectStatistics(BaseZenModel):
+    """Project statistics."""
+
+    pipelines: int = Field(
+        title="The number of pipelines.",
+    )
+    runs: int = Field(
+        title="The number of pipeline runs.",
+    )
+
+
+class ServerStatistics(BaseZenModel):
+    """Server statistics."""
+
+    stacks: int = Field(
+        title="The number of stacks.",
+    )
+    components: int = Field(
+        title="The number of components.",
+    )
+    projects: int = Field(
+        title="The number of projects.",
+    )

zenml/models/v2/misc/tag.py

@@ -0,0 +1,27 @@
+#  Copyright (c) ZenML GmbH 2025. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at:
+#
+#       https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+#  or implied. See the License for the specific language governing
+#  permissions and limitations under the License.
+"""Utility models for tags."""
+
+from uuid import UUID
+
+from pydantic import BaseModel, Field
+
+from zenml.enums import TaggableResourceTypes
+
+
+class TagResource(BaseModel):
+    """Utility class to help identify resources to tag."""
+
+    id: UUID = Field(title="The ID of the resource.")
+    type: TaggableResourceTypes = Field(title="The type of the resource.")

zenml/orchestrators/cache_utils.py

@@ -34,7 +34,7 @@ def generate_cache_key(
     step: "Step",
     input_artifact_ids: Dict[str, "UUID"],
     artifact_store: "BaseArtifactStore",
-    workspace_id: "UUID",
+    project_id: "UUID",
 ) -> str:
     """Generates a cache key for a step run.
 
@@ -42,7 +42,7 @@ def generate_cache_key(
     runs are identical and can be cached.
 
     The cache key is a MD5 hash of:
-    - the workspace ID,
+    - the project ID,
     - the artifact store ID and path,
     - the source code that defines the step,
     - the parameters of the step,
@@ -55,15 +55,15 @@ def generate_cache_key(
         step: The step to generate the cache key for.
         input_artifact_ids: The input artifact IDs for the step.
         artifact_store: The artifact store of the active stack.
-        workspace_id: The ID of the active workspace.
+        project_id: The ID of the active project.
 
     Returns:
         A cache key.
     """
     hash_ = hashlib.md5()  # nosec
 
-    # Workspace ID
-    hash_.update(workspace_id.bytes)
+    # Project ID
+    hash_.update(project_id.bytes)
 
     # Artifact store ID and path
     hash_.update(artifact_store.id.bytes)
@@ -106,7 +106,7 @@ def get_cached_step_run(cache_key: str) -> Optional["StepRunResponse"]:
     """If a given step can be cached, get the corresponding existing step run.
 
     A step run can be cached if there is an existing step run in the same
-    workspace which has the same cache key and was successfully executed.
+    project which has the same cache key and was successfully executed.
 
     Args:
         cache_key: The cache key of the step.
@@ -117,7 +117,7 @@ def get_cached_step_run(cache_key: str) -> Optional["StepRunResponse"]:
     client = Client()
 
     cache_candidates = client.list_run_steps(
-        workspace_id=client.active_workspace.id,
+        project=client.active_project.id,
         cache_key=cache_key,
         status=ExecutionStatus.COMPLETED,
         sort_by=f"{SorterOps.DESCENDING}:created",

zenml/orchestrators/input_utils.py

@@ -55,6 +55,7 @@ def resolve_step_inputs(
         for run_step in pagination_utils.depaginate(
             Client().list_run_steps,
             pipeline_run_id=pipeline_run.id,
+            project=pipeline_run.project.id,
         )
     }
 

zenml/orchestrators/step_launcher.py

@@ -319,8 +319,7 @@ class StepLauncher:
         pipeline_run = PipelineRunRequest(
             name=run_name,
             orchestrator_run_id=self._orchestrator_run_id,
-            user=client.active_user.id,
-            workspace=client.active_workspace.id,
+            project=client.active_project.id,
             deployment=self._deployment.id,
             pipeline=(
                 self._deployment.pipeline.id

zenml/orchestrators/step_run_utils.py

@@ -73,11 +73,9 @@ class StepRunRequestFactory:
         return StepRunRequest(
             name=invocation_id,
             pipeline_run_id=self.pipeline_run.id,
-            deployment=self.deployment.id,
             status=ExecutionStatus.RUNNING,
             start_time=utc_now(),
-            user=Client().active_user.id,
-            workspace=Client().active_workspace.id,
+            project=Client().active_project.id,
         )
 
     def populate_request(self, request: StepRunRequest) -> None:
@@ -104,7 +102,7 @@ class StepRunRequestFactory:
             step=step,
             input_artifact_ids=input_artifact_ids,
             artifact_store=self.stack.artifact_store,
-            workspace_id=Client().active_workspace.id,
+            project_id=Client().active_project.id,
         )
         request.cache_key = cache_key
 

zenml/orchestrators/step_runner.py

@@ -56,7 +56,12 @@ from zenml.steps.utils import (
     parse_return_type_annotations,
     resolve_type_annotation,
 )
-from zenml.utils import materializer_utils, source_utils, string_utils
+from zenml.utils import (
+    materializer_utils,
+    source_utils,
+    string_utils,
+    tag_utils,
+)
 from zenml.utils.typing_utils import get_origin, is_union
 
 if TYPE_CHECKING:
@@ -637,6 +642,10 @@ class StepRunner:
 
             # Get full set of tags
             tags = step_context.get_output_tags(output_name)
+            if step_context.pipeline_run.config.tags is not None:
+                for tag in step_context.pipeline_run.config.tags:
+                    if isinstance(tag, tag_utils.Tag) and tag.cascade is True:
+                        tags.append(tag.name)
 
             artifact_request = _store_artifact_data_and_prepare_request(
                 name=artifact_name,

zenml/orchestrators/utils.py

@@ -23,8 +23,8 @@ from zenml.config.global_config import (
     GlobalConfiguration,
 )
 from zenml.constants import (
+    ENV_ZENML_ACTIVE_PROJECT_ID,
     ENV_ZENML_ACTIVE_STACK_ID,
-    ENV_ZENML_ACTIVE_WORKSPACE_ID,
     ENV_ZENML_DISABLE_CREDENTIALS_DISK_CACHING,
     ENV_ZENML_PIPELINE_RUN_API_TOKEN_EXPIRATION,
     ENV_ZENML_SERVER,
@@ -211,13 +211,13 @@ def get_config_environment_vars(
     # in the pipeline run environment
     environment_vars[ENV_ZENML_DISABLE_CREDENTIALS_DISK_CACHING] = "true"
 
-    # Make sure to use the correct active stack/workspace which might come
+    # Make sure to use the correct active stack/project which might come
     # from a .zen repository and not the global config
     environment_vars[ENV_ZENML_ACTIVE_STACK_ID] = str(
         Client().active_stack_model.id
     )
-    environment_vars[ENV_ZENML_ACTIVE_WORKSPACE_ID] = str(
-        Client().active_workspace.id
+    environment_vars[ENV_ZENML_ACTIVE_PROJECT_ID] = str(
+        Client().active_project.id
     )
 
     return environment_vars