zenml-nightly 0.83.1.dev20250710__tar.gz → 0.83.1.dev20250711__tar.gz

{zenml_nightly-0.83.1.dev20250710 → zenml_nightly-0.83.1.dev20250711}/CLAUDE.md

@@ -124,6 +124,58 @@ Use filesystem navigation tools to explore the codebase structure as needed.
 - Add appropriate error handling
 - Document public APIs thoroughly
 
+### Field Description Standards
+When adding or modifying Field descriptions in stack component configs:
+
+#### Template Structure
+```
+{Purpose statement}. {Valid values/format}. {Example(s)}. {Additional context if needed}.
+```
+
+#### Core Requirements
+1. **Purpose**: Clearly state what the field controls or does
+2. **Format**: Specify expected value format (URL, path, enum, etc.)
+3. **Examples**: Provide at least one concrete example
+4. **Constraints**: Include any limitations or requirements
+
+#### Quality Standards
+- Minimum 30 characters
+- Use action words (controls, configures, specifies, determines)
+- Include concrete examples with realistic values
+- Avoid vague language ("thing", "stuff", "value", "setting")
+- Don't start with "The" or end with periods
+- Be specific about valid formats and constraints
+
+#### Example Field Descriptions
+```python
+# Good examples:
+instance_type: Optional[str] = Field(
+    None,
+    description="AWS EC2 instance type for step execution. Must be a valid "
+    "SageMaker-supported instance type. Examples: 'ml.t3.medium' (2 vCPU, 4GB RAM), "
+    "'ml.m5.xlarge' (4 vCPU, 16GB RAM). Defaults to ml.m5.xlarge for training steps"
+)
+
+path: str = Field(
+    description="Root path for artifact storage. Must be a valid URI supported by the "
+    "artifact store implementation. Examples: 's3://my-bucket/artifacts', "
+    "'/local/storage/path', 'gs://bucket-name/zenml-artifacts'. Path must be accessible "
+    "with configured credentials"
+)
+
+synchronous: bool = Field(
+    True,
+    description="Controls whether pipeline execution blocks the client. If True, "
+    "the client waits until all steps complete. If False, returns immediately and "
+    "executes asynchronously. Useful for long-running production pipelines"
+)
+```
+
+#### Validation
+- Run `python scripts/validate_descriptions.py` to check description quality
+- All descriptions must pass validation before merging
+- Add validation to CI pipeline to prevent regressions
+
 ### When Fixing Bugs
 - Add regression tests that would have caught the bug
 - Understand root cause before implementing fix

{zenml_nightly-0.83.1.dev20250710 → zenml_nightly-0.83.1.dev20250711}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: zenml-nightly
-Version: 0.83.1.dev20250710
+Version: 0.83.1.dev20250711
 Summary: ZenML: Write production-ready ML code.
 License: Apache-2.0
 Keywords: machine learning,production,pipeline,mlops,devops
@@ -198,9 +198,9 @@ Description-Content-Type: text/markdown
 
 ![No MLOps for modern AI](docs/book/.gitbook/assets/readme_problem.png)
 
-You're an ML engineer. You've perfected deploying scikit-learn models and wrangling TensorFlow jobs. Your MLOps stack is dialed in. But now, you're being asked to build and ship AI agents, and suddenly your trusted toolkit is starting to crack.
+You're an ML engineer. You've perfected deploying `scikit-learn` models and wrangling PyTorch jobs. Your MLOps stack is dialed in. But now, you're being asked to build and ship AI agents, and suddenly your trusted toolkit is starting to crack.
 
-- **The Adaptation Struggle:** Your MLOps habits—rigorous testing, versioning, CI/CD—don’t map cleanly onto agent development. How do you version a prompt? How do you regression test a non-deterministic system? The tools that gave you confidence for models now create friction for agents.
+- **The Adaptation Struggle:** Your MLOps habits (rigorous testing, versioning, CI/CD) don’t map cleanly onto agent development. How do you version a prompt? How do you regression test a non-deterministic system? The tools that gave you confidence for models now create friction for agents.
 
 - **The Divided Stack:** To cope, teams are building a second, parallel stack just for LLM-based systems. Now you’re maintaining two sets of tools, two deployment pipelines, and two mental models. Your classical models live in one world, your agents in another. It's expensive, complex, and slows everyone down.
 
@@ -328,7 +328,7 @@ results = compare_architectures(
 **Friday: Ship with Confidence**
 ```python
 # Deploy the new agent with the same command you use for ML models
-zenml stack deploy agent-prod --model="customer_service:challenger"
+python agent_deployment.py --env=prod --model="customer_service:challenger"
 ```
 </details>
 
@@ -338,7 +338,8 @@ zenml stack deploy agent-prod --model="customer_service:challenger"
 
 ```bash
 # You know this drill
-pip install "zenml[llm]"  # Includes LangChain, LlamaIndex integrations
+pip install zenml  # Includes LangChain, LlamaIndex integrations
+zenml integration install langchain llamaindex
 
 # Initialize (your ML pipelines still work!)
 zenml init
@@ -438,25 +439,10 @@ ZenML is featured in these comprehensive guides to production AI systems.
 
 ## 🤝 Join ML Engineers Building the Future of AI
 
-**You're Not Alone:**
-- 💬 [Slack Community](https://zenml.io/slack) - 3000+ ML engineers building with ZenML.
-- 🐛 [GitHub Issues](https://github.com/zenml-io/zenml/issues) - Bug reports and feature requests.
-- 📧 [Enterprise Support](https://zenml.io/pro) - SLAs, dedicated support, professional services.
-
-**Real Engineers, Real Stories:**
-> "Same platform for our sklearn models and our RAG pipeline. DevOps loves us now."
-> - ML Platform Lead, European Bank
-
-> "We went from 'YOLO prompt updates' to proper evaluation pipelines. Game changer."
-> - Senior ML Engineer, Fortune 500 Retailer
-
-> "Finally, I can explain to my PM why agent v2 is actually worse than v1. With data!"
-> - Staff Engineer, Series B Startup
-
 **Contribute:**
 - 🌟 [Star us on GitHub](https://github.com/zenml-io/zenml/stargazers) - Help others discover ZenML
 - 🤝 [Contributing Guide](CONTRIBUTING.md) - Start with [`good-first-issue`](https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+user%3Azenml-io+label%3A%22good+first+issue%22)
-- 💻 [Write Integrations](https://docs.zenml.io/how-to/stack-deployment/implement-a-custom-integration) - Add your favorite tools
+- 💻 [Write Integrations](https://github.com/zenml-io/zenml/blob/main/src/zenml/integrations/README.md) - Add your favorite tools
 
 **Stay Updated:**
 - 🗺 [Public Roadmap](https://zenml.io/roadmap) - See what's coming next
@@ -466,7 +452,7 @@ ZenML is featured in these comprehensive guides to production AI systems.
 ## ❓ FAQs from ML Engineers Like You
 
 **Q: "Do I need to rewrite my agents or models to use ZenML?"**
-A: No. Wrap your existing code in a `@step`. Keep using Scikit-Learn, PyTorch, LangGraph, LlamaIndex, or raw API calls. ZenML orchestrates your tools, it doesn't replace them.
+A: No. Wrap your existing code in a `@step`. Keep using `scikit-learn`, PyTorch, LangGraph, LlamaIndex, or raw API calls. ZenML orchestrates your tools, it doesn't replace them.
 
 **Q: "How is this different from LangSmith/Langfuse?"**
 A: They provide excellent observability for LLM applications. We orchestrate the **full MLOps lifecycle for your entire AI stack**. With ZenML, you manage both your classical ML models and your AI agents in one unified framework, from development and evaluation all the way to production deployment.
@@ -497,3 +483,4 @@ Install from [VS Code Marketplace](https://marketplace.visualstudio.com/items?it
 
 ZenML is distributed under the terms of the Apache License Version 2.0. See
 [LICENSE](LICENSE) for details.
+

{zenml_nightly-0.83.1.dev20250710 → zenml_nightly-0.83.1.dev20250711}/README.md

@@ -52,9 +52,9 @@
 
 ![No MLOps for modern AI](docs/book/.gitbook/assets/readme_problem.png)
 
-You're an ML engineer. You've perfected deploying scikit-learn models and wrangling TensorFlow jobs. Your MLOps stack is dialed in. But now, you're being asked to build and ship AI agents, and suddenly your trusted toolkit is starting to crack.
+You're an ML engineer. You've perfected deploying `scikit-learn` models and wrangling PyTorch jobs. Your MLOps stack is dialed in. But now, you're being asked to build and ship AI agents, and suddenly your trusted toolkit is starting to crack.
 
-- **The Adaptation Struggle:** Your MLOps habits—rigorous testing, versioning, CI/CD—don’t map cleanly onto agent development. How do you version a prompt? How do you regression test a non-deterministic system? The tools that gave you confidence for models now create friction for agents.
+- **The Adaptation Struggle:** Your MLOps habits (rigorous testing, versioning, CI/CD) don’t map cleanly onto agent development. How do you version a prompt? How do you regression test a non-deterministic system? The tools that gave you confidence for models now create friction for agents.
 
 - **The Divided Stack:** To cope, teams are building a second, parallel stack just for LLM-based systems. Now you’re maintaining two sets of tools, two deployment pipelines, and two mental models. Your classical models live in one world, your agents in another. It's expensive, complex, and slows everyone down.
 
@@ -182,7 +182,7 @@ results = compare_architectures(
 **Friday: Ship with Confidence**
 ```python
 # Deploy the new agent with the same command you use for ML models
-zenml stack deploy agent-prod --model="customer_service:challenger"
+python agent_deployment.py --env=prod --model="customer_service:challenger"
 ```
 </details>
 
@@ -192,7 +192,8 @@ zenml stack deploy agent-prod --model="customer_service:challenger"
 
 ```bash
 # You know this drill
-pip install "zenml[llm]"  # Includes LangChain, LlamaIndex integrations
+pip install zenml  # Includes LangChain, LlamaIndex integrations
+zenml integration install langchain llamaindex
 
 # Initialize (your ML pipelines still work!)
 zenml init
@@ -292,25 +293,10 @@ ZenML is featured in these comprehensive guides to production AI systems.
 
 ## 🤝 Join ML Engineers Building the Future of AI
 
-**You're Not Alone:**
-- 💬 [Slack Community](https://zenml.io/slack) - 3000+ ML engineers building with ZenML.
-- 🐛 [GitHub Issues](https://github.com/zenml-io/zenml/issues) - Bug reports and feature requests.
-- 📧 [Enterprise Support](https://zenml.io/pro) - SLAs, dedicated support, professional services.
-
-**Real Engineers, Real Stories:**
-> "Same platform for our sklearn models and our RAG pipeline. DevOps loves us now."
-> - ML Platform Lead, European Bank
-
-> "We went from 'YOLO prompt updates' to proper evaluation pipelines. Game changer."
-> - Senior ML Engineer, Fortune 500 Retailer
-
-> "Finally, I can explain to my PM why agent v2 is actually worse than v1. With data!"
-> - Staff Engineer, Series B Startup
-
 **Contribute:**
 - 🌟 [Star us on GitHub](https://github.com/zenml-io/zenml/stargazers) - Help others discover ZenML
 - 🤝 [Contributing Guide](CONTRIBUTING.md) - Start with [`good-first-issue`](https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+user%3Azenml-io+label%3A%22good+first+issue%22)
-- 💻 [Write Integrations](https://docs.zenml.io/how-to/stack-deployment/implement-a-custom-integration) - Add your favorite tools
+- 💻 [Write Integrations](https://github.com/zenml-io/zenml/blob/main/src/zenml/integrations/README.md) - Add your favorite tools
 
 **Stay Updated:**
 - 🗺 [Public Roadmap](https://zenml.io/roadmap) - See what's coming next
@@ -320,7 +306,7 @@ ZenML is featured in these comprehensive guides to production AI systems.
 ## ❓ FAQs from ML Engineers Like You
 
 **Q: "Do I need to rewrite my agents or models to use ZenML?"**
-A: No. Wrap your existing code in a `@step`. Keep using Scikit-Learn, PyTorch, LangGraph, LlamaIndex, or raw API calls. ZenML orchestrates your tools, it doesn't replace them.
+A: No. Wrap your existing code in a `@step`. Keep using `scikit-learn`, PyTorch, LangGraph, LlamaIndex, or raw API calls. ZenML orchestrates your tools, it doesn't replace them.
 
 **Q: "How is this different from LangSmith/Langfuse?"**
 A: They provide excellent observability for LLM applications. We orchestrate the **full MLOps lifecycle for your entire AI stack**. With ZenML, you manage both your classical ML models and your AI agents in one unified framework, from development and evaluation all the way to production deployment.
@@ -350,4 +336,4 @@ Install from [VS Code Marketplace](https://marketplace.visualstudio.com/items?it
 ## 📜 License
 
 ZenML is distributed under the terms of the Apache License Version 2.0. See
-[LICENSE](LICENSE) for details.
+[LICENSE](LICENSE) for details.

{zenml_nightly-0.83.1.dev20250710 → zenml_nightly-0.83.1.dev20250711}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zenml-nightly"
-version = "0.83.1.dev20250710"
+version = "0.83.1.dev20250711"
 packages = [{ include = "zenml", from = "src" }]
 description = "ZenML: Write production-ready ML code."
 authors = ["ZenML GmbH <info@zenml.io>"]

zenml_nightly-0.83.1.dev20250711/src/zenml/VERSION

@@ -0,0 +1 @@
+0.83.1.dev20250711

{zenml_nightly-0.83.1.dev20250710 → zenml_nightly-0.83.1.dev20250711}/src/zenml/artifact_stores/base_artifact_store.py

@@ -33,11 +33,15 @@ from typing import (
     cast,
 )
 
-from pydantic import model_validator
+from pydantic import Field, model_validator
 
-from zenml.constants import ENV_ZENML_SERVER
+from zenml.constants import (
+    ENV_ZENML_SERVER,
+    ENV_ZENML_SERVER_ALLOW_LOCAL_FILE_ACCESS,
+    handle_bool_env_var,
+)
 from zenml.enums import StackComponentType
-from zenml.exceptions import ArtifactStoreInterfaceError
+from zenml.exceptions import ArtifactStoreInterfaceError, IllegalOperationError
 from zenml.io import fileio
 from zenml.logger import get_logger
 from zenml.stack import Flavor, StackComponent, StackComponentConfig
@@ -73,6 +77,12 @@ class _sanitize_paths:
         """
         self.func = func
         self.fixed_root_path = fixed_root_path
+        if ENV_ZENML_SERVER in os.environ:
+            self.allow_local_file_access = handle_bool_env_var(
+                ENV_ZENML_SERVER_ALLOW_LOCAL_FILE_ACCESS, False
+            )
+        else:
+            self.allow_local_file_access = True
 
         self.path_args: List[int] = []
         self.path_kwargs: List[str] = []
@@ -93,7 +103,15 @@ class _sanitize_paths:
         Raises:
             FileNotFoundError: If the path is outside of the artifact store
                 bounds.
+            IllegalOperationError: If the path is a local file and the server
+                is not configured to allow local file access.
         """
+        if not self.allow_local_file_access and not io_utils.is_remote(path):
+            raise IllegalOperationError(
+                "Files in a local artifact store cannot be accessed from the "
+                "server."
+            )
+
         if not path.startswith(self.fixed_root_path):
             raise FileNotFoundError(
                 f"File `{path}` is outside of "
@@ -169,9 +187,18 @@ class _sanitize_paths:
 
 
 class BaseArtifactStoreConfig(StackComponentConfig):
-    """Config class for `BaseArtifactStore`."""
+    """Config class for `BaseArtifactStore`.
 
-    path: str
+    Base configuration for artifact storage backends.
+    Field descriptions are defined inline using Field() descriptors.
+    """
+
+    path: str = Field(
+        description="Root path for artifact storage. Must be a valid URI supported by the "
+        "specific artifact store implementation. Examples: 's3://my-bucket/artifacts', "
+        "'/local/storage/path', 'gs://bucket-name/zenml-artifacts', 'azure://container/path'. "
+        "Path must be accessible with the configured credentials and permissions"
+    )
 
     SUPPORTED_SCHEMES: ClassVar[Set[str]]
     IS_IMMUTABLE_FILESYSTEM: ClassVar[bool] = False
@@ -435,40 +462,41 @@ class BaseArtifactStore(StackComponent):
             **kwargs: The keyword arguments to pass to the Pydantic object.
         """
         super(BaseArtifactStore, self).__init__(*args, **kwargs)
+        self._add_path_sanitization()
 
         # If running in a ZenML server environment, we don't register
         # the filesystems. We always use the artifact stores directly.
         if ENV_ZENML_SERVER not in os.environ:
             self._register()
 
+    def _add_path_sanitization(self) -> None:
+        """Add path sanitization to the artifact store."""
+        for method_name, method in inspect.getmembers(BaseArtifactStore):
+            if getattr(method, "__isabstractmethod__", False):
+                method_implementation = getattr(self, method_name)
+                sanitized_method = _sanitize_paths(
+                    method_implementation, self.path
+                )
+                setattr(self, method_name, sanitized_method)
+
     def _register(self) -> None:
         """Create and register a filesystem within the filesystem registry."""
         from zenml.io.filesystem import BaseFilesystem
         from zenml.io.filesystem_registry import default_filesystem_registry
         from zenml.io.local_filesystem import LocalFilesystem
 
-        overloads: Dict[str, Any] = {
-            "SUPPORTED_SCHEMES": self.config.SUPPORTED_SCHEMES,
-        }
-        for abc_method in inspect.getmembers(BaseArtifactStore):
-            if getattr(abc_method[1], "__isabstractmethod__", False):
-                sanitized_method = _sanitize_paths(
-                    getattr(self, abc_method[0]), self.path
-                )
-                # prepare overloads for filesystem methods
-                overloads[abc_method[0]] = staticmethod(sanitized_method)
-
-                # decorate artifact store methods
-                setattr(
-                    self,
-                    abc_method[0],
-                    sanitized_method,
-                )
-
         # Local filesystem is always registered, no point in doing it again.
         if isinstance(self, LocalFilesystem):
             return
 
+        overloads: Dict[str, Any] = {
+            "SUPPORTED_SCHEMES": self.config.SUPPORTED_SCHEMES,
+        }
+        for method_name, method in inspect.getmembers(BaseArtifactStore):
+            if getattr(method, "__isabstractmethod__", False):
+                method_implementation = getattr(self, method_name)
+                overloads[method_name] = staticmethod(method_implementation)
+
         filesystem_class = type(
             self.__class__.__name__, (BaseFilesystem,), overloads
         )

{zenml_nightly-0.83.1.dev20250710 → zenml_nightly-0.83.1.dev20250711}/src/zenml/artifacts/utils.py

@@ -49,6 +49,7 @@ from zenml.enums import (
 )
 from zenml.exceptions import (
     DoesNotExistException,
+    IllegalOperationError,
     StepContextError,
 )
 from zenml.io import fileio
@@ -925,6 +926,7 @@ def _load_file_from_artifact_store(
         DoesNotExistException: If the file does not exist in the artifact store.
         NotImplementedError: If the artifact store cannot open the file.
         IOError: If the artifact store rejects the request.
+        IllegalOperationError: If the artifact store rejects the request.
     """
     try:
         with artifact_store.open(uri, mode) as text_file:
@@ -946,7 +948,7 @@ def _load_file_from_artifact_store(
             f"File '{uri}' does not exist in artifact store "
             f"'{artifact_store.name}'."
         )
-    except IOError as e:
+    except (IOError, IllegalOperationError) as e:
         raise e
     except Exception as e:
         logger.exception(e)

{zenml_nightly-0.83.1.dev20250710 → zenml_nightly-0.83.1.dev20250711}/src/zenml/cli/pipeline.py

@@ -604,16 +604,27 @@ def delete_pipeline_run(
 
 @runs.command("refresh")
 @click.argument("run_name_or_id", type=str, required=True)
-def refresh_pipeline_run(run_name_or_id: str) -> None:
+@click.option(
+    "--include-steps",
+    is_flag=True,
+    default=False,
+    help="Also refresh the status of individual steps.",
+)
+def refresh_pipeline_run(
+    run_name_or_id: str, include_steps: bool = False
+) -> None:
     """Refresh the status of a pipeline run.
 
     Args:
         run_name_or_id: The name or ID of the pipeline run to refresh.
+        include_steps: If True, also refresh the status of individual steps.
     """
     try:
         # Fetch and update the run
         run = Client().get_pipeline_run(name_id_or_prefix=run_name_or_id)
-        run.refresh_run_status()
+        run_utils.refresh_run_status(
+            run=run, include_step_updates=include_steps
+        )
 
     except KeyError as e:
         cli_utils.error(str(e))

{zenml_nightly-0.83.1.dev20250710 → zenml_nightly-0.83.1.dev20250711}/src/zenml/constants.py

@@ -166,6 +166,9 @@ ENV_ZENML_DISABLE_CLIENT_SERVER_MISMATCH_WARNING = (
 ENV_ZENML_SKIP_IMAGE_BUILDER_DEFAULT = "ZENML_SKIP_IMAGE_BUILDER_DEFAULT"
 ENV_ZENML_SKIP_STACK_VALIDATION = "ZENML_SKIP_STACK_VALIDATION"
 ENV_ZENML_SERVER = "ZENML_SERVER"
+ENV_ZENML_SERVER_ALLOW_LOCAL_FILE_ACCESS = (
+    "ZENML_SERVER_ALLOW_LOCAL_FILE_ACCESS"
+)
 ENV_ZENML_ENFORCE_TYPE_ANNOTATIONS = "ZENML_ENFORCE_TYPE_ANNOTATIONS"
 ENV_ZENML_ENABLE_IMPLICIT_AUTH_METHODS = "ZENML_ENABLE_IMPLICIT_AUTH_METHODS"
 ENV_ZENML_DISABLE_PIPELINE_LOGS_STORAGE = "ZENML_DISABLE_PIPELINE_LOGS_STORAGE"

{zenml_nightly-0.83.1.dev20250710 → zenml_nightly-0.83.1.dev20250711}/src/zenml/container_registries/base_container_registry.py

@@ -16,7 +16,7 @@
 import re
 from typing import TYPE_CHECKING, Optional, Tuple, Type, cast
 
-from pydantic import field_validator
+from pydantic import Field, field_validator
 
 from zenml.constants import DOCKER_REGISTRY_RESOURCE_TYPE
 from zenml.enums import StackComponentType
@@ -36,12 +36,24 @@ if TYPE_CHECKING:
 class BaseContainerRegistryConfig(AuthenticationConfigMixin):
     """Base config for a container registry.
 
-    Attributes:
-        uri: The URI of the container registry.
+    Configuration for connecting to container image registries.
+    Field descriptions are defined inline using Field() descriptors.
     """
 
-    uri: str
-    default_repository: Optional[str] = None
+    uri: str = Field(
+        description="Container registry URI (e.g., 'gcr.io' for Google Container "
+        "Registry, 'docker.io' for Docker Hub, 'registry.gitlab.com' for GitLab "
+        "Container Registry, 'ghcr.io' for GitHub Container Registry). This is "
+        "the base URL where container images will be pushed to and pulled from."
+    )
+    default_repository: Optional[str] = Field(
+        default=None,
+        description="Default repository namespace for image storage (e.g., "
+        "'username' for Docker Hub, 'project-id' for GCR, 'organization' for "
+        "GitHub Container Registry). If not specified, images will be stored at "
+        "the registry root. For Docker Hub this would mean only official images "
+        "can be pushed.",
+    )
 
     @field_validator("uri")
     @classmethod