zenml-nightly 0.75.0.dev20250313__py3-none-any.whl → 0.75.0.dev20250315__py3-none-any.whl

zenml/login/pro/{tenant → workspace}/models.py

@@ -11,7 +11,7 @@
 #  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.
-"""ZenML Pro tenant models."""
+"""ZenML Pro workspace models."""
 
 from typing import Optional
 from uuid import UUID
@@ -24,32 +24,32 @@ from zenml.login.pro.organization.models import OrganizationRead
 from zenml.utils.enum_utils import StrEnum
 
 
-class TenantStatus(StrEnum):
-    """Enum that represents the desired state or status of a tenant.
+class WorkspaceStatus(StrEnum):
+    """Enum that represents the desired state or status of a workspace.
 
     These values can be used in two places:
 
-    * in the `desired_state` field of a tenant object, to indicate the desired
-    state of the tenant (with the exception of `PENDING` and `FAILED` which
+    * in the `desired_state` field of a workspace object, to indicate the desired
+    state of the workspace (with the exception of `PENDING` and `FAILED` which
     are not valid values for `desired_state`)
-    * in the `status` field of a tenant object, to indicate the current state
-    of the tenant
+    * in the `status` field of a workspace object, to indicate the current state
+    of the workspace
     """
 
-    # Tenant hasn't been deployed yet (i.e. newly created) or has been fully
+    # Workspace hasn't been deployed yet (i.e. newly created) or has been fully
     # deleted by the infrastructure provider
     NOT_INITIALIZED = "not_initialized"
-    # Tenant is being processed by the infrastructure provider (is being
+    # Workspace is being processed by the infrastructure provider (is being
     # deployed, updated, deactivated, re-activated or deleted/cleaned up).
     PENDING = "pending"
-    # Tenant is up and running
+    # Workspace is up and running
     AVAILABLE = "available"
-    # Tenant is in a failure state (i.e. deployment, update or deletion failed)
+    # Workspace is in a failure state (i.e. deployment, update or deletion failed)
     FAILED = "failed"
-    # Tenant is deactivated
+    # Workspace is deactivated
     DEACTIVATED = "deactivated"
-    # Tenant resources have been deleted by the infrastructure provider but
-    # the tenant object still exists in the database
+    # Workspace resources have been deleted by the infrastructure provider but
+    # the workspace object still exists in the database
     DELETED = "deleted"
 
 
@@ -87,24 +87,26 @@ class ZenMLServiceRead(BaseRestAPIModel):
     )
 
 
-class TenantRead(BaseRestAPIModel):
-    """Pydantic Model for viewing a Tenant."""
+class WorkspaceRead(BaseRestAPIModel):
+    """Pydantic Model for viewing a Workspace."""
 
     id: UUID
 
     name: str
     description: Optional[str] = Field(
-        default=None, description="The description of the tenant."
+        default=None, description="The description of the workspace."
     )
 
     organization: OrganizationRead
 
-    desired_state: str = Field(description="The desired state of the tenant.")
+    desired_state: str = Field(
+        description="The desired state of the workspace."
+    )
     state_reason: str = Field(
-        description="The reason for the current tenant state.",
+        description="The reason for the current workspace state.",
     )
     status: str = Field(
-        description="The current operational state of the tenant."
+        description="The current operational state of the workspace."
     )
     zenml_service: ZenMLServiceRead = Field(description="The ZenML service.")
 
@@ -156,21 +158,18 @@ class TenantRead(BaseRestAPIModel):
 
     @property
     def dashboard_url(self) -> str:
-        """Get the URL to the ZenML Pro dashboard for this tenant.
+        """Get the URL to the ZenML Pro dashboard for this workspace.
 
         Returns:
-            The URL to the ZenML Pro dashboard for this tenant.
+            The URL to the ZenML Pro dashboard for this workspace.
         """
-        return (
-            ZENML_PRO_URL
-            + f"/organizations/{str(self.organization_id)}/tenants/{str(self.id)}"
-        )
+        return ZENML_PRO_URL + f"/workspaces/{str(self.name)}"
 
     @property
     def dashboard_organization_url(self) -> str:
-        """Get the URL to the ZenML Pro dashboard for this tenant's organization.
+        """Get the URL to the ZenML Pro dashboard for this workspace's organization.
 
         Returns:
-            The URL to the ZenML Pro dashboard for this tenant's organization.
+            The URL to the ZenML Pro dashboard for this workspace's organization.
         """
         return ZENML_PRO_URL + f"/organizations/{str(self.organization_id)}"

zenml/model/model.py

@@ -548,7 +548,7 @@ class Model(BaseModel):
                     limitations=self.limitations,
                     trade_offs=self.trade_offs,
                     ethics=self.ethics,
-                    workspace=zenml_client.active_workspace.id,
+                    project=zenml_client.active_project.id,
                     save_models_to_registry=self.save_models_to_registry,
                 )
                 model_request = ModelRequest.model_validate(model_request)
@@ -702,7 +702,7 @@ class Model(BaseModel):
 
             client = Client()
             model_version_request = ModelVersionRequest(
-                workspace=client.active_workspace.id,
+                project=client.active_project.id,
                 name=str(self.version) if self.version else None,
                 description=self.description,
                 model=model.id,

zenml/model_registries/base_model_registry.py

@@ -68,7 +68,7 @@ class ModelRegistryModelMetadata(BaseModel):
     zenml_pipeline_uuid: Optional[str] = None
     zenml_pipeline_run_uuid: Optional[str] = None
     zenml_step_name: Optional[str] = None
-    zenml_workspace: Optional[str] = None
+    zenml_project: Optional[str] = None
 
     @property
     def custom_attributes(self) -> Dict[str, str]:

zenml/models/__init__.py

@@ -34,13 +34,13 @@ from zenml.models.v2.base.scoped import (
     UserScopedResponse,
     UserScopedResponseBody,
     UserScopedResponseMetadata,
-    WorkspaceScopedRequest,
-    WorkspaceScopedFilter,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
-    WorkspaceScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedFilter,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
+    ProjectScopedFilter,
 )
 from zenml.models.v2.base.filter import (
     BaseFilter,
@@ -285,7 +285,7 @@ from zenml.models.v2.core.stack import (
     StackResponseMetadata,
 )
 from zenml.models.v2.misc.statistics import (
-    WorkspaceStatistics,
+    ProjectStatistics,
     ServerStatistics,
 )
 from zenml.models.v2.core.step_run import (
@@ -318,13 +318,13 @@ from zenml.models.v2.core.user import (
     UserResponseBody,
     UserResponseMetadata,
 )
-from zenml.models.v2.core.workspace import (
-    WorkspaceRequest,
-    WorkspaceUpdate,
-    WorkspaceFilter,
-    WorkspaceResponse,
-    WorkspaceResponseBody,
-    WorkspaceResponseMetadata,
+from zenml.models.v2.core.project import (
+    ProjectRequest,
+    ProjectUpdate,
+    ProjectFilter,
+    ProjectResponse,
+    ProjectResponseBody,
+    ProjectResponseMetadata,
 )
 
 # V2 Misc
@@ -503,13 +503,13 @@ __all__ = [
     "UserScopedResponse",
     "UserScopedResponseBody",
     "UserScopedResponseMetadata",
-    "WorkspaceScopedRequest",
-    "WorkspaceScopedFilter",
-    "WorkspaceScopedResponse",
-    "WorkspaceScopedResponseBody",
-    "WorkspaceScopedResponseMetadata",
-    "WorkspaceScopedResponseResources",
-    "WorkspaceScopedFilter",
+    "ProjectScopedRequest",
+    "ProjectScopedFilter",
+    "ProjectScopedResponse",
+    "ProjectScopedResponseBody",
+    "ProjectScopedResponseMetadata",
+    "ProjectScopedResponseResources",
+    "ProjectScopedFilter",
     "BaseFilter",
     "StrFilter",
     "BoolFilter",
@@ -737,12 +737,12 @@ __all__ = [
     "UserResponse",
     "UserResponseBody",
     "UserResponseMetadata",
-    "WorkspaceRequest",
-    "WorkspaceUpdate",
-    "WorkspaceFilter",
-    "WorkspaceResponse",
-    "WorkspaceResponseBody",
-    "WorkspaceResponseMetadata",
+    "ProjectRequest",
+    "ProjectUpdate",
+    "ProjectFilter",
+    "ProjectResponse",
+    "ProjectResponseBody",
+    "ProjectResponseMetadata",
     # V2 Misc
     "AuthenticationMethodModel",
     "DeployedStack",
@@ -776,5 +776,5 @@ __all__ = [
     "ResourcesInfo",
     "RunMetadataEntry",
     "RunMetadataResource",
-    "WorkspaceStatistics",
+    "ProjectStatistics",
 ]

zenml/models/v2/base/filter.py

@@ -421,7 +421,7 @@ class BaseFilter(BaseModel):
     ```
     ResourceListModel(
         name="contains:default",
-        workspace="default"
+        project="default"
         count_steps="gte:5"
         sort_by="created",
         page=2,

zenml/models/v2/base/scoped.py

@@ -42,8 +42,8 @@ from zenml.models.v2.base.filter import AnyQuery, BaseFilter
 if TYPE_CHECKING:
     from sqlalchemy.sql.elements import ColumnElement
 
+    from zenml.models.v2.core.project import ProjectResponse
     from zenml.models.v2.core.user import UserResponse
-    from zenml.models.v2.core.workspace import WorkspaceResponse
     from zenml.zen_stores.schemas import BaseSchema
 
     AnySchema = TypeVar("AnySchema", bound=BaseSchema)
@@ -80,24 +80,22 @@ class UserScopedRequest(BaseRequest):
         return metadata
 
 
-class WorkspaceScopedRequest(UserScopedRequest):
-    """Base workspace-scoped request domain model.
+class ProjectScopedRequest(UserScopedRequest):
+    """Base project-scoped request domain model.
 
-    Used as a base class for all domain models that are workspace-scoped.
+    Used as a base class for all domain models that are project-scoped.
     """
 
-    workspace: UUID = Field(
-        title="The workspace to which this resource belongs."
-    )
+    project: UUID = Field(title="The project to which this resource belongs.")
 
     def get_analytics_metadata(self) -> Dict[str, Any]:
-        """Fetches the analytics metadata for workspace scoped models.
+        """Fetches the analytics metadata for project scoped models.
 
         Returns:
             The analytics metadata.
         """
         metadata = super().get_analytics_metadata()
-        metadata["workspace_id"] = self.workspace
+        metadata["project_id"] = self.project
         return metadata
 
 
@@ -285,79 +283,77 @@ class UserScopedFilter(BaseFilter):
         return query
 
 
-# Workspace-scoped models
+# Project-scoped models
 
 
-class WorkspaceScopedResponseBody(UserScopedResponseBody):
-    """Base workspace-scoped body."""
+class ProjectScopedResponseBody(UserScopedResponseBody):
+    """Base project-scoped body."""
 
 
-class WorkspaceScopedResponseMetadata(UserScopedResponseMetadata):
-    """Base workspace-scoped metadata."""
+class ProjectScopedResponseMetadata(UserScopedResponseMetadata):
+    """Base project-scoped metadata."""
 
-    workspace: "WorkspaceResponse" = Field(
-        title="The workspace of this resource."
-    )
+    project: "ProjectResponse" = Field(title="The project of this resource.")
 
 
-class WorkspaceScopedResponseResources(UserScopedResponseResources):
-    """Base workspace-scoped resources."""
+class ProjectScopedResponseResources(UserScopedResponseResources):
+    """Base project-scoped resources."""
 
 
-WorkspaceBody = TypeVar("WorkspaceBody", bound=WorkspaceScopedResponseBody)
-WorkspaceMetadata = TypeVar(
-    "WorkspaceMetadata", bound=WorkspaceScopedResponseMetadata
+ProjectBody = TypeVar("ProjectBody", bound=ProjectScopedResponseBody)
+ProjectMetadata = TypeVar(
+    "ProjectMetadata", bound=ProjectScopedResponseMetadata
 )
-WorkspaceResources = TypeVar(
-    "WorkspaceResources", bound=WorkspaceScopedResponseResources
+ProjectResources = TypeVar(
+    "ProjectResources", bound=ProjectScopedResponseResources
 )
 
 
-class WorkspaceScopedResponse(
-    UserScopedResponse[WorkspaceBody, WorkspaceMetadata, WorkspaceResources],
-    Generic[WorkspaceBody, WorkspaceMetadata, WorkspaceResources],
+class ProjectScopedResponse(
+    UserScopedResponse[ProjectBody, ProjectMetadata, ProjectResources],
+    Generic[ProjectBody, ProjectMetadata, ProjectResources],
 ):
-    """Base workspace-scoped domain model.
+    """Base project-scoped domain model.
 
-    Used as a base class for all domain models that are workspace-scoped.
+    Used as a base class for all domain models that are project-scoped.
     """
 
     # Analytics
     def get_analytics_metadata(self) -> Dict[str, Any]:
-        """Fetches the analytics metadata for workspace scoped models.
+        """Fetches the analytics metadata for project scoped models.
 
         Returns:
             The analytics metadata.
         """
         metadata = super().get_analytics_metadata()
-        if self.workspace is not None:
-            metadata["workspace_id"] = self.workspace.id
+        if self.project is not None:
+            metadata["project_id"] = self.project.id
         return metadata
 
     # Body and metadata properties
     @property
-    def workspace(self) -> "WorkspaceResponse":
-        """The workspace property.
+    def project(self) -> "ProjectResponse":
+        """The project property.
 
         Returns:
             the value of the property.
         """
-        return self.get_metadata().workspace
+        return self.get_metadata().project
 
 
 # ---------------------- Filter Models ----------------------
 
 
-class WorkspaceScopedFilter(UserScopedFilter):
-    """Model to enable advanced scoping with workspace."""
+class ProjectScopedFilter(UserScopedFilter):
+    """Model to enable advanced scoping with project."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
         *UserScopedFilter.FILTER_EXCLUDE_FIELDS,
-        "workspace",
+        "project",
     ]
-    workspace: Optional[Union[UUID, str]] = Field(
+    project: Optional[Union[UUID, str]] = Field(
         default=None,
-        description="Name/ID of the workspace which the search is scoped to. "
+        description="Name/ID of the project which the search is scoped to. "
         "This field must always be set and is always applied in addition to "
         "the other filters, regardless of the value of the "
         "logical_operator field.",
@@ -379,30 +375,30 @@ class WorkspaceScopedFilter(UserScopedFilter):
             The query with filter applied.
 
         Raises:
-            ValueError: If the workspace scope is missing from the filter.
+            ValueError: If the project scope is missing from the filter.
         """
         query = super().apply_filter(query=query, table=table)
 
-        # The workspace scope must always be set and must be a UUID. If the
+        # The project scope must always be set and must be a UUID. If the
         # client sets this to a string, the server will try to resolve it to a
-        # workspace ID.
+        # project ID.
         #
         # If not set by the client, the server will fall back to using the
-        # user's default workspace or even the server's default workspace, if
-        # they are configured. If this also fails to yield a workspace, this
+        # user's default project or even the server's default project, if
+        # they are configured. If this also fails to yield a project, this
         # method will raise a ValueError.
         #
-        # See: SqlZenStore._set_filter_workspace_id
+        # See: SqlZenStore._set_filter_project_id
 
-        if not self.workspace:
-            raise ValueError("Workspace scope missing from the filter.")
+        if not self.project:
+            raise ValueError("Project scope missing from the filter.")
 
-        if not isinstance(self.workspace, UUID):
+        if not isinstance(self.project, UUID):
             raise ValueError(
-                f"Workspace scope must be a UUID, got {type(self.workspace)}."
+                f"Project scope must be a UUID, got {type(self.project)}."
             )
 
-        scope_filter = getattr(table, "workspace_id") == self.workspace
+        scope_filter = getattr(table, "project_id") == self.project
         query = query.where(scope_filter)
 
         return query
@@ -470,7 +466,7 @@ class TaggableFilter(BaseFilter):
 
         query = super().apply_filter(query=query, table=table)
 
-        if self.tags is not None:
+        if self.tags:
             query = query.join(
                 TagResourceSchema,
                 TagResourceSchema.resource_id == getattr(table, "id"),
@@ -491,7 +487,7 @@ class TaggableFilter(BaseFilter):
         """
         custom_filters = super().get_custom_filters(table)
 
-        if self.tags is not None:
+        if self.tags:
             from sqlmodel import exists, select
 
             from zenml.zen_stores.schemas import TagResourceSchema, TagSchema

zenml/models/v2/core/action.py

@@ -29,12 +29,12 @@ from zenml.constants import STR_FIELD_MAX_LENGTH
 from zenml.enums import PluginSubType
 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.user import UserResponse
 
@@ -47,7 +47,7 @@ if TYPE_CHECKING:
 # ------------------ Request Model ------------------
 
 
-class ActionRequest(WorkspaceScopedRequest):
+class ActionRequest(ProjectScopedRequest):
     """Model for creating a new action."""
 
     name: str = Field(
@@ -131,7 +131,7 @@ class ActionUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class ActionResponseBody(WorkspaceScopedResponseBody):
+class ActionResponseBody(ProjectScopedResponseBody):
     """Response body for actions."""
 
     flavor: str = Field(
@@ -144,7 +144,7 @@ class ActionResponseBody(WorkspaceScopedResponseBody):
     )
 
 
-class ActionResponseMetadata(WorkspaceScopedResponseMetadata):
+class ActionResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for actions."""
 
     description: str = Field(
@@ -161,7 +161,7 @@ class ActionResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class ActionResponseResources(WorkspaceScopedResponseResources):
+class ActionResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the action entity."""
 
     service_account: UserResponse = Field(
@@ -170,7 +170,7 @@ class ActionResponseResources(WorkspaceScopedResponseResources):
 
 
 class ActionResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         ActionResponseBody, ActionResponseMetadata, ActionResponseResources
     ]
 ):
@@ -259,7 +259,7 @@ class ActionResponse(
 # ------------------ Filter Model ------------------
 
 
-class ActionFilter(WorkspaceScopedFilter):
+class ActionFilter(ProjectScopedFilter):
     """Model to enable advanced filtering of all actions."""
 
     name: Optional[str] = Field(

zenml/models/v2/core/artifact.py

@@ -30,13 +30,13 @@ from pydantic import Field
 from zenml.constants import SORT_BY_LATEST_VERSION_KEY, STR_FIELD_MAX_LENGTH
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
+    ProjectScopedFilter,
+    ProjectScopedRequest,
+    ProjectScopedResponse,
+    ProjectScopedResponseBody,
+    ProjectScopedResponseMetadata,
+    ProjectScopedResponseResources,
     TaggableFilter,
-    WorkspaceScopedFilter,
-    WorkspaceScopedRequest,
-    WorkspaceScopedResponse,
-    WorkspaceScopedResponseBody,
-    WorkspaceScopedResponseMetadata,
-    WorkspaceScopedResponseResources,
 )
 from zenml.models.v2.core.tag import TagResponse
 
@@ -51,7 +51,7 @@ AnyQuery = TypeVar("AnyQuery", bound=Any)
 # ------------------ Request Model ------------------
 
 
-class ArtifactRequest(WorkspaceScopedRequest):
+class ArtifactRequest(ProjectScopedRequest):
     """Artifact request model."""
 
     name: str = Field(
@@ -84,7 +84,7 @@ class ArtifactUpdate(BaseUpdate):
 # ------------------ Response Model ------------------
 
 
-class ArtifactResponseBody(WorkspaceScopedResponseBody):
+class ArtifactResponseBody(ProjectScopedResponseBody):
     """Response body for artifacts."""
 
     tags: List[TagResponse] = Field(
@@ -94,7 +94,7 @@ class ArtifactResponseBody(WorkspaceScopedResponseBody):
     latest_version_id: Optional[UUID] = None
 
 
-class ArtifactResponseMetadata(WorkspaceScopedResponseMetadata):
+class ArtifactResponseMetadata(ProjectScopedResponseMetadata):
     """Response metadata for artifacts."""
 
     has_custom_name: bool = Field(
@@ -103,12 +103,12 @@ class ArtifactResponseMetadata(WorkspaceScopedResponseMetadata):
     )
 
 
-class ArtifactResponseResources(WorkspaceScopedResponseResources):
+class ArtifactResponseResources(ProjectScopedResponseResources):
     """Class for all resource models associated with the Artifact Entity."""
 
 
 class ArtifactResponse(
-    WorkspaceScopedResponse[
+    ProjectScopedResponse[
         ArtifactResponseBody,
         ArtifactResponseMetadata,
         ArtifactResponseResources,
@@ -185,22 +185,22 @@ class ArtifactResponse(
 # ------------------ Filter Model ------------------
 
 
-class ArtifactFilter(WorkspaceScopedFilter, TaggableFilter):
+class ArtifactFilter(ProjectScopedFilter, TaggableFilter):
     """Model to enable advanced filtering of artifacts."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.FILTER_EXCLUDE_FIELDS,
         *TaggableFilter.FILTER_EXCLUDE_FIELDS,
     ]
 
     CUSTOM_SORTING_OPTIONS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.CUSTOM_SORTING_OPTIONS,
+        *ProjectScopedFilter.CUSTOM_SORTING_OPTIONS,
         *TaggableFilter.CUSTOM_SORTING_OPTIONS,
         SORT_BY_LATEST_VERSION_KEY,
     ]
 
     CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = [
-        *WorkspaceScopedFilter.CLI_EXCLUDE_FIELDS,
+        *ProjectScopedFilter.CLI_EXCLUDE_FIELDS,
         *TaggableFilter.CLI_EXCLUDE_FIELDS,
     ]