zenml-nightly 0.65.0.dev20240906__py3-none-any.whl → 0.66.0.dev20240913__py3-none-any.whl

README.md

@@ -327,7 +327,7 @@ the Apache License Version 2.0.
     <a href="https://github.com/zenml-io/zenml-projects">Projects Showcase</a>
     <br />
     <br />
-    🎉 Version 0.65.0 is out. Check out the release notes
+    🎉 Version 0.66.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>.

RELEASE_NOTES.md

@@ -1,5 +1,63 @@
 <!-- markdown-link-check-disable -->
 
+# 0.66.0
+
+## New Features and Improvements
+
+### Python 3.12 support
+
+This release adds support for Python 3.12, which means you can now develop your ZenML pipelines
+with the latest python features.
+
+### Easier way to specify component settings
+
+Before this release, settings for stack components had to be specified with both the component type
+as well as the flavor. We simplified this and it is now possible to specify settings just using the
+component type:
+```python
+# Before
+@pipeline(settings={"orchestrator.sagemaker": SagemakerOrchestratorSettings(...)})
+def my_pipeline():
+  ...
+
+# Now
+@pipeline(settings={"orchestrator": SagemakerOrchestratorSettings(...)})
+def my_pipeline():
+  ...
+```
+
+## Breaking changes
+
+* In order to slim down the ZenML library, we removed the `numpy` and `pandas` libraries as dependencies of ZenML. If your
+code uses these libraries, you have to make sure they're installed in your local environment as well as the Docker images that
+get built to run your pipelines (Use `DockerSettings.requirements` or `DockerSettings.required_integrations`).
+
+## What's Changed
+* Add 0.65.0 to migration testing by @avishniakov in https://github.com/zenml-io/zenml/pull/2963
+* Hotfix for release flow by @avishniakov in https://github.com/zenml-io/zenml/pull/2961
+* Fix the one-click AWS and GCP stack deployments by @stefannica in https://github.com/zenml-io/zenml/pull/2964
+* Fix wandb mypy error by @strickvl in https://github.com/zenml-io/zenml/pull/2967
+* Fix accelerate docs for 0.65.0+ by @avishniakov in https://github.com/zenml-io/zenml/pull/2968
+* Dynamic model version names docs by @avishniakov in https://github.com/zenml-io/zenml/pull/2970
+* Logging nits by @avishniakov in https://github.com/zenml-io/zenml/pull/2972
+* Fix excess Azure logging by @strickvl in https://github.com/zenml-io/zenml/pull/2965
+* Fix typo in docs by @strickvl in https://github.com/zenml-io/zenml/pull/2976
+* Pass code path to template run by @schustmi in https://github.com/zenml-io/zenml/pull/2973
+* Prevent extra attributes in component configs by @schustmi in https://github.com/zenml-io/zenml/pull/2978
+* Dependency cleanup and Python 3.12 support by @bcdurak in https://github.com/zenml-io/zenml/pull/2953
+* Few nits in docs based on integrations review by @avishniakov in https://github.com/zenml-io/zenml/pull/2983
+* Update slack alerter docs by @stefannica in https://github.com/zenml-io/zenml/pull/2981
+* Update Kubeflow orchestrator docs by @stefannica in https://github.com/zenml-io/zenml/pull/2985
+* Build docker images for python 3.12 by @schustmi in https://github.com/zenml-io/zenml/pull/2988
+* Allow shortcut keys for component settings by @schustmi in https://github.com/zenml-io/zenml/pull/2957
+* Remove references to workspaces from docs by @strickvl in https://github.com/zenml-io/zenml/pull/2991
+* Added some adjustments for colab by @AlexejPenner in https://github.com/zenml-io/zenml/pull/2966
+* Reverting the installation of `mlstacks` after its new release by @bcdurak in https://github.com/zenml-io/zenml/pull/2980
+* Small dependency and docs updates by @strickvl in https://github.com/zenml-io/zenml/pull/2982
+
+
+**Full Changelog**: https://github.com/zenml-io/zenml/compare/0.65.0...0.66.0
+
 # 0.65.0
 
 ## New Features and Improvements

zenml/VERSION

@@ -1 +1 @@
-0.65.0.dev20240906
+0.66.0.dev20240913

zenml/cli/service_accounts.py

@@ -35,6 +35,7 @@ def _create_api_key(
     name: str,
     description: Optional[str],
     set_key: bool = False,
+    output_file: Optional[str] = None,
 ) -> None:
     """Create an API key.
 
@@ -44,6 +45,7 @@ def _create_api_key(
         name: Name of the API key
         description: The API key description.
         set_key: Configure the local client with the generated key.
+        output_file: Output file to write the API key to.
     """
     client = Client()
     zen_store = client.zen_store
@@ -74,13 +76,19 @@ def _create_api_key(
             )
             return
 
-    cli_utils.declare(
-        f"The API key value is: '{api_key.key}'\nPlease store it safely as "
-        "it will not be shown again.\nTo configure a ZenML client to use "
-        "this API key, run:\n\n"
-        f"zenml connect --url {zen_store.config.url} --api-key \\\n"
-        f"    '{api_key.key}'\n"
-    )
+    if output_file and api_key.key:
+        with open(output_file, "w") as f:
+            f.write(api_key.key)
+
+        cli_utils.declare(f"Wrote API key value to {output_file}")
+    else:
+        cli_utils.declare(
+            f"The API key value is: '{api_key.key}'\nPlease store it safely as "
+            "it will not be shown again.\nTo configure a ZenML client to use "
+            "this API key, run:\n\n"
+            f"zenml connect --url {zen_store.config.url} --api-key \\\n"
+            f"    '{api_key.key}'\n"
+        )
 
 
 @cli.group(cls=TagGroup, tag=CliCategories.IDENTITY_AND_SECURITY)
@@ -111,11 +119,18 @@ def service_account() -> None:
     help=("Configure the local client to use the generated API key."),
     is_flag=True,
 )
+@click.option(
+    "--output-file",
+    type=str,
+    required=False,
+    help="File to write the API key to.",
+)
 def create_service_account(
     service_account_name: str,
     description: str = "",
     create_api_key: bool = True,
     set_api_key: bool = False,
+    output_file: Optional[str] = None,
 ) -> None:
     """Create a new service account.
 
@@ -124,6 +139,7 @@ def create_service_account(
         description: The API key description.
         create_api_key: Create an API key for the service account.
         set_api_key: Configure the local client to use the generated API key.
+        output_file: Output file to write the API key to.
     """
     client = Client()
     try:
@@ -142,6 +158,7 @@ def create_service_account(
             name="default",
             description="Default API key.",
             set_key=set_api_key,
+            output_file=output_file,
         )
 
 
@@ -302,12 +319,19 @@ def api_key(
     is_flag=True,
     help="Configure the local client with the generated key.",
 )
+@click.option(
+    "--output-file",
+    type=str,
+    required=False,
+    help="File to write the API key to.",
+)
 @click.pass_obj
 def create_api_key(
     service_account_name_or_id: str,
     name: str,
     description: Optional[str],
     set_key: bool = False,
+    output_file: Optional[str] = None,
 ) -> None:
     """Create an API key.
 
@@ -317,12 +341,14 @@ def create_api_key(
         name: Name of the API key
         description: The API key description.
         set_key: Configure the local client with the generated key.
+        output_file: Output file to write the API key to.
     """
     _create_api_key(
         service_account_name_or_id=service_account_name_or_id,
         name=name,
         description=description,
         set_key=set_key,
+        output_file=output_file,
     )
 
 
@@ -450,12 +476,19 @@ def update_api_key(
     is_flag=True,
     help="Configure the local client with the generated key.",
 )
+@click.option(
+    "--output-file",
+    type=str,
+    required=False,
+    help="File to write the API key to.",
+)
 @click.pass_obj
 def rotate_api_key(
     service_account_name_or_id: str,
     name_or_id: str,
     retain: int = 0,
     set_key: bool = False,
+    output_file: Optional[str] = None,
 ) -> None:
     """Rotate an API key.
 
@@ -466,6 +499,7 @@ def rotate_api_key(
         retain: Number of minutes for which the previous key is still valid
             after it has been rotated.
         set_key: Configure the local client with the newly generated key.
+        output_file: Output file to write the API key to.
     """
     client = Client()
     zen_store = client.zen_store
@@ -499,13 +533,19 @@ def rotate_api_key(
             )
             return
 
-    cli_utils.declare(
-        f"The new API key value is: '{api_key.key}'\nPlease store it "
-        "safely as it will not be shown again.\nTo configure a ZenML "
-        "client to use this API key, run:\n\n"
-        f"zenml connect --url {zen_store.config.url} --api-key \\\n"
-        f"    '{api_key.key}'\n"
-    )
+    if output_file and api_key.key:
+        with open(output_file, "w") as f:
+            f.write(api_key.key)
+
+        cli_utils.declare(f"Wrote API key value to {output_file}")
+    else:
+        cli_utils.declare(
+            f"The new API key value is: '{api_key.key}'\nPlease store it "
+            "safely as it will not be shown again.\nTo configure a ZenML "
+            "client to use this API key, run:\n\n"
+            f"zenml connect --url {zen_store.config.url} --api-key \\\n"
+            f"    '{api_key.key}'\n"
+        )
 
 
 @api_key.command("delete")

zenml/config/compiler.py

@@ -93,6 +93,10 @@ class Compiler:
         self._apply_run_configuration(
             pipeline=pipeline, config=run_configuration
         )
+        convert_component_shortcut_settings_keys(
+            pipeline.configuration.settings, stack=stack
+        )
+
         self._apply_stack_default_settings(pipeline=pipeline, stack=stack)
         if run_configuration.run_name:
             self._verify_run_name(run_configuration.run_name)
@@ -445,6 +449,9 @@ class Compiler:
                 step_config, runtime_parameters=invocation.parameters
             )
 
+        convert_component_shortcut_settings_keys(
+            step.configuration.settings, stack=stack
+        )
         step_spec = self._get_step_spec(invocation=invocation)
         step_settings = self._filter_and_validate_settings(
             settings=step.configuration.settings,
@@ -596,3 +603,30 @@ class Compiler:
             additional_spec_args["parameters"] = pipeline._parameters
 
         return PipelineSpec(steps=step_specs, **additional_spec_args)
+
+
+def convert_component_shortcut_settings_keys(
+    settings: Dict[str, "BaseSettings"], stack: "Stack"
+) -> None:
+    """Convert component shortcut settings keys.
+
+    Args:
+        settings: Dictionary of settings.
+        stack: The stack that the pipeline will run on.
+
+    Raises:
+        ValueError: If stack component settings were defined both using the
+            full and the shortcut key.
+    """
+    for component in stack.components.values():
+        shortcut_key = str(component.type)
+        if component_settings := settings.pop(shortcut_key, None):
+            key = settings_utils.get_stack_component_setting_key(component)
+            if key in settings:
+                raise ValueError(
+                    f"Duplicate settings provided for your {shortcut_key} "
+                    f"using the keys {shortcut_key} and {key}. Remove settings "
+                    "for one of them to fix this error."
+                )
+
+            settings[key] = component_settings

zenml/integrations/aws/orchestrators/sagemaker_orchestrator.py

@@ -372,7 +372,8 @@ class SagemakerOrchestrator(ContainerizedOrchestrator):
         # mainly for testing purposes, we wait for the pipeline to finish
         if self.config.synchronous:
             logger.info(
-                "Executing synchronously. Waiting for pipeline to finish..."
+                "Executing synchronously. Waiting for pipeline to finish... \n"
+                "At this point you can `Ctrl-C` out without cancelling the execution."
             )
             try:
                 pipeline_execution.wait(

zenml/integrations/feast/__init__.py

@@ -31,7 +31,7 @@ class FeastIntegration(Integration):
 
     NAME = FEAST
     # click is added to keep the feast click version in sync with ZenML's click
-    REQUIREMENTS = ["feast<=0.37.1", "click>=8.0.1,<8.1.4"]
+    REQUIREMENTS = ["feast", "click>=8.0.1,<8.1.4"]
     REQUIREMENTS_IGNORED_ON_UNINSTALL = ["click", "pandas"]
 
     @classmethod

zenml/integrations/tensorflow/materializers/tf_dataset_materializer.py

@@ -48,7 +48,7 @@ class TensorflowDatasetMaterializer(BaseMaterializer):
         temp_dir = tempfile.mkdtemp()
         io_utils.copy_dir(self.uri, temp_dir)
         path = os.path.join(temp_dir, DEFAULT_FILENAME)
-        dataset = tf.data.experimental.load(path)
+        dataset = tf.data.Dataset.load(path)
         # Don't delete the temporary directory here as the dataset is lazily
         # loaded and needs to read it when the object gets used
         return dataset
@@ -62,7 +62,7 @@ class TensorflowDatasetMaterializer(BaseMaterializer):
         temp_dir = tempfile.TemporaryDirectory()
         path = os.path.join(temp_dir.name, DEFAULT_FILENAME)
         try:
-            tf.data.experimental.save(
+            tf.data.Dataset.save(
                 dataset, path, compression=None, shard_func=None
             )
             io_utils.copy_dir(temp_dir.name, self.uri)

zenml/integrations/wandb/experiment_trackers/wandb_experiment_tracker.py

@@ -126,7 +126,7 @@ class WandbExperimentTracker(BaseExperimentTracker):
             info: Info about the step that was executed.
             step_failed: Whether the step failed or not.
         """
-        wandb.finish(exit_code=1) if step_failed else wandb.finish()  # type: ignore
+        wandb.finish(exit_code=1) if step_failed else wandb.finish()
         os.environ.pop(WANDB_API_KEY, None)
 
     def _initialize_wandb(

zenml/stack/stack_component.py

@@ -421,23 +421,56 @@ class StackComponent:
         else:
             user_id = None
 
-        return flavor.implementation_class(
-            user=user_id,
-            workspace=component_model.workspace.id,
-            name=component_model.name,
-            id=component_model.id,
-            config=configuration,
-            labels=component_model.labels,
-            flavor=component_model.flavor,
-            type=component_model.type,
-            created=component_model.created,
-            updated=component_model.updated,
-            connector_requirements=flavor.service_connector_requirements,
-            connector=component_model.connector.id
-            if component_model.connector
-            else None,
-            connector_resource_id=component_model.connector_resource_id,
-        )
+        try:
+            return flavor.implementation_class(
+                user=user_id,
+                workspace=component_model.workspace.id,
+                name=component_model.name,
+                id=component_model.id,
+                config=configuration,
+                labels=component_model.labels,
+                flavor=component_model.flavor,
+                type=component_model.type,
+                created=component_model.created,
+                updated=component_model.updated,
+                connector_requirements=flavor.service_connector_requirements,
+                connector=component_model.connector.id
+                if component_model.connector
+                else None,
+                connector_resource_id=component_model.connector_resource_id,
+            )
+        except ImportError as e:
+            from zenml.integrations.registry import integration_registry
+
+            integration_requirements = " ".join(
+                integration_registry.select_integration_requirements(
+                    flavor_model.integration
+                )
+            )
+
+            if integration_registry.is_installed(flavor_model.integration):
+                raise ImportError(
+                    f"{e}\n\n"
+                    f"Something went wrong while trying to import from the "
+                    f"`{flavor_model.integration}` integration. Please make "
+                    "sure that all its requirements are installed properly by "
+                    "reinstalling the integration either through our CLI: "
+                    f"`zenml integration install {flavor_model.integration} "
+                    "-y` or by manually installing its requirements: "
+                    f"`pip install {integration_requirements}`. If the error"
+                    "persists, please contact the ZenML team."
+                ) from e
+            else:
+                raise ImportError(
+                    f"{e}\n\n"
+                    f"The `{flavor_model.integration}` integration that you "
+                    "are trying to use is not installed in your current "
+                    "environment. Please make sure that it is installed by "
+                    "either using our CLI: `zenml integration install "
+                    f"{flavor_model.integration}` or by manually installing "
+                    f"its requirements: `pip install "
+                    f"{integration_requirements}`"
+                ) from e
 
     @property
     def config(self) -> StackComponentConfig:

zenml/utils/settings_utils.py

@@ -25,7 +25,7 @@ if TYPE_CHECKING:
     from zenml.stack.flavor import Flavor
 
 STACK_COMPONENT_REGEX = re.compile(
-    "(" + "|".join(StackComponentType.values()) + r")\..*"
+    "(" + "|".join(StackComponentType.values()) + r")(\..*)?"
 )
 
 

zenml/zen_server/dashboard/assets/{404-nKxQ4QDX.js → 404-iO8vpun1.js}

@@ -1 +1 @@
-import{j as e}from"./@radix-DnFH_oo1.js";import{h as s,r as t}from"./index-Davdjm1d.js";import{E as r}from"./EmptyState-Cs3DEmso.js";import{H as a}from"./help-CwN931fX.js";import{L as o}from"./@react-router-APVeuk-U.js";import"./@tanstack-QbMbTrh5.js";import"./@reactflow-IuMOnBUC.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-DnFH_oo1.js";import{f as s,r as t}from"./index-B9wVwe7u.js";import{E as r}from"./EmptyState-Cs3DEmso.js";import{H as a}from"./help-CwN931fX.js";import{L as o}from"./@react-router-APVeuk-U.js";import"./@tanstack-QbMbTrh5.js";import"./@reactflow-B6kq9fJZ.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};