zenml-nightly 0.57.1.dev20240523__py3-none-any.whl → 0.58.0.dev20240528__py3-none-any.whl

zenml/zen_server/deploy/helm/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: zenml
-version: "0.57.1"
+version: "0.58.0"
 description: Open source MLOps framework for portable production ready ML pipelines
 keywords:
 - mlops

zenml/zen_server/deploy/helm/README.md

@@ -20,8 +20,8 @@ ZenML is an open-source MLOps framework designed to help you create robust, main
 To install the ZenML chart directly from Amazon ECR, use the following command:
 
 ```bash
-# example command for version 0.57.1
-helm install my-zenml oci://public.ecr.aws/zenml/zenml --version 0.57.1
+# example command for version 0.58.0
+helm install my-zenml oci://public.ecr.aws/zenml/zenml --version 0.58.0
 ```
 
 Note: Ensure you have OCI support enabled in your Helm client and that you are authenticated with Amazon ECR.

zenml/zen_server/deploy/helm/templates/_environment.tpl

@@ -58,9 +58,6 @@ device_auth_timeout: {{ .ZenML.auth.deviceAuthTimeout | quote }}
 {{- if .ZenML.auth.deviceAuthPollingInterval }}
 device_auth_polling_interval: {{ .ZenML.auth.deviceAuthPollingInterval | quote }}
 {{- end }}
-{{- if .ZenML.auth.dashboardURL }}
-dashboard_url: {{ .ZenML.auth.dashboardURL | quote }}
-{{- end }}
 {{- if .ZenML.auth.deviceExpirationMinutes }}
 device_expiration_minutes: {{ .ZenML.auth.deviceExpirationMinutes | quote }}
 {{- end }}
@@ -82,8 +79,11 @@ external_server_id: {{ .ZenML.auth.externalServerID | quote }}
 {{- if .ZenML.rootUrlPath }}
 root_url_path: {{ .ZenML.rootUrlPath | quote }}
 {{- end }}
-{{- if .ZenML.baseURL }}
-base_url: {{ .ZenML.baseURL | quote }}
+{{- if .ZenML.serverURL }}
+server_url: {{ .ZenML.serverURL | quote }}
+{{- end }}
+{{- if .ZenML.dashboardURL }}
+dashboard_url: {{ .ZenML.dashboardURL | quote }}
 {{- end }}
 {{- if .ZenML.auth.rbacImplementationSource }}
 rbac_implementation_source: {{ .ZenML.auth.rbacImplementationSource | quote }}

zenml/zen_server/deploy/helm/values.yaml

@@ -16,9 +16,19 @@ zenml:
     # Overrides the image tag whose default is the chart appVersion.
     tag:
 
-  # The URL of the ZenML server. This is used to direct users to the correct
-  # address in log messages when running a pipeline and for other similar tasks.
-  baseURL:
+  # The URL where the ZenML server API is reachable. If not specified, the
+  # clients will use the same URL used to connect them to the ZenML server.
+  serverURL:
+
+  # The URL where the ZenML dashboard is reachable.
+  # If not specified, the `serverURL` value is used. This should be
+  # configured if the dashboard is served from a different URL than the
+  # ZenML server.
+  #
+  # This is value is used to compute the dashboard URLs during the web login
+  # authentication workflow, to print dashboard URLs in log messages when
+  # running a pipeline and for other similar tasks.
+  dashboardURL:
 
   debug: true
 
@@ -112,12 +122,6 @@ zenml:
     # authorization request.
     deviceAuthPollingInterval: 5
 
-    # The URL where the ZenML dashboard is hosted. Used to construct the OAuth
-    # 2.0 device authorization endpoint. If not set, a partial URL is returned
-    # to the client which is used to construct the full URL based on the
-    # server's root URL path.
-    dashboardURL:
-
     # The time in minutes that an OAuth 2.0 device is allowed to be used to
     # authenticate with the ZenML server. If not set or if
     # `zenml.auth.jwtTokenExpireMinutes` is not set, the devices are allowed to

zenml/zen_server/pipeline_deployment/utils.py

@@ -58,6 +58,7 @@ def run_pipeline(
     Raises:
         ValueError: If the deployment does not have an associated stack or
             build.
+        RuntimeError: If the server URL is not set in the server configuration.
 
     Returns:
         ID of the new pipeline run.
@@ -87,8 +88,11 @@ def run_pipeline(
         assert auth_context.access_token
         api_token = auth_context.access_token.encode()
 
-    server_url = server_config().dashboard_url
-    assert server_url
+    server_url = server_config().server_url
+    if not server_url:
+        raise RuntimeError(
+            "The server URL is not set in the server configuration"
+        )
     assert build.zenml_version
     zenml_version = build.zenml_version
 

zenml/zen_server/routers/auth_endpoints.py

@@ -458,10 +458,10 @@ def device_authorization(
             ),
         )
 
-    if config.dashboard_url:
-        verification_uri = (
-            config.dashboard_url.lstrip("/") + DEVICES + DEVICE_VERIFY
-        )
+    dashboard_url = config.dashboard_url or config.server_url
+
+    if dashboard_url:
+        verification_uri = dashboard_url.lstrip("/") + DEVICES + DEVICE_VERIFY
     else:
         verification_uri = DEVICES + DEVICE_VERIFY
 

zenml/zen_server/zen_server_api.py

@@ -15,6 +15,7 @@
 
 import os
 from asyncio.log import logger
+from genericpath import isfile
 from typing import Any, List
 
 from fastapi import FastAPI, HTTPException, Request
@@ -22,7 +23,6 @@ from fastapi.exceptions import RequestValidationError
 from fastapi.responses import ORJSONResponse
 from fastapi.staticfiles import StaticFiles
 from fastapi.templating import Jinja2Templates
-from genericpath import isfile
 from starlette.middleware.cors import CORSMiddleware
 from starlette.responses import FileResponse
 

zenml/zen_stores/base_zen_store.py

@@ -375,7 +375,6 @@ class BaseZenStore(
         server_config = ServerConfiguration.get_server_config()
         deployment_type = server_config.deployment_type
         auth_scheme = server_config.auth_scheme
-        base_url = server_config.base_url
         metadata = server_config.metadata
         secrets_store_type = SecretsStoreType.NONE
         if isinstance(self, SqlZenStore) and self.config.secrets_store:
@@ -390,7 +389,8 @@ class BaseZenStore(
             debug=IS_DEBUG_ENV,
             secrets_store_type=secrets_store_type,
             auth_scheme=auth_scheme,
-            base_url=base_url,
+            server_url=server_config.server_url or "",
+            dashboard_url=server_config.dashboard_url or "",
             analytics_enabled=GlobalConfiguration().analytics_opt_in,
             metadata=metadata,
             use_legacy_dashboard=use_legacy_dashboard,

zenml/zen_stores/migrations/versions/0.58.0_release.py

@@ -0,0 +1,23 @@
+"""Release [0.58.0].
+
+Revision ID: 0.58.0
+Revises: 0.57.1
+Create Date: 2024-05-27 15:22:16.565094
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = "0.58.0"
+down_revision = "0.57.1"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    """Upgrade database schema and/or data, creating a new revision."""
+    pass
+
+
+def downgrade() -> None:
+    """Downgrade database schema and/or data back to the previous revision."""
+    pass

zenml/zen_stores/schemas/artifact_schemas.py

@@ -315,11 +315,17 @@ class ArtifactVersionSchema(BaseSchema, table=True):
 
         producer_step_run_id, producer_pipeline_run_id = None, None
         if self.output_of_step_runs:
-            step_run = self.output_of_step_runs[0].step_run
-            if step_run.status == ExecutionStatus.COMPLETED:
+            original_step_runs = [
+                sr
+                for sr in self.output_of_step_runs
+                if sr.step_run.status == ExecutionStatus.COMPLETED
+            ]
+            if len(original_step_runs) == 1:
+                step_run = original_step_runs[0].step_run
                 producer_step_run_id = step_run.id
                 producer_pipeline_run_id = step_run.pipeline_run_id
             else:
+                step_run = self.output_of_step_runs[0].step_run
                 producer_step_run_id = step_run.original_step_run_id
 
         # Create the body of the model
@@ -348,10 +354,13 @@ class ArtifactVersionSchema(BaseSchema, table=True):
                 run_metadata={m.key: m.to_model() for m in self.run_metadata},
             )
 
+        resources = None
+
         return ArtifactVersionResponse(
             id=self.id,
             body=body,
             metadata=metadata,
+            resources=resources,
         )
 
     def update(

zenml/zen_stores/schemas/pipeline_run_schemas.py

@@ -30,6 +30,7 @@ from zenml.models import (
     PipelineRunResponseMetadata,
     PipelineRunUpdate,
 )
+from zenml.models.v2.core.pipeline_run import PipelineRunResponseResources
 from zenml.zen_stores.schemas.base_schemas import NamedSchema
 from zenml.zen_stores.schemas.pipeline_build_schemas import PipelineBuildSchema
 from zenml.zen_stores.schemas.pipeline_deployment_schemas import (
@@ -310,11 +311,22 @@ class PipelineRunSchema(NamedSchema, table=True):
                 orchestrator_environment=orchestrator_environment,
                 orchestrator_run_id=self.orchestrator_run_id,
             )
+
+        resources = None
+        if include_resources:
+            model_version = None
+            if config.model and config.model.model_version_id:
+                model_version = config.model._get_model_version(hydrate=False)
+            resources = PipelineRunResponseResources(
+                model_version=model_version
+            )
+
         return PipelineRunResponse(
             id=self.id,
             name=self.name,
             body=body,
             metadata=metadata,
+            resources=resources,
         )
 
     def update(self, run_update: "PipelineRunUpdate") -> "PipelineRunSchema":

zenml/zen_stores/schemas/step_run_schemas.py

@@ -37,6 +37,7 @@ from zenml.models import (
     StepRunResponseMetadata,
     StepRunUpdate,
 )
+from zenml.models.v2.core.step_run import StepRunResponseResources
 from zenml.zen_stores.schemas.base_schemas import NamedSchema
 from zenml.zen_stores.schemas.pipeline_deployment_schemas import (
     PipelineDeploymentSchema,
@@ -207,7 +208,9 @@ class StepRunSchema(NamedSchema, table=True):
         }
 
         output_artifacts = {
-            artifact.name: artifact.artifact_version.to_model()
+            artifact.name: artifact.artifact_version.to_model(
+                pipeline_run_id_in_context=self.pipeline_run_id
+            )
             for artifact in self.output_artifacts
         }
 
@@ -250,11 +253,24 @@ class StepRunSchema(NamedSchema, table=True):
                 parent_step_ids=[p.parent_id for p in self.parents],
                 run_metadata=run_metadata,
             )
+
+        resources = None
+        if include_resources:
+            model_version = None
+            if full_step_config.config.model:
+                model_version = (
+                    full_step_config.config.model._get_model_version(
+                        hydrate=False
+                    )
+                )
+            resources = StepRunResponseResources(model_version=model_version)
+
         return StepRunResponse(
             id=self.id,
             name=self.name,
             body=body,
             metadata=metadata,
+            resources=resources,
         )
 
     def update(self, step_update: "StepRunUpdate") -> "StepRunSchema":

zenml/zen_stores/sql_zen_store.py

@@ -2462,7 +2462,9 @@ class SqlZenStore(BaseZenStore):
                     f"{artifact_version_id}: No artifact version with this ID "
                     f"found."
                 )
-            return artifact_version.to_model(include_metadata=hydrate)
+            return artifact_version.to_model(
+                include_metadata=hydrate, include_resources=hydrate
+            )
 
     def list_artifact_versions(
         self,
@@ -4336,7 +4338,7 @@ class SqlZenStore(BaseZenStore):
         with Session(self.engine) as session:
             return self._get_run_schema(
                 run_name_or_id, session=session
-            ).to_model(include_metadata=hydrate)
+            ).to_model(include_metadata=hydrate, include_resources=hydrate)
 
     def _replace_placeholder_run(
         self,
@@ -6938,7 +6940,7 @@ class SqlZenStore(BaseZenStore):
             ).first()
             if run is None:
                 raise KeyError(
-                    f"Unable to create step '{step_run.name}': No pipeline run "
+                    f"Unable to create step `{step_run.name}`: No pipeline run "
                     f"with ID '{step_run.pipeline_run_id}' found."
                 )
 
@@ -6952,7 +6954,7 @@ class SqlZenStore(BaseZenStore):
             ).first()
             if existing_step_run is not None:
                 raise EntityExistsError(
-                    f"Unable to create step '{step_run.name}': A step with "
+                    f"Unable to create step `{step_run.name}`: A step with "
                     f"this name already exists in the pipeline run with ID "
                     f"'{step_run.pipeline_run_id}'."
                 )
@@ -7032,7 +7034,9 @@ class SqlZenStore(BaseZenStore):
                     f"Unable to get step run with ID {step_run_id}: No step "
                     "run with this ID found."
                 )
-            return step_run.to_model(include_metadata=hydrate)
+            return step_run.to_model(
+                include_metadata=hydrate, include_resources=hydrate
+            )
 
     def list_run_steps(
         self,

{zenml_nightly-0.57.1.dev20240523.dist-info → zenml_nightly-0.58.0.dev20240528.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zenml-nightly
-Version: 0.57.1.dev20240523
+Version: 0.58.0.dev20240528
 Summary: ZenML: Write production-ready ML code.
 Home-page: https://zenml.io
 License: Apache-2.0
@@ -88,8 +88,8 @@ Requires-Dist: psutil (>=5.0.0)
 Requires-Dist: pydantic (>=1.9.0,<1.11)
 Requires-Dist: pyjwt[crypto] (==2.7.*) ; extra == "server"
 Requires-Dist: pyment (>=0.3.3,<0.4.0) ; extra == "dev"
-Requires-Dist: pymysql (>=1.0.2,<1.1.0)
-Requires-Dist: pyparsing (>=2.4.0,<3)
+Requires-Dist: pymysql (>=1.1.1,<1.2.0)
+Requires-Dist: pyparsing (>=2.4.0)
 Requires-Dist: pytest (>=7.4.0,<8.0.0) ; extra == "dev"
 Requires-Dist: pytest-clarity (>=1.0.1,<2.0.0) ; extra == "dev"
 Requires-Dist: pytest-instafail (>=0.5.0) ; extra == "dev"
@@ -426,7 +426,7 @@ the Apache License Version 2.0.
     <a href="https://github.com/zenml-io/zenml-projects">Projects Showcase</a>
     <br />
     <br />
-    🎉 Version 0.57.1 is out. Check out the release notes
+    🎉 Version 0.58.0 is out. Check out the release notes
     <a href="https://github.com/zenml-io/zenml/releases">here</a>.
     <br />
     🖥️ Download our VS Code Extension <a href="https://marketplace.visualstudio.com/items?itemName=ZenML.zenml-vscode">here</a>.