# zenml - Doramagic AI Context Pack

> Purpose: pre-work context for the user's host AI. This pack does not prove that the project has been installed, run, or validated.

## Project

- canonical_name: `zenml-io/zenml`
- capability: ZenML 🙏: One AI Platform from Pipelines to Agents. https://zenml.io.
- expected_user_outcome: ZenML 🙏: One AI Platform from Pipelines to Agents. https://zenml.io.

## Operating Boundaries

- Do not claim that the project has been installed, run, called through an API, or used on local files unless separate evidence proves it.
- Project facts must come from repo evidence, Claim Graph, or explicit source references.
- When a capability is not verified, mark it as unverified instead of completing it as fact.
- publish_status: `publishable`
- blocking_gaps: none

---

## Doramagic Context Augmentation

The following sections strengthen the repository context for a host AI. Human Manual data is a reading route, and pitfall notes become operating constraints.

## Human Manual Outline

Usage rule: this is only a reading route and salience signal, not factual authority. Concrete claims must still return to repo evidence or Claim Graph.

Host AI hard rules:
- Do not treat page titles, section order, summaries, or importance values as factual project evidence.
- When explaining the Human Manual outline, state that it is only a reading route or salience signal.
- Capability, installation, compatibility, runtime state, and risk claims must cite repo evidence, source paths, or Claim Graph.

- **Pipeline Authoring: Steps, Pipelines, Snapshots, and Dynamic Execution**: importance `high`
  - source_paths: src/zenml/pipelines/pipeline_decorator.py, src/zenml/pipelines/pipeline_definition.py, src/zenml/steps/base_step.py, src/zenml/steps/step_decorator.py, src/zenml/steps/command_step.py
- **Stacks, Orchestrators, and Integration Ecosystem**: importance `high`
  - source_paths: src/zenml/stack/stack.py, src/zenml/stack/stack_component.py, src/zenml/stack/flavor.py, src/zenml/stack/flavor_registry.py, src/zenml/orchestrators/base_orchestrator.py
- **Containerization, Image Building, and Server Deployment**: importance `high`
  - source_paths: src/zenml/config/docker_settings.py, src/zenml/utils/pipeline_docker_image_builder.py, src/zenml/image_builders/base_image_builder.py, src/zenml/image_builders/local_image_builder.py, src/zenml/image_builders/build_context.py
- **Server, REST API, Data Models, and Persistence**: importance `high`
  - source_paths: src/zenml/zen_server/zen_server_api.py, src/zenml/zen_server/auth.py, src/zenml/zen_server/rbac/__init__.py, src/zenml/zen_server/streaming/__init__.py, src/zenml/zen_server/feature_gate/feature_gate_interface.py

## Repo Inspection Evidence

- repo_clone_verified: true
- repo_inspection_verified: true
- repo_commit: `b4ae4549311361343d9869831ed6878e758c2dd6`
- inspected_files: `README.md`, `pyproject.toml`, `docs/README.md`, `docs/_static/config.js`, `docs/_static/klaro.max.js`, `docs/book/.gitbook/includes/stacks.md`, `docs/book/.gitbook/includes/untitled.md`, `docs/book/AGENTS.md`, `docs/book/api-docs/.gitbook.yaml`, `docs/book/api-docs/README.md`, `docs/book/api-docs/oss-api/oss-api/README.md`, `docs/book/api-docs/oss-api/oss-api/getting-started.md`, `docs/book/api-docs/oss-api-docs/v1/api-token.md`, `docs/book/api-docs/oss-api-docs/v1/artifact-versions/README.md`, `docs/book/api-docs/oss-api-docs/v1/artifact-versions/batch.md`, `docs/book/api-docs/oss-api-docs/v1/artifact-versions/visualize.md`, `docs/book/api-docs/oss-api-docs/v1/artifacts.md`, `docs/book/api-docs/oss-api-docs/v1/code-repositories.md`, `docs/book/api-docs/oss-api-docs/v1/component-types.md`, `docs/book/api-docs/oss-api-docs/v1/components.md`

Host AI hard rules:
- Without repo_clone_verified=true, do not claim that the source code has been read.
- Without repo_inspection_verified=true, do not write README, docs, or package-file conclusions as facts.
- Without quick_start_verified=true, do not claim that the Quick Start path has run successfully.

## Doramagic Pitfall Constraints

These rules come from Doramagic discovery, validation, or compilation findings. The host AI must treat them as operating constraints, not background notes.

### Constraint 1: Installation risk requires verification

- Trigger: Project evidence flags a installation risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/zenml-io/zenml/issues/4912
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 2: Installation risk requires verification

- Trigger: Project evidence flags a installation risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/zenml-io/zenml/issues/4905
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 3: Configuration risk requires verification

- Trigger: Project evidence flags a configuration risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/zenml-io/zenml/issues/4740
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 4: Capability evidence risk requires verification

- Trigger: README/documentation is current enough for a first validation pass.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: capability.assumptions | https://github.com/zenml-io/zenml
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 5: Maintenance risk requires verification

- Trigger: Project evidence flags a maintenance risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/zenml-io/zenml/issues/4972
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 6: Maintenance risk requires verification

- Trigger: Project evidence flags a maintenance risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: evidence.maintainer_signals | https://github.com/zenml-io/zenml
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 7: Security or permission risk requires verification

- Trigger: no_demo
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: downstream_validation.risk_items | https://github.com/zenml-io/zenml
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 8: Security or permission risk requires verification

- Trigger: no_demo
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: risks.scoring_risks | https://github.com/zenml-io/zenml
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 9: Security or permission risk requires verification

- Trigger: Project evidence flags a security or permission risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/zenml-io/zenml/issues/4894
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 10: Security or permission risk requires verification

- Trigger: Project evidence flags a security or permission risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: community_evidence:github | https://github.com/zenml-io/zenml/issues/4652
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.
