zenml-nightly 0.75.0.dev20250317__py3-none-any.whl → 0.80.0.dev20250321__py3-none-any.whl

zenml/models/v2/core/pipeline_run.py

@@ -42,6 +42,7 @@ from zenml.models.v2.base.scoped import (
     ProjectScopedResponseBody,
     ProjectScopedResponseMetadata,
     ProjectScopedResponseResources,
+    RunMetadataFilterMixin,
     TaggableFilter,
 )
 from zenml.models.v2.core.model_version import ModelVersionResponse
@@ -582,12 +583,15 @@ class PipelineRunResponse(
 # ------------------ Filter Model ------------------
 
 
-class PipelineRunFilter(ProjectScopedFilter, TaggableFilter):
+class PipelineRunFilter(
+    ProjectScopedFilter, TaggableFilter, RunMetadataFilterMixin
+):
     """Model to enable advanced filtering of all pipeline runs."""
 
     CUSTOM_SORTING_OPTIONS: ClassVar[List[str]] = [
         *ProjectScopedFilter.CUSTOM_SORTING_OPTIONS,
         *TaggableFilter.CUSTOM_SORTING_OPTIONS,
+        *RunMetadataFilterMixin.CUSTOM_SORTING_OPTIONS,
         "tag",
         "stack",
         "pipeline",
@@ -597,6 +601,7 @@ class PipelineRunFilter(ProjectScopedFilter, TaggableFilter):
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
         *ProjectScopedFilter.FILTER_EXCLUDE_FIELDS,
         *TaggableFilter.FILTER_EXCLUDE_FIELDS,
+        *RunMetadataFilterMixin.FILTER_EXCLUDE_FIELDS,
         "unlisted",
         "code_repository_id",
         "build_id",
@@ -610,11 +615,16 @@ class PipelineRunFilter(ProjectScopedFilter, TaggableFilter):
         "stack_component",
         "pipeline_name",
         "templatable",
-        "run_metadata",
     ]
     CLI_EXCLUDE_FIELDS = [
         *ProjectScopedFilter.CLI_EXCLUDE_FIELDS,
         *TaggableFilter.CLI_EXCLUDE_FIELDS,
+        *RunMetadataFilterMixin.CLI_EXCLUDE_FIELDS,
+    ]
+    API_MULTI_INPUT_PARAMS: ClassVar[List[str]] = [
+        *ProjectScopedFilter.API_MULTI_INPUT_PARAMS,
+        *TaggableFilter.API_MULTI_INPUT_PARAMS,
+        *RunMetadataFilterMixin.API_MULTI_INPUT_PARAMS,
     ]
 
     name: Optional[str] = Field(
@@ -680,10 +690,6 @@ class PipelineRunFilter(ProjectScopedFilter, TaggableFilter):
         union_mode="left_to_right",
     )
     unlisted: Optional[bool] = None
-    run_metadata: Optional[Dict[str, Any]] = 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(
@@ -740,8 +746,6 @@ class PipelineRunFilter(ProjectScopedFilter, TaggableFilter):
             PipelineDeploymentSchema,
             PipelineRunSchema,
             PipelineSchema,
-            RunMetadataResourceSchema,
-            RunMetadataSchema,
             ScheduleSchema,
             StackComponentSchema,
             StackCompositionSchema,
@@ -899,30 +903,6 @@ class PipelineRunFilter(ProjectScopedFilter, TaggableFilter):
                 )
 
             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_(
-                    RunMetadataResourceSchema.resource_id
-                    == PipelineRunSchema.id,
-                    RunMetadataResourceSchema.resource_type
-                    == MetadataResourceTypes.PIPELINE_RUN.value,
-                    RunMetadataResourceSchema.run_metadata_id
-                    == RunMetadataSchema.id,
-                    self.generate_custom_query_conditions_for_column(
-                        value=key,
-                        table=RunMetadataSchema,
-                        column="key",
-                    ),
-                    self.generate_custom_query_conditions_for_column(
-                        value=value,
-                        table=RunMetadataSchema,
-                        column="value",
-                        json_encode_value=True,
-                    ),
-                )
-                custom_filters.append(additional_filter)
 
         return custom_filters
 

zenml/models/v2/core/service.py

@@ -31,6 +31,7 @@ from pydantic import ConfigDict, Field
 from sqlalchemy.sql.elements import ColumnElement
 
 from zenml.constants import STR_FIELD_MAX_LENGTH
+from zenml.enums import ServiceState
 from zenml.models.v2.base.base import BaseUpdate
 from zenml.models.v2.base.scoped import (
     ProjectScopedFilter,
@@ -40,8 +41,7 @@ from zenml.models.v2.base.scoped import (
     ProjectScopedResponseMetadata,
     ProjectScopedResponseResources,
 )
-from zenml.services.service_status import ServiceState
-from zenml.services.service_type import ServiceType
+from zenml.models.v2.misc.service import ServiceType
 
 if TYPE_CHECKING:
     from zenml.models.v2.core.model_version import ModelVersionResponse

zenml/models/v2/core/step_run.py

@@ -16,7 +16,6 @@
 from datetime import datetime
 from typing import (
     TYPE_CHECKING,
-    Any,
     ClassVar,
     Dict,
     List,
@@ -41,6 +40,7 @@ from zenml.models.v2.base.scoped import (
     ProjectScopedResponseBody,
     ProjectScopedResponseMetadata,
     ProjectScopedResponseResources,
+    RunMetadataFilterMixin,
 )
 from zenml.models.v2.core.artifact_version import ArtifactVersionResponse
 from zenml.models.v2.core.model_version import ModelVersionResponse
@@ -504,13 +504,25 @@ class StepRunResponse(
 # ------------------ Filter Model ------------------
 
 
-class StepRunFilter(ProjectScopedFilter):
+class StepRunFilter(ProjectScopedFilter, RunMetadataFilterMixin):
     """Model to enable advanced filtering of step runs."""
 
     FILTER_EXCLUDE_FIELDS: ClassVar[List[str]] = [
         *ProjectScopedFilter.FILTER_EXCLUDE_FIELDS,
+        *RunMetadataFilterMixin.FILTER_EXCLUDE_FIELDS,
         "model",
-        "run_metadata",
+    ]
+    CLI_EXCLUDE_FIELDS: ClassVar[List[str]] = [
+        *ProjectScopedFilter.CLI_EXCLUDE_FIELDS,
+        *RunMetadataFilterMixin.CLI_EXCLUDE_FIELDS,
+    ]
+    CUSTOM_SORTING_OPTIONS: ClassVar[List[str]] = [
+        *ProjectScopedFilter.CUSTOM_SORTING_OPTIONS,
+        *RunMetadataFilterMixin.CUSTOM_SORTING_OPTIONS,
+    ]
+    API_MULTI_INPUT_PARAMS: ClassVar[List[str]] = [
+        *ProjectScopedFilter.API_MULTI_INPUT_PARAMS,
+        *RunMetadataFilterMixin.API_MULTI_INPUT_PARAMS,
     ]
 
     name: Optional[str] = Field(
@@ -563,10 +575,6 @@ class StepRunFilter(ProjectScopedFilter):
         default=None,
         description="Name/ID of the model associated with the step run.",
     )
-    run_metadata: Optional[Dict[str, Any]] = Field(
-        default=None,
-        description="The run_metadata to filter the step runs by.",
-    )
     model_config = ConfigDict(protected_namespaces=())
 
     def get_custom_filters(
@@ -587,8 +595,6 @@ class StepRunFilter(ProjectScopedFilter):
         from zenml.zen_stores.schemas import (
             ModelSchema,
             ModelVersionSchema,
-            RunMetadataResourceSchema,
-            RunMetadataSchema,
             StepRunSchema,
         )
 
@@ -601,28 +607,5 @@ class StepRunFilter(ProjectScopedFilter):
                 ),
             )
             custom_filters.append(model_filter)
-        if self.run_metadata is not None:
-            from zenml.enums import MetadataResourceTypes
-
-            for key, value in self.run_metadata.items():
-                additional_filter = and_(
-                    RunMetadataResourceSchema.resource_id == StepRunSchema.id,
-                    RunMetadataResourceSchema.resource_type
-                    == MetadataResourceTypes.STEP_RUN.value,
-                    RunMetadataResourceSchema.run_metadata_id
-                    == RunMetadataSchema.id,
-                    self.generate_custom_query_conditions_for_column(
-                        value=key,
-                        table=RunMetadataSchema,
-                        column="key",
-                    ),
-                    self.generate_custom_query_conditions_for_column(
-                        value=value,
-                        table=RunMetadataSchema,
-                        column="value",
-                        json_encode_value=True,
-                    ),
-                )
-                custom_filters.append(additional_filter)
 
         return custom_filters

zenml/{services/service_type.py → models/v2/misc/service.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.
-"""Implementation of a ZenML ServiceType class."""
+"""Misc models for services."""
 
 from pydantic import BaseModel, ConfigDict
 

zenml/orchestrators/step_run_utils.py

@@ -352,7 +352,7 @@ def log_model_version_dashboard_url(
     """
     from zenml.utils.dashboard_utils import get_model_version_url
 
-    if model_version_url := get_model_version_url(model_version.id):
+    if model_version_url := get_model_version_url(model_version):
         logger.info(
             "Dashboard URL for Model Version `%s (%s)`:\n%s",
             model_version.model.name,

zenml/orchestrators/utils.py

@@ -184,7 +184,7 @@ def get_config_environment_vars(
                         "service account API key to authenticate to the ZenML "
                         "server instead of your regular user account. For more "
                         "information, see "
-                        "https://docs.zenml.io/how-to/connecting-to-zenml/connect-with-a-service-account"
+                        "https://docs.zenml.io/how-to/manage-zenml-server/connecting-to-zenml/connect-with-a-service-account"
                     )
 
                 # The schedule, pipeline run or step run credentials are scoped to

zenml/services/__init__.py

@@ -51,19 +51,17 @@ from zenml.services.service_monitor import (
     TCPEndpointHealthMonitor,
     TCPEndpointHealthMonitorConfig,
 )
-from zenml.services.service_status import ServiceState, ServiceStatus
-from zenml.services.service_type import ServiceType
-
+from zenml.services.service_status import ServiceStatus
+from zenml.enums import ServiceState
+from zenml.models.v2.misc.service import ServiceType
 
 __all__ = [
-    "ServiceState",
     "ServiceConfig",
     "ServiceStatus",
     "ServiceEndpointProtocol",
     "ServiceEndpointConfig",
     "ServiceEndpointStatus",
     "BaseServiceEndpoint",
-    "ServiceType",
     "BaseService",
     "ServiceEndpointHealthMonitorConfig",
     "BaseServiceEndpointHealthMonitor",

zenml/services/container/container_service.py

@@ -27,12 +27,13 @@ from docker.models.containers import Container
 from pydantic import Field
 
 from zenml.constants import ENV_ZENML_CONFIG_PATH
+from zenml.enums import ServiceState
 from zenml.logger import get_logger
 from zenml.services.container.container_service_endpoint import (
     ContainerServiceEndpoint,
 )
 from zenml.services.service import BaseService, ServiceConfig
-from zenml.services.service_status import ServiceState, ServiceStatus
+from zenml.services.service_status import ServiceStatus
 from zenml.utils import docker_utils
 from zenml.utils.io_utils import (
     create_dir_recursive_if_not_exists,

zenml/services/local/local_service.py

@@ -26,12 +26,13 @@ import psutil
 from psutil import NoSuchProcess
 from pydantic import Field
 
+from zenml.enums import ServiceState
 from zenml.logger import get_logger
 from zenml.services.local.local_service_endpoint import (
     LocalDaemonServiceEndpoint,
 )
 from zenml.services.service import BaseService, ServiceConfig
-from zenml.services.service_status import ServiceState, ServiceStatus
+from zenml.services.service_status import ServiceStatus
 from zenml.utils.io_utils import create_dir_recursive_if_not_exists
 
 logger = get_logger(__name__)

zenml/services/service.py

@@ -34,11 +34,12 @@ from uuid import UUID
 from pydantic import ConfigDict
 
 from zenml.console import console
+from zenml.enums import ServiceState
 from zenml.logger import get_logger
+from zenml.models.v2.misc.service import ServiceType
 from zenml.services.service_endpoint import BaseServiceEndpoint
 from zenml.services.service_monitor import HTTPEndpointHealthMonitor
-from zenml.services.service_status import ServiceState, ServiceStatus
-from zenml.services.service_type import ServiceType
+from zenml.services.service_status import ServiceStatus
 from zenml.utils import source_utils
 from zenml.utils.typed_model import BaseTypedModel
 

zenml/services/service_endpoint.py

@@ -16,9 +16,10 @@
 from typing import Any, Optional, Tuple
 
 from zenml.constants import DEFAULT_LOCAL_SERVICE_IP_ADDRESS
+from zenml.enums import ServiceState
 from zenml.logger import get_logger
 from zenml.services.service_monitor import BaseServiceEndpointHealthMonitor
-from zenml.services.service_status import ServiceState, ServiceStatus
+from zenml.services.service_status import ServiceStatus
 from zenml.utils.enum_utils import StrEnum
 from zenml.utils.typed_model import BaseTypedModel
 

zenml/services/service_monitor.py

@@ -19,8 +19,8 @@ from typing import TYPE_CHECKING, Optional, Tuple
 import requests
 from pydantic import Field
 
+from zenml.enums import ServiceState
 from zenml.logger import get_logger
-from zenml.services.service_status import ServiceState
 from zenml.utils.networking_utils import port_is_open
 from zenml.utils.typed_model import BaseTypedModel
 

zenml/services/service_status.py

@@ -15,24 +15,13 @@
 
 from typing import Optional
 
+from zenml.enums import ServiceState
 from zenml.logger import get_logger
-from zenml.utils.enum_utils import StrEnum
 from zenml.utils.typed_model import BaseTypedModel
 
 logger = get_logger(__name__)
 
 
-class ServiceState(StrEnum):
-    """Possible states for the service and service endpoint."""
-
-    INACTIVE = "inactive"
-    ACTIVE = "active"
-    PENDING_STARTUP = "pending_startup"
-    PENDING_SHUTDOWN = "pending_shutdown"
-    ERROR = "error"
-    SCALED_TO_ZERO = "scaled_to_zero"
-
-
 class ServiceStatus(BaseTypedModel):
     """Information about the status of a service or process.
 

zenml/steps/entrypoint_function_utils.py

@@ -174,7 +174,7 @@ class EntrypointFunctionDefinition(NamedTuple):
                 f"'{key}' is not JSON serializable and can not be passed as "
                 "a parameter. This input can either be provided by the "
                 "output of another step or as an external artifact: "
-                "https://docs.zenml.io/user-guide/starter-guide/manage-artifacts#managing-artifacts-not-produced-by-zenml-pipelines"
+                "https://docs.zenml.io/user-guides/starter-guide/manage-artifacts#managing-artifacts-not-produced-by-zenml-pipelines"
             )
 
         try:

zenml/utils/dashboard_utils.py

@@ -15,19 +15,22 @@
 
 import os
 from typing import Optional
-from uuid import UUID
+from urllib.parse import urlparse
 
 from zenml import constants
 from zenml.client import Client
+from zenml.config.global_config import GlobalConfiguration
 from zenml.enums import EnvironmentType, StoreType
 from zenml.environment import get_environment
 from zenml.logger import get_logger
 from zenml.models import (
     ComponentResponse,
+    ModelVersionResponse,
     PipelineRunResponse,
     ServerDeploymentType,
     StackResponse,
 )
+from zenml.utils.server_utils import get_local_server
 
 logger = get_logger(__name__)
 
@@ -79,10 +82,17 @@ def get_stack_url(stack: StackResponse) -> Optional[str]:
     Returns:
         the URL to the stack if the dashboard is available, else None.
     """
+    cloud_url = get_cloud_dashboard_url()
+    if cloud_url:
+        # We don't have a stack detail page here, so just link to the filtered
+        # list of stacks.
+        return f"{cloud_url}{constants.STACKS}?id={stack.id}"
+
     base_url = get_server_dashboard_url()
 
     if base_url:
-        return base_url + constants.STACKS
+        # There is no filtering in OSS, we just link to the stack list.
+        return f"{base_url}{constants.STACKS}"
 
     return None
 
@@ -96,10 +106,14 @@ def get_component_url(component: ComponentResponse) -> Optional[str]:
     Returns:
         the URL to the component if the dashboard is available, else None.
     """
+    cloud_url = get_cloud_dashboard_url()
+    if cloud_url:
+        return f"{cloud_url}{constants.STACK_COMPONENTS}/{component.id}"
+
     base_url = get_server_dashboard_url()
 
     if base_url:
-        return base_url + constants.STACKS
+        return f"{base_url}{constants.STACK_COMPONENTS}/{component.id}"
 
     return None
 
@@ -115,7 +129,7 @@ def get_run_url(run: PipelineRunResponse) -> Optional[str]:
     """
     cloud_url = get_cloud_dashboard_url()
     if cloud_url:
-        return f"{cloud_url}{constants.RUNS}/{run.id}"
+        return f"{cloud_url}{constants.PROJECTS}/{run.project.id}{constants.RUNS}/{run.id}"
 
     dashboard_url = get_server_dashboard_url()
     if dashboard_url:
@@ -124,23 +138,25 @@ def get_run_url(run: PipelineRunResponse) -> Optional[str]:
     return None
 
 
-def get_model_version_url(model_version_id: UUID) -> Optional[str]:
+def get_model_version_url(
+    model_version: ModelVersionResponse,
+) -> Optional[str]:
     """Function to get the dashboard URL of a given model version.
 
     Args:
-        model_version_id: the id of the model version.
+        model_version: the response model of the given model version.
 
     Returns:
         the URL to the model version if the dashboard is available, else None.
     """
     cloud_url = get_cloud_dashboard_url()
     if cloud_url:
-        return f"{cloud_url}/model-versions/{str(model_version_id)}"
+        return f"{cloud_url}{constants.PROJECTS}/{model_version.project.id}/model-versions/{str(model_version.id)}"
 
     return None
 
 
-def show_dashboard(url: str) -> None:
+def show_dashboard_with_url(url: str) -> None:
     """Show the ZenML dashboard at the given URL.
 
     In native environments, the dashboard is opened in the default browser.
@@ -202,3 +218,52 @@ def show_dashboard(url: str) -> None:
 
     else:
         logger.info(f"The ZenML dashboard is available at {url}.")
+
+
+def show_dashboard(
+    local: bool = False,
+    ngrok_token: Optional[str] = None,
+) -> None:
+    """Show the ZenML dashboard.
+
+    Args:
+        local: Whether to show the dashboard for the local server or the
+            one for the active server.
+        ngrok_token: An ngrok auth token to use for exposing the ZenML
+            dashboard on a public domain. Primarily used for accessing the
+            dashboard in Colab.
+
+    Raises:
+        RuntimeError: If no server is connected.
+    """
+    from zenml.utils.networking_utils import get_or_create_ngrok_tunnel
+
+    url: Optional[str] = None
+    if not local:
+        gc = GlobalConfiguration()
+        if gc.store_configuration.type == StoreType.REST:
+            url = gc.store_configuration.url
+
+    if not url:
+        # Else, check for local servers
+        server = get_local_server()
+        if server and server.status and server.status.url:
+            url = server.status.url
+
+    if not url:
+        raise RuntimeError(
+            "ZenML is not connected to any server right now. Please use "
+            "`zenml login` to connect to a server or spin up a new local server "
+            "via `zenml login --local`."
+        )
+
+    if ngrok_token:
+        parsed_url = urlparse(url)
+
+        ngrok_url = get_or_create_ngrok_tunnel(
+            ngrok_token=ngrok_token, port=parsed_url.port or 80
+        )
+        logger.debug(f"Tunneling dashboard from {url} to {ngrok_url}.")
+        url = ngrok_url
+
+    show_dashboard_with_url(url)

zenml/utils/server_utils.py

@@ -0,0 +1,52 @@
+#  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 functions for ZenML servers."""
+
+from typing import TYPE_CHECKING, Optional
+
+if TYPE_CHECKING:
+    from zenml.zen_server.deploy import LocalServerDeployment
+
+
+def get_local_server() -> Optional["LocalServerDeployment"]:
+    """Get the active local server.
+
+    Call this function to retrieve the local server deployed on this machine.
+
+    Returns:
+        The local server deployment or None, if no local server deployment was
+        found.
+    """
+    from zenml.zen_server.deploy.deployer import LocalServerDeployer
+    from zenml.zen_server.deploy.exceptions import (
+        ServerDeploymentNotFoundError,
+    )
+
+    deployer = LocalServerDeployer()
+    try:
+        return deployer.get_server()
+    except ServerDeploymentNotFoundError:
+        return None
+
+
+def connected_to_local_server() -> bool:
+    """Check if the client is connected to a local server.
+
+    Returns:
+        True if the client is connected to a local server, False otherwise.
+    """
+    from zenml.zen_server.deploy.deployer import LocalServerDeployer
+
+    deployer = LocalServerDeployer()
+    return deployer.is_connected_to_server()

zenml/zen_server/dashboard/assets/{404-BbAvjc7Z.js → 404-2I8egBQu.js}

@@ -1 +1 @@
-import{j as e}from"./@radix-AvWw-1nd.js";import{f as s,r as t}from"./index-DWoLoYDY.js";import{E as r}from"./EmptyState-DpbfQBDE.js";import{S as a}from"./help-CfT0tY2I.js";import{L as o}from"./@react-router-BUo5vhN4.js";import"./@tanstack-CcI3lvwB.js";import"./@reactflow-DMaYqp8l.js";function d(){return e.jsx("div",{className:"flex min-h-screen w-full flex-col",children:e.jsx(r,{icon:e.jsx(a,{className:"h-[120px] w-[120px] fill-neutral-300"}),children:e.jsxs("div",{className:"text-center",children:[e.jsx("h1",{className:"mb-2 text-display-xs font-semibold",children:"We can't find the page you are looking for"}),e.jsx("p",{className:"text-lg text-theme-text-secondary",children:"You can try typing a different URL or we can bring you back to your Homepage."}),e.jsx("div",{className:"mt-5 flex justify-center",children:e.jsx(s,{size:"md",asChild:!0,children:e.jsx(o,{className:"w-min self-center whitespace-nowrap",to:t.home,children:e.jsx("span",{className:"px-0.5",children:"Go to Home"})})})})]})})})}export{d as default};
+import{j as e}from"./@radix-AvWw-1nd.js";import{h as s,r as t}from"./index-DPjvk73v.js";import{E as r}from"./EmptyState-DpbfQBDE.js";import{S as a}from"./help-CfT0tY2I.js";import{L as o}from"./@react-router-BUo5vhN4.js";import"./@tanstack-CcI3lvwB.js";import"./@reactflow-BHoFKFSZ.js";function d(){return e.jsx("div",{className:"flex min-h-screen w-full flex-col",children:e.jsx(r,{icon:e.jsx(a,{className:"h-[120px] w-[120px] fill-neutral-300"}),children:e.jsxs("div",{className:"text-center",children:[e.jsx("h1",{className:"mb-2 text-display-xs font-semibold",children:"We can't find the page you are looking for"}),e.jsx("p",{className:"text-lg text-theme-text-secondary",children:"You can try typing a different URL or we can bring you back to your Homepage."}),e.jsx("div",{className:"mt-5 flex justify-center",children:e.jsx(s,{size:"md",asChild:!0,children:e.jsx(o,{className:"w-min self-center whitespace-nowrap",to:t.home,children:e.jsx("span",{className:"px-0.5",children:"Go to Home"})})})})]})})})}export{d as default};