zenml-nightly 0.61.0.dev20240712__py3-none-any.whl → 0.62.0.dev20240726__py3-none-any.whl

zenml/stack_deployments/azure_stack_deployment.py

@@ -0,0 +1,179 @@
+#  Copyright (c) ZenML GmbH 2024. 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.
+"""Functionality to deploy a ZenML stack to Azure."""
+
+import re
+from typing import ClassVar, Dict, List
+
+from zenml.enums import StackDeploymentProvider
+from zenml.stack_deployments.stack_deployment import ZenMLCloudStackDeployment
+
+
+# TODO: this class just implements the regions list, and is not suitable for other
+# deployment tasks.
+class AZUREZenMLCloudStackDeployment(ZenMLCloudStackDeployment):
+    """Azure ZenML Cloud Stack Deployment."""
+
+    provider: ClassVar[StackDeploymentProvider] = StackDeploymentProvider.AZURE
+
+    @classmethod
+    def description(cls) -> str:
+        """Return a description of the ZenML Cloud Stack Deployment.
+
+        This will be displayed when the user is prompted to deploy
+        the ZenML stack.
+
+        Returns:
+            A MarkDown description of the ZenML Cloud Stack Deployment.
+        """
+        # TODO: Implement this
+        return ""
+
+    @classmethod
+    def instructions(cls) -> str:
+        """Return instructions on how to deploy the ZenML stack to the specified cloud provider.
+
+        This will be displayed before the user is prompted to deploy the ZenML
+        stack.
+
+        Returns:
+            MarkDown instructions on how to deploy the ZenML stack to the
+            specified cloud provider.
+        """
+        # TODO: Implement this
+        return ""
+
+    @classmethod
+    def post_deploy_instructions(cls) -> str:
+        """Return instructions on what to do after the deployment is complete.
+
+        This will be displayed after the deployment is complete.
+
+        Returns:
+            MarkDown instructions on what to do after the deployment is
+            complete.
+        """
+        # TODO: Implement this
+        return ""
+
+    @classmethod
+    def integrations(cls) -> List[str]:
+        """Return the ZenML integrations required for the stack.
+
+        Returns:
+            The list of ZenML integrations that need to be installed for the
+            stack to be usable.
+        """
+        return ["azure"]
+
+    @classmethod
+    def permissions(cls) -> Dict[str, List[str]]:
+        """Return the permissions granted to ZenML to access the cloud resources.
+
+        Returns:
+            The permissions granted to ZenML to access the cloud resources, as
+            a dictionary grouping permissions by resource.
+        """
+        # TODO: Implement this
+        return {}
+
+    @classmethod
+    def locations(cls) -> Dict[str, str]:
+        """Return the locations where the ZenML stack can be deployed.
+
+        Returns:
+            The regions where the ZenML stack can be deployed as a map of region
+            names to region descriptions.
+        """
+        # Based on `az account list-locations -o table` on 16.07.2024
+        return {
+            "(US) East US": "eastus",
+            "(US) South Central US": "southcentralus",
+            "(US) West US 2": "westus2",
+            "(US) West US 3": "westus3",
+            "(Asia Pacific) Australia East": "australiaeast",
+            "(Asia Pacific) Southeast Asia": "southeastasia",
+            "(Europe) North Europe": "northeurope",
+            "(Europe) Sweden Central": "swedencentral",
+            "(Europe) UK South": "uksouth",
+            "(Europe) West Europe": "westeurope",
+            "(US) Central US": "centralus",
+            "(Africa) South Africa North": "southafricanorth",
+            "(Asia Pacific) Central India": "centralindia",
+            "(Asia Pacific) East Asia": "eastasia",
+            "(Asia Pacific) Japan East": "japaneast",
+            "(Asia Pacific) Korea Central": "koreacentral",
+            "(Canada) Canada Central": "canadacentral",
+            "(Europe) France Central": "francecentral",
+            "(Europe) Germany West Central": "germanywestcentral",
+            "(Europe) Italy North": "italynorth",
+            "(Europe) Norway East": "norwayeast",
+            "(Europe) Poland Central": "polandcentral",
+            "(Europe) Spain Central": "spaincentral",
+            "(Europe) Switzerland North": "switzerlandnorth",
+            "(Mexico) Mexico Central": "mexicocentral",
+            "(Middle East) UAE North": "uaenorth",
+            "(South America) Brazil South": "brazilsouth",
+            "(Middle East) Israel Central": "israelcentral",
+            "(Middle East) Qatar Central": "qatarcentral",
+            "(US) Central US (Stage)": "centralusstage",
+            "(US) East US (Stage)": "eastusstage",
+            "(US) East US 2 (Stage)": "eastus2stage",
+            "(US) North Central US (Stage)": "northcentralusstage",
+            "(US) South Central US (Stage)": "southcentralusstage",
+            "(US) West US (Stage)": "westusstage",
+            "(US) West US 2 (Stage)": "westus2stage",
+            "(Asia Pacific) East Asia (Stage)": "eastasiastage",
+            "(Asia Pacific) Southeast Asia (Stage)": "southeastasiastage",
+            "(South America) Brazil US": "brazilus",
+            "(US) East US 2": "eastus2",
+            "(US) East US STG": "eastusstg",
+            "(US) North Central US": "northcentralus",
+            "(US) West US": "westus",
+            "(Asia Pacific) Japan West": "japanwest",
+            "(Asia Pacific) Jio India West": "jioindiawest",
+            "(US) Central US EUAP": "centraluseuap",
+            "(US) East US 2 EUAP": "eastus2euap",
+            "(US) West Central US": "westcentralus",
+            "(Africa) South Africa West": "southafricawest",
+            "(Asia Pacific) Australia Central": "australiacentral",
+            "(Asia Pacific) Australia Central 2": "australiacentral2",
+            "(Asia Pacific) Australia Southeast": "australiasoutheast",
+            "(Asia Pacific) Jio India Central": "jioindiacentral",
+            "(Asia Pacific) Korea South": "koreasouth",
+            "(Asia Pacific) South India": "southindia",
+            "(Asia Pacific) West India": "westindia",
+            "(Canada) Canada East": "canadaeast",
+            "(Europe) France South": "francesouth",
+            "(Europe) Germany North": "germanynorth",
+            "(Europe) Norway West": "norwaywest",
+            "(Europe) Switzerland West": "switzerlandwest",
+            "(Europe) UK West": "ukwest",
+            "(Middle East) UAE Central": "uaecentral",
+            "(South America) Brazil Southeast": "brazilsoutheast",
+        }
+
+    @classmethod
+    def skypilot_default_regions(cls) -> Dict[str, str]:
+        """Returns the regions supported by default for the Skypilot.
+
+        Returns:
+            The regions supported by default for the Skypilot.
+        """
+        matcher = re.compile(r".*us\d*( |$)")
+        return {
+            k: v
+            for k, v in cls.locations().items()
+            if "(US)" in k and matcher.match(v)
+        }

zenml/stack_deployments/gcp_stack_deployment.py

@@ -13,6 +13,7 @@
 #  permissions and limitations under the License.
 """Functionality to deploy a ZenML stack to GCP."""
 
+import re
 from typing import ClassVar, Dict, List
 
 from zenml.enums import StackDeploymentProvider
@@ -208,6 +209,16 @@ GCP project and to clean up the resources created by the stack by using
             "US West (Las Vegas)": "us-west4",
         }
 
+    @classmethod
+    def skypilot_default_regions(cls) -> Dict[str, str]:
+        """Returns the regions supported by default for the Skypilot.
+
+        Returns:
+            The regions supported by default for the Skypilot.
+        """
+        matcher = re.compile(r"us-.*")
+        return {k: v for k, v in cls.locations().items() if matcher.match(v)}
+
     def get_deployment_config(
         self,
     ) -> StackDeploymentConfig:
@@ -236,8 +247,6 @@ GCP project and to clean up the resources created by the stack by using
             cloudshell_open_in_editor="gcp-gar-gcs-vertex.jinja,gcp-gar-gcs-vertex-deploy.sh",
             cloudshell_tutorial="gcp-gar-gcs-vertex.md",
             ephemeral="true",
-            # TODO: remove this before the branch is merged
-            cloudshell_git_branch="feature/prd-482-gcp-stack-deployment",
         )
         # Encode the parameters as URL query parameters
         query_params = "&".join([f"{k}={v}" for k, v in params.items()])
@@ -251,8 +260,8 @@ ZENML_STACK_NAME={self.stack_name}
 ZENML_STACK_REGION={self.location or "europe-west3"}
 ZENML_SERVER_URL={self.zenml_server_url}
 ZENML_SERVER_API_TOKEN={self.zenml_server_api_token}
-### END CONFIGURATION ###
-"""
+### END CONFIGURATION ###"""
+
         return StackDeploymentConfig(
             deployment_url=url,
             deployment_url_text="GCP Cloud Shell Console",

zenml/stack_deployments/stack_deployment.py

@@ -105,6 +105,15 @@ class ZenMLCloudStackDeployment(BaseModel):
             names to region descriptions.
         """
 
+    @classmethod
+    def skypilot_default_regions(cls) -> Dict[str, str]:
+        """Returns the regions supported by default for the Skypilot.
+
+        Returns:
+            The regions supported by default for the Skypilot.
+        """
+        return cls.locations()
+
     @classmethod
     def get_deployment_info(cls) -> StackDeploymentInfo:
         """Return information about the ZenML Cloud Stack Deployment.
@@ -120,6 +129,7 @@ class ZenMLCloudStackDeployment(BaseModel):
             integrations=cls.integrations(),
             permissions=cls.permissions(),
             locations=cls.locations(),
+            skypilot_default_regions=cls.skypilot_default_regions(),
         )
 
     @abstractmethod

zenml/stack_deployments/utils.py

@@ -19,6 +19,9 @@ from zenml.enums import StackDeploymentProvider
 from zenml.stack_deployments.aws_stack_deployment import (
     AWSZenMLCloudStackDeployment,
 )
+from zenml.stack_deployments.azure_stack_deployment import (
+    AZUREZenMLCloudStackDeployment,
+)
 from zenml.stack_deployments.gcp_stack_deployment import (
     GCPZenMLCloudStackDeployment,
 )
@@ -27,6 +30,7 @@ from zenml.stack_deployments.stack_deployment import ZenMLCloudStackDeployment
 STACK_DEPLOYMENT_PROVIDERS = {
     StackDeploymentProvider.AWS: AWSZenMLCloudStackDeployment,
     StackDeploymentProvider.GCP: GCPZenMLCloudStackDeployment,
+    StackDeploymentProvider.AZURE: AZUREZenMLCloudStackDeployment,
 }
 
 

zenml/steps/base_step.py

@@ -479,7 +479,7 @@ class BaseStep(metaclass=BaseStepMeta):
             bound_args = signature.bind_partial(*args, **kwargs)
         except TypeError as e:
             raise StepInterfaceError(
-                f"Wrong arguments when calling step `{self.name}`: {e}"
+                f"Wrong arguments when calling step '{self.name}': {e}"
             ) from e
 
         artifacts = {}
@@ -980,7 +980,7 @@ class BaseStep(metaclass=BaseStepMeta):
                 )
         if conflicting_parameters:
             is_plural = "s" if len(conflicting_parameters) > 1 else ""
-            msg = f"Configured parameter{is_plural} for the step `{self.name}` conflict{'' if not is_plural else 's'} with parameter{is_plural} passed in runtime:\n"
+            msg = f"Configured parameter{is_plural} for the step '{self.name}' conflict{'' if not is_plural else 's'} with parameter{is_plural} passed in runtime:\n"
             for key, values in conflicting_parameters.items():
                 msg += (
                     f"`{key}`: config=`{values[0]}` | runtime=`{values[1]}`\n"
@@ -1023,7 +1023,7 @@ To avoid this consider setting step parameters only in one place (config or code
             if output_name not in allowed_output_names:
                 raise StepInterfaceError(
                     f"Got unexpected materializers for non-existent "
-                    f"output '{output_name}' in step `{self.name}`. "
+                    f"output '{output_name}' in step '{self.name}'. "
                     f"Only materializers for the outputs "
                     f"{allowed_output_names} of this step can"
                     f" be registered."
@@ -1036,7 +1036,7 @@ To avoid this consider setting step parameters only in one place (config or code
                     ):
                         raise StepInterfaceError(
                             f"Materializer source `{source}` "
-                            f"for output '{output_name}' of step `{self.name}` "
+                            f"for output '{output_name}' of step '{self.name}' "
                             "does not resolve to a `BaseMaterializer` subclass."
                         )
 
@@ -1070,7 +1070,9 @@ To avoid this consider setting step parameters only in one place (config or code
                 or key in client_lazy_loaders
             ):
                 continue
-            raise StepInterfaceError(f"Missing entrypoint input {key}.")
+            raise StepInterfaceError(
+                f"Missing entrypoint input '{key}' in step '{self.name}'."
+            )
 
     def _finalize_configuration(
         self,

zenml/utils/function_utils.py

@@ -107,7 +107,7 @@ def _is_valid_optional_arg(arg_type: Any) -> bool:
             if (
                 args[0] not in _ALLOWED_TYPES
                 and not _is_valid_collection_arg(args[0])
-            ) or args[1] != type(None):
+            ) or args[1] is not type(None):
                 return False
         return True
     return False

zenml/utils/pipeline_docker_image_builder.py

@@ -297,6 +297,14 @@ class PipelineDockerImageBuilder:
             if docker_settings.install_stack_requirements:
                 apt_packages += stack.apt_packages
 
+            # include apt packages from all required integrations
+            for integration in docker_settings.required_integrations:
+                # get the integration
+                integration_cls = integration_registry.integrations[
+                    integration
+                ]
+                apt_packages += integration_cls.APT_PACKAGES
+
             if apt_packages:
                 logger.info(
                     "Including apt packages: %s",

zenml/utils/source_utils.py

@@ -38,6 +38,7 @@ from zenml.config.source import (
     Source,
     SourceType,
 )
+from zenml.constants import ENV_ZENML_CUSTOM_SOURCE_ROOT
 from zenml.environment import Environment
 from zenml.logger import get_logger
 
@@ -57,7 +58,9 @@ BuiltinFunctionTypeSource = Source(
     type=SourceType.BUILTIN,
 )
 
-_CUSTOM_SOURCE_ROOT: Optional[str] = None
+_CUSTOM_SOURCE_ROOT: Optional[str] = os.getenv(
+    ENV_ZENML_CUSTOM_SOURCE_ROOT, None
+)
 
 
 def load(source: Union[Source, str]) -> Any:

zenml/zen_server/dashboard/assets/{404-DpJaNHKF.js → 404-B_YdvmwS.js}

@@ -1 +1 @@
-import{j as e}from"./@radix-CFOkMR_E.js";import{h as s,r as t}from"./index-DK1ynKjA.js";import{E as r}from"./EmptyState-BMLnFVlB.js";import{H as a}from"./help-bu_DgLKI.js";import{L as o}from"./@react-router-CO-OsFwI.js";import"./@tanstack-DYiOyJUL.js";import"./@reactflow-DJfzkHO1.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-CFOkMR_E.js";import{h as s,r as t}from"./index-BczVOqUf.js";import{E as r}from"./EmptyState-BMLnFVlB.js";import{H as a}from"./help-bu_DgLKI.js";import{L as o}from"./@react-router-CO-OsFwI.js";import"./@tanstack-DYiOyJUL.js";import"./@reactflow-l_1hUr1S.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};