# ZenML - Bridging the gap between ML & Ops ## ZenML - [Welcome to ZenML](https://docs.zenml.io/getting-started/introduction.md): Build production ML pipelines with ZenML and improve agentic systems with Kitaru. - [Installation](https://docs.zenml.io/getting-started/installation.md): Installing ZenML and getting started. - [Hello World](https://docs.zenml.io/getting-started/hello-world.md): Your first ML pipeline with ZenML - from local development to cloud deployment in minutes. - [Your First AI Pipeline](https://docs.zenml.io/getting-started/your-first-ai-pipeline.md): Choose your path and build your first pipeline with ZenML in minutes. - [Core Concepts](https://docs.zenml.io/getting-started/core-concepts.md): Discovering the core concepts behind ZenML. - [System Architecture](https://docs.zenml.io/getting-started/system-architectures.md): Different variations of the ZenML architecture depending on your needs. - [Deploy](https://docs.zenml.io/deploying-zenml/deploying-zenml.md): Why do we need to deploy ZenML? - [Deploy with Docker](https://docs.zenml.io/deploying-zenml/deploying-zenml/deploy-with-docker.md): Deploying ZenML in a Docker container. - [Deploy with Helm](https://docs.zenml.io/deploying-zenml/deploying-zenml/deploy-with-helm.md): Deploying ZenML in a Kubernetes cluster with Helm. - [Migrate to Gateway API](https://docs.zenml.io/deploying-zenml/deploying-zenml/deploy-with-helm/migrate-to-gateway-api.md): Migrate ZenML Helm deployments from Ingress to Kubernetes Gateway API. - [Deploy using HuggingFace Spaces](https://docs.zenml.io/deploying-zenml/deploying-zenml/deploy-using-huggingface-spaces.md): Deploying ZenML to Huggingface Spaces. - [Deploy with custom images](https://docs.zenml.io/deploying-zenml/deploying-zenml/deploy-with-custom-image.md): Deploying ZenML with custom Docker images. - [Secret management](https://docs.zenml.io/deploying-zenml/deploying-zenml/secret-management.md): Configuring the secrets store. - [Custom secret stores](https://docs.zenml.io/deploying-zenml/deploying-zenml/custom-secret-stores.md): Learning how to develop a custom secret store. - [Live event streaming](https://docs.zenml.io/deploying-zenml/deploying-zenml/live-event-streaming.md): Enable live event streaming on the ZenML server and consume the HTTP/SSE feed. - [Connect](https://docs.zenml.io/deploying-zenml/connecting-to-zenml.md): Various means of connecting to ZenML. - [with your User (interactive)](https://docs.zenml.io/deploying-zenml/connecting-to-zenml/connect-in-with-your-user-interactive.md): Connect to the ZenML server using the ZenML CLI and the web based login. - [with your User (programmatic)](https://docs.zenml.io/deploying-zenml/connecting-to-zenml/connect-with-a-pat.md): Connect to the ZenML server using a Personal Access Token. - [with a Service Account](https://docs.zenml.io/deploying-zenml/connecting-to-zenml/connect-with-a-service-account.md): Connect to the ZenML server using a service account and an API key. - [Manage](https://docs.zenml.io/deploying-zenml/upgrade-zenml-server.md): Learn how to upgrade your server to a new version of ZenML for the different deployment options. - [Best practices for upgrading](https://docs.zenml.io/deploying-zenml/upgrade-zenml-server/best-practices-upgrading-zenml.md): Simple, step-by-step guide for keeping your ZenML workspaces (servers) up to date without breaking your teams. - [Using ZenML server in production](https://docs.zenml.io/deploying-zenml/upgrade-zenml-server/using-zenml-server-in-prod.md): Learn about best practices for using ZenML server in production environments. - [Troubleshoot your ZenML server](https://docs.zenml.io/deploying-zenml/upgrade-zenml-server/troubleshoot-your-deployed-server.md): Troubleshooting tips for your ZenML deployment - [Migration guide](https://docs.zenml.io/deploying-zenml/upgrade-zenml-server/migration-guide.md): How to migrate your ZenML code to the newest version. - [Migration guide 0.13.2 → 0.20.0](https://docs.zenml.io/deploying-zenml/upgrade-zenml-server/migration-guide/migration-zero-twenty.md): How to migrate from ZenML <=0.13.2 to 0.20.0. - [Migration guide 0.23.0 → 0.30.0](https://docs.zenml.io/deploying-zenml/upgrade-zenml-server/migration-guide/migration-zero-thirty.md): How to migrate from ZenML 0.20.0-0.23.0 to 0.30.0-0.39.1. - [Migration guide 0.39.1 → 0.41.0](https://docs.zenml.io/deploying-zenml/upgrade-zenml-server/migration-guide/migration-zero-forty.md): How to migrate your ZenML pipelines and steps from version <=0.39.1 to 0.41.0. - [Migration guide 0.58.2 → 0.60.0](https://docs.zenml.io/deploying-zenml/upgrade-zenml-server/migration-guide/migration-zero-sixty.md): How to migrate from ZenML 0.58.2 to 0.60.0 (Pydantic 2 edition). - [Steps & Pipelines](https://docs.zenml.io/concepts/steps_and_pipelines.md): Steps and Pipelines are the core building blocks of ZenML - [Configuration](https://docs.zenml.io/concepts/steps_and_pipelines/configuration.md): Configuring and customizing your pipeline runs. - [Scheduling](https://docs.zenml.io/concepts/steps_and_pipelines/scheduling.md): Learn how to create, update, activate, deactivate, and delete schedules for pipelines. - [Logging](https://docs.zenml.io/concepts/steps_and_pipelines/logging.md): Learn how to control and customize logging behavior in ZenML pipelines. - [YAML Configuration](https://docs.zenml.io/concepts/steps_and_pipelines/yaml_configuration.md): Learn how to configure ZenML pipelines using YAML configuration files. - [Source Code and Imports](https://docs.zenml.io/concepts/steps_and_pipelines/sources.md): Understanding source roots and source paths - [Execution](https://docs.zenml.io/concepts/steps_and_pipelines/execution.md): Step and pipeline execution. - [Wait for External Input](https://docs.zenml.io/concepts/steps_and_pipelines/wait_resume.md): Pause a dynamic pipeline for external input and resume it after the input is resolved. - [Advanced Features](https://docs.zenml.io/concepts/steps_and_pipelines/advanced_features.md): Advanced features and capabilities of ZenML pipelines and steps - [Hooks](https://docs.zenml.io/concepts/steps_and_pipelines/hooks.md): Run custom code on pipeline and step lifecycle events and record hook invocations. - [Dynamic Pipelines](https://docs.zenml.io/concepts/steps_and_pipelines/dynamic_pipelines.md): Write dynamic pipelines - [Command Steps](https://docs.zenml.io/concepts/steps_and_pipelines/command_steps.md): Run arbitrary commands as pipeline steps - [Streaming Events](https://docs.zenml.io/concepts/steps_and_pipelines/streaming_events.md): Publish live events from inside a step to subscribed clients. - [Artifacts](https://docs.zenml.io/concepts/artifacts.md): Learn how ZenML manages data artifacts, tracks versioning and lineage, and enables effective data flow between steps. - [Materializers](https://docs.zenml.io/concepts/artifacts/materializers.md): Understanding and creating materializers to handle custom data types in ZenML pipelines - [Visualizations](https://docs.zenml.io/concepts/artifacts/visualizations.md): Learn how to visualize the data artifacts produced by your ZenML pipelines. - [Stack & Components](https://docs.zenml.io/concepts/stack_components.md): Understanding and working with ZenML Stacks and Stack Components - [Service Connectors](https://docs.zenml.io/concepts/service_connectors.md): Managing authentication to cloud services and resources with Service Connectors - [Pipeline Snapshots](https://docs.zenml.io/concepts/snapshots.md): Create and run pipeline snapshots. - [Pipeline Deployments](https://docs.zenml.io/concepts/deployment.md): Deploy pipelines as HTTP services for real-time execution - [Deployment Settings](https://docs.zenml.io/concepts/deployment/deployment_settings.md): Customize the pipeline deployment ASGI application with DeploymentSettings. - [Containerization](https://docs.zenml.io/concepts/containerization.md): Customize Docker builds to run your pipelines in isolated, well-defined environments. - [Code Repositories](https://docs.zenml.io/concepts/code-repositories.md): Tracking your code and avoiding unnecessary Docker builds by connecting your git repo. - [Secrets](https://docs.zenml.io/concepts/secrets.md): Registering and using secrets. - [Environment Variables](https://docs.zenml.io/concepts/environment-variables.md): Configuring environment variables. - [Tags](https://docs.zenml.io/concepts/tags.md): Use tags to organize tags in ZenML. - [Metadata](https://docs.zenml.io/concepts/metadata.md): Enrich your ML workflow with contextual information using ZenML metadata. - [Models](https://docs.zenml.io/concepts/models.md): Managing ML models throughout their lifecycle with ZenML - [Dashboard](https://docs.zenml.io/concepts/dashboard-features.md): Explore the features and capabilities of the ZenML dashboard - [Templates](https://docs.zenml.io/concepts/templates.md): Create and run templates in ZenML to standardize execution. - [Community & content](https://docs.zenml.io/reference/community-and-content.md): All possible ways for our community to get in touch with ZenML. - [Environment Variables](https://docs.zenml.io/reference/environment-variables.md): How to control ZenML behavior with environmental variables. - [LLM Tooling](https://docs.zenml.io/reference/llms-txt.md): LLM tooling for ZenML - MCP servers, llms.txt, and Agent Skills - [FAQ](https://docs.zenml.io/reference/faq.md): Find answers to the most frequently asked questions about ZenML. - [Global settings](https://docs.zenml.io/reference/global-settings.md): Understanding the global settings of your ZenML installation. - [Legacy docs](https://docs.zenml.io/reference/legacy-docs.md): All legacy docs of ZenML ## Kitaru (AI Agents) - [Welcome to Kitaru](https://docs.zenml.io/kitaru/getting-started/readme.md): Replay-based evals for AI agents, in Python and TypeScript. Test your next change against what your agent already did in production. - [Installation](https://docs.zenml.io/kitaru/getting-started/installation.md): Install Kitaru with one command, start the local server, and verify. Other install paths for project environments, TypeScript, and team servers. - [Deploy Kitaru](https://docs.zenml.io/kitaru/getting-started/deploy.md): Self-host Kitaru for your team: one server, your Postgres, workers in the environments where your agents live. - [Docker](https://docs.zenml.io/kitaru/getting-started/deploy/docker.md): Run the Kitaru server with Docker, using Compose for one host or the server container against your own Postgres. - [Helm](https://docs.zenml.io/kitaru/getting-started/deploy/helm.md): Deploy the Kitaru server on Kubernetes with the first-party Helm chart, covering external Postgres, automatic migrations, ingress, and TLS. - [Set up your coding agent](https://docs.zenml.io/kitaru/getting-started/setup.md): Install the MCP server and agent skills, then drive the whole Kitaru loop from Claude Code, Codex, or Cursor. - [Quickstart](https://docs.zenml.io/kitaru/getting-started/quickstart.md): From an agent in production to your first replay-backed decision, driven by your coding assistant: every step is a prompt first, a command second. - [Overview](https://docs.zenml.io/kitaru/core-concepts/concepts.md): A handful of nouns and one verb, and how sessions, replays, evaluators, cohorts, experiments, investigations, and workers fit together. - [Agents & Sessions](https://docs.zenml.io/kitaru/core-concepts/agents-and-sessions.md): The agent is the identity, the session is the recording of every model call, tool call, and decision a run left behind. - [Investigations & Annotations](https://docs.zenml.io/kitaru/core-concepts/investigations.md): Where your judgment enters the system: your coding assistant maps the evidence, interviews you in context, and pins your answers to exact trace evidence as annotations. - [Replay](https://docs.zenml.io/kitaru/core-concepts/replay.md): Re-run a recorded session against your real code, unchanged for a faithful baseline or forked with one thing different. - [Evaluators & Evaluations](https://docs.zenml.io/kitaru/core-concepts/evaluators.md): Evaluators turn sessions into evaluations: the rows they write. Numbers average, words count, free text gets read. - [Analyzers & Insights](https://docs.zenml.io/kitaru/core-concepts/analyzers.md): Analyzers turn many sessions into insights: the aggregate read a single evaluator can't give you. - [Cohorts](https://docs.zenml.io/kitaru/core-concepts/cohorts.md): Named, versioned sets of sessions; the population an experiment replays, frozen so results stay comparable. - [Experiments](https://docs.zenml.io/kitaru/core-concepts/experiments.md): A named change, replayed across a cohort and evaluated. What improved, what regressed, before you ship. - [Workers](https://docs.zenml.io/kitaru/core-concepts/workers.md): The process that runs replays, imports, and evaluators as subprocesses in your environment, so your code and data never leave your systems. - [Under the Hood](https://docs.zenml.io/kitaru/core-concepts/under-the-hood.md): The machinery behind the loop: a FastAPI server on Postgres, workers claiming tasks, and where Kitaru sits beside your observability stack. - [Complete returns agent tutorial](https://docs.zenml.io/kitaru/guides/returns-agent.md): Investigate supplied returns agent traces and test one evidence-led improvement. - [1. Observe the recorded behavior](https://docs.zenml.io/kitaru/guides/returns-agent/observe.md): Verify the prepared returns evidence and select a bounded worklist for human review. - [2. Judge the selected behavior](https://docs.zenml.io/kitaru/guides/returns-agent/judge.md): Create an investigation and store human judgments against exact trace evidence. - [3. Define one behavior to test](https://docs.zenml.io/kitaru/guides/returns-agent/define.md): Turn accepted human evidence into one frozen cohort and evaluator version. - [4. Replay one bounded change](https://docs.zenml.io/kitaru/guides/returns-agent/replay.md): Register one investigation-derived candidate and replay the frozen cohort safely. - [5. Compare the paired evidence](https://docs.zenml.io/kitaru/guides/returns-agent/compare.md): Compare baseline and replay evidence and state the result at the size the cohort supports. - [Replay a failure and fork it](https://docs.zenml.io/kitaru/guides/replay-and-overrides.md): Reproduce a recorded session, fork it with an override, and compare the two, so you can debug a failure or test a change before shipping it. - [Build a regression suite from production](https://docs.zenml.io/kitaru/guides/regression-suite.md): Freeze a cohort of recorded runs, replay it against a change, and use the results in CI. - [Write an evaluator](https://docs.zenml.io/kitaru/guides/write-an-evaluator.md): Turn your domain expert's criteria into a versioned evaluator: code checks, LLM judges, human calibration, and backfilling your history. - [TypeScript and Mastra evaluators](https://docs.zenml.io/kitaru/guides/typescript-evaluators.md): Run TypeScript evaluation code and native Mastra scorers through versioned Kitaru evaluators. - [Write an analyzer](https://docs.zenml.io/kitaru/guides/write-an-analyzer.md): Turn a pattern you'd otherwise eyeball across sessions into a versioned analyzer: the entrypoint contract, a runnable example, and how it runs on import. - [Deterministic evaluations](https://docs.zenml.io/kitaru/guides/deterministic-evaluations.md): Run Kitaru's offline deterministic evaluators over recorded and imported sessions - [Judge evaluations](https://docs.zenml.io/kitaru/guides/judge-evaluations.md): Judge recorded sessions with TypeSafe's jev model by asking your own yes/no, choice, and score questions, one evaluation result per question. - [Tool policies](https://docs.zenml.io/kitaru/guides/tool-policies.md): Choose whether replayed tool calls use recorded results, static results, live tools, or model-generated responses. - [Track cost and model usage](https://docs.zenml.io/kitaru/guides/llm-calls.md): Every model call recorded: tokens, cost, and call counts on every session, and how to total them across cohorts and experiments. - [Overview](https://docs.zenml.io/kitaru/import-your-traces/import-your-traces.md): Bring the traces you already collect. Langfuse stays your system of record, Kitaru gets a runnable copy. - [Post-import insights](https://docs.zenml.io/kitaru/import-your-traces/post-import-insights.md): Generate insights after an import on a local, self-hosted, or managed Kitaru server. - [Langfuse](https://docs.zenml.io/kitaru/import-your-traces/import-langfuse-traces.md): Langfuse JSONL imports end to end: the accepted export, dedup semantics, and how imports execute on your worker. - [LangSmith](https://docs.zenml.io/kitaru/import-your-traces/import-langsmith-traces.md): Turn LangSmith runs into replayable Kitaru sessions: the accepted export shapes, how threads group into sessions, dedup semantics, and what the importer cannot recover. - [Braintrust](https://docs.zenml.io/kitaru/import-your-traces/import-braintrust-traces.md): Import Braintrust project logs into Kitaru: accepted export shapes, how spans become nodes, multi-turn grouping, and what the importer marks as lossy. - [Logfire](https://docs.zenml.io/kitaru/import-your-traces/import-logfire-traces.md): Import Pydantic Logfire records-query exports into Kitaru: accepted export shapes, how OpenTelemetry GenAI spans become nodes, conversation grouping, and what the importer marks as lossy. - [Arize Phoenix](https://docs.zenml.io/kitaru/import-your-traces/import-phoenix-traces.md): Import Arize Phoenix trace exports into Kitaru: supported UI and CLI files, span mapping, source identity, and known limits. - [MLflow](https://docs.zenml.io/kitaru/import-your-traces/import-mlflow-traces.md): Import MLflow traces into Kitaru: accepted export shapes, how MLflow spans become nodes, session grouping, fetching from a tracking server, and what the importer marks as lossy. - [Kitaru JSONL](https://docs.zenml.io/kitaru/import-your-traces/importing-sessions.md): Import provider traces or portable Kitaru session JSONL into a workspace. - [No importer for your format](https://docs.zenml.io/kitaru/import-your-traces/custom-importer.md): No built-in importer for your format? An importer is one Python callable: scaffold it, test it offline, register it, and your export imports like any other. - [Provider connections](https://docs.zenml.io/kitaru/import-your-traces/provider-connections.md): Store provider credentials once on the server and let importer, analyzer, and evaluator tasks pick them up automatically, instead of setting them in every worker's environment. - [Overview](https://docs.zenml.io/kitaru/adapters/adapters.md): One wrapper, no rewrite. Adapters record your existing agent's runs as replayable sessions. - [Record in production](https://docs.zenml.io/kitaru/adapters/record-in-production.md): Take an adapter-wrapped agent to production: register it, give the service its own credential, and know exactly what recording does to your request path. - [Pydantic AI](https://docs.zenml.io/kitaru/adapters/pydantic-ai.md): Wrap any PydanticAI agent once with KitaruAgent. Every run records as a session, and the same wrapper executes replays. - [LangGraph](https://docs.zenml.io/kitaru/adapters/langgraph.md): Record LangGraph, LangChain, and Deep Agents invocations with the kitaru-langgraph adapter package - [OpenAI Agents SDK](https://docs.zenml.io/kitaru/adapters/openai-agents.md): Record and replay non-streaming OpenAI Agents SDK runs with the separately packaged Kitaru v2 adapter - [Claude Agent SDK](https://docs.zenml.io/kitaru/adapters/claude-agent-sdk.md): Record one-shot Claude Agent SDK queries and rerun them with prompt, model, and SDK MCP tool overrides - [Mastra](https://docs.zenml.io/kitaru/adapters/mastra.md): Record Mastra agent runs, import existing trace exports, and replay with recorded conversation context - [Vercel AI SDK](https://docs.zenml.io/kitaru/adapters/vercel-ai.md): Record and replay AI SDK 7 ToolLoopAgent and generateText calls with the Kitaru Vercel AI SDK adapter. - [Importer-backed adapters](https://docs.zenml.io/kitaru/adapters/importer-backed.md): Record runs of an agent that already reports to Langfuse, Braintrust, LangSmith, Logfire, or Arize Phoenix by importing each run's provider trace as a session - [No adapter for your framework](https://docs.zenml.io/kitaru/adapters/custom.md): No adapter for your framework? Import the traces you already have, or generate a project-local adapter with the adapter-builder skill. - [Workers in production](https://docs.zenml.io/kitaru/running-in-production/workers.md): Deploying workers as long-running pools, scoped fleets, and one-shot CI workers, all configured through environment variables. - [Authentication & API keys](https://docs.zenml.io/kitaru/running-in-production/authentication.md): Accounts, logins, and KITKEY\_ API keys, and how people and processes authenticate to your Kitaru server. - [Secrets](https://docs.zenml.io/kitaru/running-in-production/secrets.md): Store credentials once, encrypted at rest, and inject them into replayed agents through agent version run specs. - [Troubleshooting](https://docs.zenml.io/kitaru/get-help/troubleshooting.md): Diagnose connection, worker, and replay problems. - [Configuration](https://docs.zenml.io/kitaru/get-help/configuration.md): Client-side configuration: servers, environment variables, and the precedence between them. - [How to use the SDK](https://docs.zenml.io/kitaru/get-help/sdks.md): One server, two SDKs: the typed async Python client and the framework-neutral TypeScript client, and how each connects and authenticates. - [Contributing](https://docs.zenml.io/kitaru/get-help/contributing.md): How to contribute to Kitaru. ## Learn - [Overview](https://docs.zenml.io/user-guides/readme.md): Guides, examples and projects - [Starter guide](https://docs.zenml.io/user-guides/starter-guide.md): Kickstart your journey into MLOps with the essentials of ZenML. - [Create an ML pipeline](https://docs.zenml.io/user-guides/starter-guide/create-an-ml-pipeline.md): Start with the basics of steps and pipelines. - [Cache previous executions](https://docs.zenml.io/user-guides/starter-guide/cache-previous-executions.md): Iterating quickly with ZenML through caching. - [Manage artifacts](https://docs.zenml.io/user-guides/starter-guide/manage-artifacts.md): Understand and adjust how ZenML versions your data. - [Track ML models](https://docs.zenml.io/user-guides/starter-guide/track-ml-models.md): Creating a full picture of a ML model using the Model Control Plane - [A starter project](https://docs.zenml.io/user-guides/starter-guide/starter-project.md): Put your new knowledge into action with a simple starter project - [Production guide](https://docs.zenml.io/user-guides/production-guide.md): Level up your skills in a production setting. - [Deploying ZenML](https://docs.zenml.io/user-guides/production-guide/deploying-zenml.md): Deploying ZenML is the first step to production. - [Understanding stacks](https://docs.zenml.io/user-guides/production-guide/understand-stacks.md): Learning how to switch the infrastructure backend of your code. - [Connecting remote storage](https://docs.zenml.io/user-guides/production-guide/remote-storage.md): Transitioning to remote artifact storage. - [Orchestrate on the cloud](https://docs.zenml.io/user-guides/production-guide/cloud-orchestration.md): Orchestrate using cloud resources. - [Configure your pipeline to add compute](https://docs.zenml.io/user-guides/production-guide/configure-pipeline.md): Add more resources to your pipeline configuration. - [Configure a code repository](https://docs.zenml.io/user-guides/production-guide/connect-code-repository.md): Connect a Git repository to ZenML to track code changes and collaborate on MLOps projects. - [Set up CI/CD](https://docs.zenml.io/user-guides/production-guide/ci-cd.md): Managing the lifecycle of a ZenML pipeline with Continuous Integration and Delivery - [An end-to-end project](https://docs.zenml.io/user-guides/production-guide/end-to-end.md): Put your new knowledge in action with an end-to-end project - [LLMOps guide](https://docs.zenml.io/user-guides/llmops-guide.md): Leverage the power of LLMs in your MLOps workflows with ZenML. - [RAG with ZenML](https://docs.zenml.io/user-guides/llmops-guide/rag-with-zenml.md): RAG is a sensible way to get started with LLMs. - [RAG in 85 lines of code](https://docs.zenml.io/user-guides/llmops-guide/rag-with-zenml/rag-85-loc.md): Learn how to implement a RAG pipeline in just 85 lines of code. - [Understanding Retrieval-Augmented Generation (RAG)](https://docs.zenml.io/user-guides/llmops-guide/rag-with-zenml/understanding-rag.md): Understand the Retrieval-Augmented Generation (RAG) technique and its benefits. - [Data ingestion and preprocessing](https://docs.zenml.io/user-guides/llmops-guide/rag-with-zenml/data-ingestion.md): Understand how to ingest and preprocess data for RAG pipelines with ZenML. - [Embeddings generation](https://docs.zenml.io/user-guides/llmops-guide/rag-with-zenml/embeddings-generation.md): Generate embeddings to improve retrieval performance. - [Storing embeddings in a vector database](https://docs.zenml.io/user-guides/llmops-guide/rag-with-zenml/storing-embeddings-in-a-vector-database.md): Store embeddings in a vector database for efficient retrieval. - [Basic RAG inference pipeline](https://docs.zenml.io/user-guides/llmops-guide/rag-with-zenml/basic-rag-inference-pipeline.md): Use your RAG components to generate responses to prompts. - [Evaluation and metrics](https://docs.zenml.io/user-guides/llmops-guide/evaluation.md): Track how your RAG pipeline improves using evaluation and metrics. - [Evaluation in 65 lines of code](https://docs.zenml.io/user-guides/llmops-guide/evaluation/evaluation-in-65-loc.md): Learn how to implement evaluation for RAG in just 65 lines of code. - [Retrieval evaluation](https://docs.zenml.io/user-guides/llmops-guide/evaluation/retrieval.md): See how the retrieval component responds to changes in the pipeline. - [Generation evaluation](https://docs.zenml.io/user-guides/llmops-guide/evaluation/generation.md): Evaluate the generation component of your RAG pipeline. - [Evaluation in practice](https://docs.zenml.io/user-guides/llmops-guide/evaluation/evaluation-in-practice.md): Learn how to evaluate the performance of your RAG system in practice. - [Reranking for better retrieval](https://docs.zenml.io/user-guides/llmops-guide/reranking.md): Add reranking to your RAG inference for better retrieval performance. - [Understanding reranking](https://docs.zenml.io/user-guides/llmops-guide/reranking/understanding-reranking.md): Understand how reranking works. - [Implementing reranking in ZenML](https://docs.zenml.io/user-guides/llmops-guide/reranking/implementing-reranking.md): Learn how to implement reranking in ZenML. - [Evaluating reranking performance](https://docs.zenml.io/user-guides/llmops-guide/reranking/evaluating-reranking-performance.md): Evaluate the performance of your reranking model. - [Improve retrieval by finetuning embeddings](https://docs.zenml.io/user-guides/llmops-guide/finetuning-embeddings.md): Finetune embeddings on custom synthetic data to improve retrieval performance. - [Synthetic data generation](https://docs.zenml.io/user-guides/llmops-guide/finetuning-embeddings/synthetic-data-generation.md): Generate synthetic data with distilabel to finetune embeddings. - [Finetuning embeddings with Sentence Transformers](https://docs.zenml.io/user-guides/llmops-guide/finetuning-embeddings/finetuning-embeddings-with-sentence-transformers.md): Finetune embeddings with Sentence Transformers. - [Evaluating finetuned embeddings](https://docs.zenml.io/user-guides/llmops-guide/finetuning-embeddings/evaluating-finetuned-embeddings.md): Evaluate finetuned embeddings and compare to original base embeddings. - [Finetuning LLMs with ZenML](https://docs.zenml.io/user-guides/llmops-guide/finetuning-llms.md): Finetune LLMs for specific tasks or to improve performance and cost. - [Finetuning in 100 lines of code](https://docs.zenml.io/user-guides/llmops-guide/finetuning-llms/finetuning-100-loc.md): Learn how to implement an LLM fine-tuning pipeline in just 100 lines of code. - [Why and when to finetune LLMs](https://docs.zenml.io/user-guides/llmops-guide/finetuning-llms/why-and-when-to-finetune-llms.md): Deciding when is the right time to finetune LLMs. - [Starter choices with finetuning](https://docs.zenml.io/user-guides/llmops-guide/finetuning-llms/starter-choices-for-finetuning-llms.md): Get started with finetuning LLMs by picking a use case and data. - [Finetuning with 🤗 Accelerate](https://docs.zenml.io/user-guides/llmops-guide/finetuning-llms/finetuning-with-accelerate.md): Finetuning an LLM with Accelerate and PEFT - [Evaluation for finetuning](https://docs.zenml.io/user-guides/llmops-guide/finetuning-llms/evaluation-for-finetuning.md) - [Deploying finetuned models](https://docs.zenml.io/user-guides/llmops-guide/finetuning-llms/deploying-finetuned-models.md) - [Next steps](https://docs.zenml.io/user-guides/llmops-guide/finetuning-llms/next-steps.md) - [Managing scheduled pipelines](https://docs.zenml.io/user-guides/tutorial/managing-scheduled-pipelines.md): A step-by-step tutorial on how to create, update, and delete scheduled pipelines in ZenML - [Trigger pipelines from external systems](https://docs.zenml.io/user-guides/tutorial/trigger-pipelines-from-external-systems.md): A step-by-step tutorial on effectively triggering your ZenML pipelines from external systems - [Hyper-parameter tuning](https://docs.zenml.io/user-guides/tutorial/hyper-parameter-tuning.md): Running a hyperparameter tuning trial with ZenML. - [Inspecting past pipeline runs](https://docs.zenml.io/user-guides/tutorial/fetching-pipelines.md): Inspecting a finished pipeline run and its outputs. - [Replaying runs and steps](https://docs.zenml.io/user-guides/tutorial/replaying-runs-steps.md): Re-run pipelines or individual steps using artifacts from a previous execution. - [Train with GPUs](https://docs.zenml.io/user-guides/tutorial/distributed-training.md): Train ZenML pipelines on GPUs and scale out with 🤗 Accelerate. - [Running notebooks remotely](https://docs.zenml.io/user-guides/tutorial/run-remote-notebooks.md): Leveraging Jupyter notebooks with ZenML. - [Managing machine learning datasets](https://docs.zenml.io/user-guides/tutorial/datasets.md): Model datasets using simple abstractions. - [Handling big data](https://docs.zenml.io/user-guides/tutorial/manage-big-data.md): Learn about how to manage big data with ZenML. - [5-minute Quick Wins](https://docs.zenml.io/user-guides/best-practices/quick-wins.md): 5-minute Quick Wins - [Keep Your Dashboard Clean](https://docs.zenml.io/user-guides/best-practices/keep-your-dashboard-server-clean.md): Learn how to keep your pipeline runs clean during development. - [Configure Python environments](https://docs.zenml.io/user-guides/best-practices/configure-python-environments.md): Navigating multiple development environments. - [Shared Components for Teams](https://docs.zenml.io/user-guides/best-practices/shared-components-for-teams.md): Sharing code and libraries within teams. - [Organizing Stacks Pipelines Models](https://docs.zenml.io/user-guides/best-practices/organizing-pipelines-and-models.md): A step-by-step tutorial on effectively organizing your ML assets in ZenML using tags and projects - [Access Management](https://docs.zenml.io/user-guides/best-practices/access-management.md): A guide on managing user roles and responsibilities in ZenML. - [Setting up a Project Repository](https://docs.zenml.io/user-guides/best-practices/set-up-your-repository.md): Setting your team up for success with a well-architected ZenML project. - [Infrastructure as Code with Terraform](https://docs.zenml.io/user-guides/best-practices/iac.md): Best practices for using IaC with ZenML - [Creating Templates for ML Platform](https://docs.zenml.io/user-guides/best-practices/project-templates.md): Setting your team up for success with a well-architected ZenML project. - [Using VS Code extension](https://docs.zenml.io/user-guides/best-practices/vscode-extension.md): Use the ZenML VSCode extension to manage your ZenML server - [Leveraging MCP](https://docs.zenml.io/user-guides/best-practices/mcp-chat-with-server.md): Chat with your ZenML server - [Debugging and Solving Issues](https://docs.zenml.io/user-guides/best-practices/debug-and-solve-issues.md): A guide to debug common issues and get help. - [Choosing an Orchestrator](https://docs.zenml.io/user-guides/best-practices/choose-orchestration-environment.md): How to choose the right orchestration environment ## ZenML Pro - [Introduction](https://docs.zenml.io/pro/readme.md): Learn about the ZenML Pro features and deployment scenarios. - [System Architecture](https://docs.zenml.io/pro/system-architecture.md): Understanding ZenML Pro services and how they communicate. - [Scenarios](https://docs.zenml.io/pro/deployments/scenarios.md): Compare ZenML Pro deployment scenarios to find the right fit for your organization. - [SaaS](https://docs.zenml.io/pro/deployments/scenarios/saas-deployment.md): Learn about ZenML Pro SaaS deployment - the fastest way to get started with production-ready MLOps. - [Hybrid](https://docs.zenml.io/pro/deployments/scenarios/hybrid-deployment.md): Learn about ZenML Pro Hybrid SaaS deployment - balancing control with convenience for enterprise MLOps. - [Self-hosted](https://docs.zenml.io/pro/deployments/scenarios/self-hosted-deployment.md): Learn about ZenML Pro Self-hosted deployment - complete control and data sovereignty for the strictest security requirements. - [Deployment Details](https://docs.zenml.io/pro/deployments/deploy-details.md): Reference documentation for deploying ZenML Pro components. - [Prerequisites](https://docs.zenml.io/pro/deployments/deploy-details/deploy-prerequisites.md): Prepare for deploying the ZenML Pro control plane and/or workspace servers in a self-hosted environment. - [Control Plane](https://docs.zenml.io/pro/deployments/deploy-details/control-plane.md): Configuration reference for the ZenML Control Plane. - [Kubernetes with Helm](https://docs.zenml.io/pro/deployments/deploy-details/control-plane/deploy-control-plane-k8s.md): Deploy ZenML Pro Self-hosted on Kubernetes with Helm - complete self-hosted setup with no external dependencies. - [Workspace Server](https://docs.zenml.io/pro/deployments/deploy-details/workspace-server.md): Configuration reference for the ZenML Workspace Server. - [Enroll Workspaces](https://docs.zenml.io/pro/deployments/deploy-details/workspace-server/enroll-workspace.md): Enroll a ZenML Pro workspace in the ZenML Pro control plane - [Kubernetes with Helm](https://docs.zenml.io/pro/deployments/deploy-details/workspace-server/deploy-workspace-k8s.md): Deploy ZenML Pro workspaces on Kubernetes with Helm and enroll them in the ZenML Pro control plane - [AWS ECS](https://docs.zenml.io/pro/deployments/deploy-details/workspace-server/deploy-workspace-ecs.md): Deploy ZenML Pro Hybrid on AWS ECS with a managed control plane. - [Enable Snapshot Support](https://docs.zenml.io/pro/deployments/deploy-details/workspace-server/deploy-workspace-snapshots.md): Enable snapshot support for self-hosted ZenML Pro workspaces - [Enable Event Triggers and Schedules](https://docs.zenml.io/pro/deployments/deploy-details/workspace-server/deploy-workspace-event-triggers-and-schedules.md): Enable ZenML Pro event triggers and schedules (scheduler and executor microservices) for self-hosted workspace servers on Kubernetes. - [Enable Resource Pools](https://docs.zenml.io/pro/deployments/deploy-details/workspace-server/deploy-workspace-resource-pools.md): Enable the ZenML Pro resource pool reconciler microservice for self-hosted workspace servers on Kubernetes. - [Single Sign-On (SSO)](https://docs.zenml.io/pro/manage/sso.md): Configure Single Sign-On (SSO) authentication for ZenML Pro self-hosted deployments. - [User Accounts](https://docs.zenml.io/pro/manage/user-accounts.md): Understand and manage user accounts in ZenML Pro self-hosted deployments. - [Upgrades and Updates](https://docs.zenml.io/pro/manage/upgrades-updates.md): How to upgrade ZenML Pro components. - [Control Plane](https://docs.zenml.io/pro/manage/upgrades-updates/upgrades-control-plane.md): How to upgrade the ZenML Control Plane. - [Workspace Server](https://docs.zenml.io/pro/manage/upgrades-updates/upgrades-workspace-server.md): How to upgrade ZenML Workspace Servers. - [Hierarchy](https://docs.zenml.io/pro/core-concepts/hierarchy.md): Understanding ZenML's hierarchical structure - [Organizations](https://docs.zenml.io/pro/core-concepts/organization.md): Manage organizations in ZenML - [Workspaces](https://docs.zenml.io/pro/core-concepts/workspaces.md): Learn how to use workspaces in ZenML Pro. - [Projects](https://docs.zenml.io/pro/core-concepts/projects.md): Managing projects in ZenML - [Teams](https://docs.zenml.io/pro/core-concepts/teams.md): Learn about Teams in ZenML Pro and how they can be used to manage groups of users across your organization and workspaces. - [Snapshots](https://docs.zenml.io/pro/core-concepts/snapshots.md): Trigger pipelines from the dashboard, SDK, CLI, or REST API. - [Triggers](https://docs.zenml.io/pro/core-concepts/triggers.md): Trigger pipelines by schedule or event. - [Webhooks](https://docs.zenml.io/pro/core-concepts/webhooks.md): Receive authenticated events from external systems in ZenML. - [Slack](https://docs.zenml.io/pro/core-concepts/webhooks/slack.md): Connect the Slack Events API to a ZenML webhook endpoint. - [GitHub](https://docs.zenml.io/pro/core-concepts/webhooks/github.md): Configure and test GitHub webhook delivery to ZenML. - [ClickUp](https://docs.zenml.io/pro/core-concepts/webhooks/clickup.md): Configure and test ClickUp webhook delivery to ZenML. - [Custom webhooks](https://docs.zenml.io/pro/core-concepts/webhooks/custom.md): Send signed custom events to a ZenML webhook. - [Resource Pools](https://docs.zenml.io/pro/core-concepts/resource-pools.md): Fair GPU and compute sharing for AI/ML teams: dependable production capacity, shared pools, idle reuse, and organization-level resource governance. - [Core Concepts](https://docs.zenml.io/pro/core-concepts/resource-pools/resource-pools-core-concepts.md): Definitions for ZenML Pro resource descriptors, pools, classes, policies, requests, selectors, and leases. - [Admin Guide](https://docs.zenml.io/pro/core-concepts/resource-pools/resource-pools-admin-guide.md): How platform admins configure resource descriptors, pools, classes, target bindings, policies, and grants in ZenML Pro. - [User Guide](https://docs.zenml.io/pro/core-concepts/resource-pools/resource-pools-user-guide.md): How pipeline authors request pooled resources with ResourceSettings and inspect Resource Manager requests. - [External Workloads](https://docs.zenml.io/pro/core-concepts/resource-pools/resource-pools-external-workloads.md): How external workloads use ZenML Pro resource pools through service accounts, direct Resource Manager requests, and priority-lane policies. - [Reconciliation Process](https://docs.zenml.io/pro/core-concepts/resource-pools/resource-pools-reconciliation.md): How resource pool reconciliation, queueing, accounting, preemption, and lease management work at runtime. - [Examples](https://docs.zenml.io/pro/core-concepts/resource-pools/resource-pools-examples.md): End-to-end resource pool use cases for CPU queues, GPU node pools, cloud machine types, licenses, external workloads, governance schedulers, and policy patterns. - [Roles & Permissions](https://docs.zenml.io/pro/access-management/roles.md): Learn about the different roles and permissions you can assign to your team members in ZenML Pro. - [Trusted domains](https://docs.zenml.io/pro/access-management/trusted-domains.md): Organization trusted domains in ZenML Pro — user visibility, invitations, SSO, and how operators configure them. - [Personal Access Tokens](https://docs.zenml.io/pro/access-management/personal-access-tokens.md): Learn how to manage and use Personal Access Tokens. - [Service Accounts](https://docs.zenml.io/pro/access-management/service-accounts.md): Learn how to manage and use service accounts and API keys . - [Secrets Stores](https://docs.zenml.io/pro/access-management/secrets-stores.md): Learn how to link your own secrets store backend to your ZenML Pro workspace. ## Stacks - [Overview](https://docs.zenml.io/stacks/component-guide.md): Overview of categories of MLOps components and third-party integrations. - [Integrations](https://docs.zenml.io/stacks/integrations.md) - [Orchestrators](https://docs.zenml.io/stacks/stack-components/orchestrators.md): Orchestrating the execution of ML pipelines. - [Local Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/local.md): Orchestrating your pipelines to run locally. - [Local Docker Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/local-docker.md): Orchestrating your pipelines to run in Docker. - [Kubeflow Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/kubeflow.md): Orchestrating your pipelines to run on Kubeflow. - [Kubernetes Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/kubernetes.md): Orchestrating your pipelines to run on Kubernetes clusters. - [Modal Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/modal.md): Orchestrating your pipelines to run in Modal Sandboxes. - [Google Cloud VertexAI Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/vertex.md): Orchestrating your pipelines to run on Vertex AI. - [AWS Sagemaker Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/sagemaker.md): Orchestrating your pipelines to run on Amazon Sagemaker. - [AzureML Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/azureml.md): Orchestrating your pipelines to run on AzureML. - [Databricks Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/databricks.md): Orchestrating your pipelines to run on Databricks. - [Tekton Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/tekton.md): Orchestrating your pipelines to run on Tekton. - [Airflow Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/airflow.md): Orchestrating your pipelines to run on Airflow. - [Skypilot VM Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/skypilot-vm.md): Orchestrating your pipelines to run on VMs using SkyPilot. - [SSH Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/ssh.md): Orchestrating your pipelines on a remote host via SSH and Docker. - [HyperAI Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/hyperai.md): Orchestrating your pipelines to run on HyperAI.ai instances. - [Lightning AI Orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/lightning.md): Orchestrating your pipelines to run on Lightning AI. - [Develop a custom orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/custom.md): Learning how to develop a custom orchestrator. - [Deployers](https://docs.zenml.io/stacks/stack-components/deployers.md): Deploy pipelines as HTTP services for real-time execution - [Local Deployer](https://docs.zenml.io/stacks/stack-components/deployers/local.md): Deploying pipelines on your local machine as background processes. - [Docker Deployer](https://docs.zenml.io/stacks/stack-components/deployers/docker.md): Deploying your pipelines locally with Docker. - [Kubernetes Deployer](https://docs.zenml.io/stacks/stack-components/deployers/kubernetes.md): Deploying your pipelines to Kubernetes clusters. - [AWS App Runner Deployer](https://docs.zenml.io/stacks/stack-components/deployers/aws-app-runner.md): Deploying your pipelines to AWS App Runner. - [GCP Cloud Run Deployer](https://docs.zenml.io/stacks/stack-components/deployers/gcp-cloud-run.md): Deploying your pipelines to GCP Cloud Run. - [Hugging Face Deployer](https://docs.zenml.io/stacks/stack-components/deployers/huggingface.md): Deploying your pipelines to Hugging Face Spaces. - [Artifact Stores](https://docs.zenml.io/stacks/stack-components/artifact-stores.md): Setting up a persistent storage for your artifacts. - [Local Artifact Store](https://docs.zenml.io/stacks/stack-components/artifact-stores/local.md): Storing artifacts on your local filesystem. - [Amazon Simple Cloud Storage (S3)](https://docs.zenml.io/stacks/stack-components/artifact-stores/s3.md): Storing artifacts in an AWS S3 bucket. - [Google Cloud Storage (GCS)](https://docs.zenml.io/stacks/stack-components/artifact-stores/gcp.md): Storing artifacts using GCP Cloud Storage. - [Azure Blob Storage](https://docs.zenml.io/stacks/stack-components/artifact-stores/azure.md): Storing artifacts using Azure Blob Storage - [Alibaba Cloud OSS](https://docs.zenml.io/stacks/stack-components/artifact-stores/alibaba-oss.md): Storing artifacts in Alibaba Cloud Object Storage Service (OSS). - [MinIO](https://docs.zenml.io/stacks/stack-components/artifact-stores/minio.md): Storing artifacts in MinIO object storage. - [Backblaze B2](https://docs.zenml.io/stacks/stack-components/artifact-stores/b2.md): Storing artifacts in a Backblaze B2 cloud storage bucket. - [DigitalOcean Spaces](https://docs.zenml.io/stacks/stack-components/artifact-stores/digitalocean.md): Storing artifacts in a DigitalOcean Spaces bucket. - [Develop a custom artifact store](https://docs.zenml.io/stacks/stack-components/artifact-stores/custom.md): Learning how to develop a custom artifact store. - [Container Registries](https://docs.zenml.io/stacks/stack-components/container-registries.md): Setting up a storage for Docker images. - [Default Container Registry](https://docs.zenml.io/stacks/stack-components/container-registries/default.md): Storing container images locally. - [DockerHub](https://docs.zenml.io/stacks/stack-components/container-registries/dockerhub.md): Storing container images in DockerHub. - [Amazon Elastic Container Registry (ECR)](https://docs.zenml.io/stacks/stack-components/container-registries/aws.md): Storing container images in Amazon ECR. - [Google Cloud Container Registry](https://docs.zenml.io/stacks/stack-components/container-registries/gcp.md): Storing container images in GCP. - [Azure Container Registry](https://docs.zenml.io/stacks/stack-components/container-registries/azure.md): Storing container images in Azure. - [GitHub Container Registry](https://docs.zenml.io/stacks/stack-components/container-registries/github.md): Storing container images in GitHub. - [DigitalOcean Container Registry](https://docs.zenml.io/stacks/stack-components/container-registries/digitalocean.md): Storing container images in the DigitalOcean Container Registry. - [Develop a custom container registry](https://docs.zenml.io/stacks/stack-components/container-registries/custom.md): Learning how to develop a custom container registry. - [Log Stores](https://docs.zenml.io/stacks/stack-components/log-stores.md): Storing and retrieving logs from your ML pipelines. - [Artifact Log Store](https://docs.zenml.io/stacks/stack-components/log-stores/artifact.md): Storing logs in your artifact store. - [OpenTelemetry Log Store](https://docs.zenml.io/stacks/stack-components/log-stores/otel.md): Exporting logs to any OpenTelemetry-compatible backend. - [Datadog Log Store](https://docs.zenml.io/stacks/stack-components/log-stores/datadog.md): Exporting logs to Datadog's log management platform. - [Develop a Custom Log Store](https://docs.zenml.io/stacks/stack-components/log-stores/custom.md): Learning how to develop a custom log store. - [Sandboxes](https://docs.zenml.io/stacks/stack-components/sandboxes.md): Isolated code execution for AI agents and tool-use loops. - [Local](https://docs.zenml.io/stacks/stack-components/sandboxes/local.md): A no-isolation subprocess sandbox for development and examples. - [Kubernetes](https://docs.zenml.io/stacks/stack-components/sandboxes/kubernetes.md): Pod-backed sandbox sessions for isolated command execution on Kubernetes. - [Modal](https://docs.zenml.io/stacks/stack-components/sandboxes/modal.md): Running agent code in Modal sandboxes. - [Step Operators](https://docs.zenml.io/stacks/stack-components/step-operators.md): Executing individual steps in specialized environments. - [Amazon SageMaker](https://docs.zenml.io/stacks/stack-components/step-operators/sagemaker.md): Executing individual steps in SageMaker. - [AzureML](https://docs.zenml.io/stacks/stack-components/step-operators/azureml.md): Executing individual steps in AzureML. - [Baseten](https://docs.zenml.io/stacks/stack-components/step-operators/baseten.md): Executing individual steps as Baseten training jobs, including multi-node distributed training. - [Databricks](https://docs.zenml.io/stacks/stack-components/step-operators/databricks.md): Executing individual steps on Databricks. - [Google Cloud VertexAI](https://docs.zenml.io/stacks/stack-components/step-operators/vertex.md): Executing individual steps in Vertex AI. - [Kubernetes](https://docs.zenml.io/stacks/stack-components/step-operators/kubernetes.md): Executing individual steps in Kubernetes Pods. - [Run:AI](https://docs.zenml.io/stacks/stack-components/step-operators/runai.md): Executing individual steps on Run:AI clusters with fractional GPU support. - [Modal](https://docs.zenml.io/stacks/stack-components/step-operators/modal.md): Executing individual steps in Modal. - [SSH](https://docs.zenml.io/stacks/stack-components/step-operators/ssh.md): Executing individual steps on a remote host via SSH and Docker. - [Spark](https://docs.zenml.io/stacks/stack-components/step-operators/spark-kubernetes.md): Executing individual steps on Spark - [Develop a Custom Step Operator](https://docs.zenml.io/stacks/stack-components/step-operators/custom.md): Learning how to develop a custom step operator. - [Experiment Trackers](https://docs.zenml.io/stacks/stack-components/experiment-trackers.md): Logging and visualizing ML experiments. - [Comet](https://docs.zenml.io/stacks/stack-components/experiment-trackers/comet.md): Logging and visualizing experiments with Comet. - [MLflow](https://docs.zenml.io/stacks/stack-components/experiment-trackers/mlflow.md): Logging and visualizing experiments with MLflow. - [Neptune](https://docs.zenml.io/stacks/stack-components/experiment-trackers/neptune.md): Logging and visualizing experiments with neptune.ai - [Weights & Biases](https://docs.zenml.io/stacks/stack-components/experiment-trackers/wandb.md): Logging and visualizing experiments with Weights & Biases. - [Trackio](https://docs.zenml.io/stacks/stack-components/experiment-trackers/trackio.md): Logging and visualizing experiments with Trackio. - [Google Cloud VertexAI Experiment Tracker](https://docs.zenml.io/stacks/stack-components/experiment-trackers/vertexai.md): Logging and visualizing experiments with Vertex AI Experiment Tracker. - [Develop a custom experiment tracker](https://docs.zenml.io/stacks/stack-components/experiment-trackers/custom.md): Learning how to develop a custom experiment tracker. - [Image Builders](https://docs.zenml.io/stacks/stack-components/image-builders.md): Building container images for your ML workflow. - [Local Image Builder](https://docs.zenml.io/stacks/stack-components/image-builders/local.md): Building container images locally. - [Kaniko Image Builder](https://docs.zenml.io/stacks/stack-components/image-builders/kaniko.md): Building container images with Kaniko. - [AWS Image Builder](https://docs.zenml.io/stacks/stack-components/image-builders/aws.md): Building container images with AWS CodeBuild - [Google Cloud Image Builder](https://docs.zenml.io/stacks/stack-components/image-builders/gcp.md): Building container images with Google Cloud Build - [Develop a Custom Image Builder](https://docs.zenml.io/stacks/stack-components/image-builders/custom.md): Learning how to develop a custom image builder. - [Alerters](https://docs.zenml.io/stacks/stack-components/alerters.md): Sending automated alerts to chat services. - [Discord Alerter](https://docs.zenml.io/stacks/stack-components/alerters/discord.md): Sending automated alerts to a Discord channel. - [Slack Alerter](https://docs.zenml.io/stacks/stack-components/alerters/slack.md): Sending automated alerts to a Slack channel. - [Develop a Custom Alerter](https://docs.zenml.io/stacks/stack-components/alerters/custom.md): Learning how to develop a custom alerter. - [Annotators](https://docs.zenml.io/stacks/stack-components/annotators.md): Annotating the data in your workflow. - [Argilla](https://docs.zenml.io/stacks/stack-components/annotators/argilla.md): Annotating data using Argilla. - [Label Studio](https://docs.zenml.io/stacks/stack-components/annotators/label-studio.md): Annotating data using Label Studio. - [Pigeon](https://docs.zenml.io/stacks/stack-components/annotators/pigeon.md): Annotating data using Pigeon. - [Prodigy](https://docs.zenml.io/stacks/stack-components/annotators/prodigy.md): Annotating data using Prodigy. - [Develop a Custom Annotator](https://docs.zenml.io/stacks/stack-components/annotators/custom.md): Learning how to develop a custom annotator. - [Data Validators](https://docs.zenml.io/stacks/stack-components/data-validators.md): How to enhance and maintain the quality of your data and the performance of your models with data profiling and validation - [Great Expectations](https://docs.zenml.io/stacks/stack-components/data-validators/great-expectations.md): How to use Great Expectations to run data quality checks in your pipelines and document the results - [Deepchecks](https://docs.zenml.io/stacks/stack-components/data-validators/deepchecks.md): How to test the data and models used in your pipelines with Deepchecks test suites - [Evidently](https://docs.zenml.io/stacks/stack-components/data-validators/evidently.md): How to keep your data quality in check and guard against data and model drift with Evidently profiling - [Whylogs](https://docs.zenml.io/stacks/stack-components/data-validators/whylogs.md): How to collect and visualize statistics to track changes in your pipelines' data with whylogs/WhyLabs profiling. - [Develop a custom data validator](https://docs.zenml.io/stacks/stack-components/data-validators/custom.md): How to develop a custom data validator - [Feature Stores](https://docs.zenml.io/stacks/stack-components/feature-stores.md): Managing data in feature stores. - [Feast](https://docs.zenml.io/stacks/stack-components/feature-stores/feast.md): Managing data in Feast feature stores. - [Develop a Custom Feature Store](https://docs.zenml.io/stacks/stack-components/feature-stores/custom.md): Learning how to develop a custom feature store. - [Model Deployers](https://docs.zenml.io/stacks/stack-components/model-deployers.md): Deploying your models and serve real-time predictions. - [MLflow](https://docs.zenml.io/stacks/stack-components/model-deployers/mlflow.md): Deploying your models locally with MLflow. - [Seldon](https://docs.zenml.io/stacks/stack-components/model-deployers/seldon.md): Deploying models to Kubernetes with Seldon Core. - [BentoML](https://docs.zenml.io/stacks/stack-components/model-deployers/bentoml.md): Deploying your models locally with BentoML. - [Hugging Face](https://docs.zenml.io/stacks/stack-components/model-deployers/huggingface.md): Deploying models to Huggingface Inference Endpoints with Hugging Face :hugging\_face:. - [Databricks](https://docs.zenml.io/stacks/stack-components/model-deployers/databricks.md): Deploying models to Databricks Inference Endpoints with Databricks - [vLLM](https://docs.zenml.io/stacks/stack-components/model-deployers/vllm.md): Deploying your LLM locally with vLLM. - [Develop a Custom Model Deployer](https://docs.zenml.io/stacks/stack-components/model-deployers/custom.md): Learning how to develop a custom model deployer. - [Model Registries](https://docs.zenml.io/stacks/stack-components/model-registries.md): Tracking and managing ML models. - [MLflow Model Registry](https://docs.zenml.io/stacks/stack-components/model-registries/mlflow.md): Managing MLFlow logged models and artifacts - [Develop a Custom Model Registry](https://docs.zenml.io/stacks/stack-components/model-registries/custom.md): Learning how to develop a custom model registry. - [Introduction](https://docs.zenml.io/stacks/service-connectors/auth-management.md): Connect your ZenML deployment to a cloud provider and other infrastructure services and resources. - [Complete guide](https://docs.zenml.io/stacks/service-connectors/service-connectors-guide.md): The complete guide to managing Service Connectors and connecting ZenML to external resources. - [Best practices](https://docs.zenml.io/stacks/service-connectors/best-security-practices.md): Best practices concerning the various authentication methods implemented by Service Connectors. - [Connector Types](https://docs.zenml.io/stacks/service-connectors/connector-types.md) - [Docker Service Connector](https://docs.zenml.io/stacks/service-connectors/connector-types/docker-service-connector.md): Configuring Docker Service Connectors to connect ZenML to Docker container registries. - [Kubernetes Service Connector](https://docs.zenml.io/stacks/service-connectors/connector-types/kubernetes-service-connector.md): Configuring Kubernetes Service Connectors to connect ZenML to Kubernetes clusters. - [AWS Service Connector](https://docs.zenml.io/stacks/service-connectors/connector-types/aws-service-connector.md): Configuring AWS Service Connectors to connect ZenML to AWS resources like S3 buckets, EKS Kubernetes clusters and ECR container registries. - [GCP Service Connector](https://docs.zenml.io/stacks/service-connectors/connector-types/gcp-service-connector.md): Configuring GCP Service Connectors to connect ZenML to GCP resources such as GCS buckets, GKE Kubernetes clusters, and GCR container registries. - [Azure Service Connector](https://docs.zenml.io/stacks/service-connectors/connector-types/azure-service-connector.md): Configuring Azure Service Connectors to connect ZenML to Azure resources such as Blob storage buckets, AKS Kubernetes clusters, and ACR container registries. - [OAuth2 Service Connector](https://docs.zenml.io/stacks/service-connectors/connector-types/oauth2-service-connector.md): Configuring the OAuth2 Service Connector to connect ZenML to OAuth2-protected HTTP APIs. - [HyperAI Service Connector](https://docs.zenml.io/stacks/service-connectors/connector-types/hyperai-service-connector.md): Configuring HyperAI Connectors to connect ZenML to HyperAI instances. - [AWS](https://docs.zenml.io/stacks/popular-stacks/aws-guide.md): A simple guide to create an AWS stack to run your ZenML pipelines - [Azure](https://docs.zenml.io/stacks/popular-stacks/azure-guide.md): A simple guide to create an Azure stack to run your ZenML pipelines - [GCP](https://docs.zenml.io/stacks/popular-stacks/gcp-guide.md): A simple guide to quickly set up a minimal stack on GCP. - [Kubernetes](https://docs.zenml.io/stacks/popular-stacks/kubernetes.md): Learn how to deploy ZenML pipelines on a Kubernetes cluster. - [1-click Deployment](https://docs.zenml.io/stacks/deployment/deploy-a-cloud-stack.md): Deploy a cloud stack from scratch with a single click - [Terraform Modules](https://docs.zenml.io/stacks/deployment/deploy-a-cloud-stack-with-terraform.md): Deploy a cloud stack using Terraform - [Register a cloud stack](https://docs.zenml.io/stacks/deployment/register-a-cloud-stack.md): Seamlessly register a cloud stack by using existing infrastructure - [Infrastructure as code](https://docs.zenml.io/stacks/deployment/infrastructure-as-code.md): Leverage Infrastructure as Code to manage your ZenML stacks and components. - [Custom Stack Component](https://docs.zenml.io/stacks/contribute/custom-stack-component.md): How to write a custom stack component flavor - [Custom Integration](https://docs.zenml.io/stacks/contribute/implement-a-custom-integration.md): Creating an external integration and contributing to ZenML ## API Reference - [Overview](https://docs.zenml.io/api-reference/readme.md): The ZenML API provides programmatic access to ZenML services beyond what's available in the Python SDK. - [Getting Started](https://docs.zenml.io/api-reference/oss-api/getting-started.md) - [OSS API](https://docs.zenml.io/api-reference/oss-api/oss-api.md) - [Artifacts](https://docs.zenml.io/api-reference/oss-api/oss-api/artifacts.md) - [Artifact versions](https://docs.zenml.io/api-reference/oss-api/oss-api/artifact-versions.md) - [Batch](https://docs.zenml.io/api-reference/oss-api/oss-api/artifact-versions/batch.md) - [Visualize](https://docs.zenml.io/api-reference/oss-api/oss-api/artifact-versions/visualize.md) - [Login](https://docs.zenml.io/api-reference/oss-api/oss-api/login.md) - [Logout](https://docs.zenml.io/api-reference/oss-api/oss-api/logout.md) - [Device authorization](https://docs.zenml.io/api-reference/oss-api/oss-api/device-authorization.md) - [Api token](https://docs.zenml.io/api-reference/oss-api/oss-api/api-token.md) - [Code repositories](https://docs.zenml.io/api-reference/oss-api/oss-api/code-repositories.md) - [Logs](https://docs.zenml.io/api-reference/oss-api/oss-api/logs.md) - [Models](https://docs.zenml.io/api-reference/oss-api/oss-api/models.md) - [Model versions](https://docs.zenml.io/api-reference/oss-api/oss-api/models/model-versions.md) - [Model versions](https://docs.zenml.io/api-reference/oss-api/oss-api/model-versions.md) - [Artifacts](https://docs.zenml.io/api-reference/oss-api/oss-api/model-versions/artifacts.md) - [Runs](https://docs.zenml.io/api-reference/oss-api/oss-api/model-versions/runs.md) - [Pipelines](https://docs.zenml.io/api-reference/oss-api/oss-api/pipelines.md) - [Runs](https://docs.zenml.io/api-reference/oss-api/oss-api/pipelines/runs.md) - [Runs](https://docs.zenml.io/api-reference/oss-api/oss-api/runs.md) - [Steps](https://docs.zenml.io/api-reference/oss-api/oss-api/runs/steps.md) - [Pipeline configuration](https://docs.zenml.io/api-reference/oss-api/oss-api/runs/pipeline-configuration.md) - [Status](https://docs.zenml.io/api-reference/oss-api/oss-api/runs/status.md) - [Refresh](https://docs.zenml.io/api-reference/oss-api/oss-api/runs/refresh.md) - [Run templates](https://docs.zenml.io/api-reference/oss-api/oss-api/run-templates.md) - [Runs](https://docs.zenml.io/api-reference/oss-api/oss-api/run-templates/runs.md) - [Schedules](https://docs.zenml.io/api-reference/oss-api/oss-api/schedules.md) - [Secrets](https://docs.zenml.io/api-reference/oss-api/oss-api/secrets.md) - [Info](https://docs.zenml.io/api-reference/oss-api/oss-api/info.md) - [Service accounts](https://docs.zenml.io/api-reference/oss-api/oss-api/service-accounts.md) - [Api keys](https://docs.zenml.io/api-reference/oss-api/oss-api/service-accounts/api-keys.md) - [Rotate](https://docs.zenml.io/api-reference/oss-api/oss-api/service-accounts/rotate.md) - [Service connectors](https://docs.zenml.io/api-reference/oss-api/oss-api/service-connectors.md) - [Verify](https://docs.zenml.io/api-reference/oss-api/oss-api/service-connectors/verify.md) - [Client](https://docs.zenml.io/api-reference/oss-api/oss-api/service-connectors/client.md) - [Full stack resources](https://docs.zenml.io/api-reference/oss-api/oss-api/service-connectors/full-stack-resources.md) - [Services](https://docs.zenml.io/api-reference/oss-api/oss-api/services.md) - [Stacks](https://docs.zenml.io/api-reference/oss-api/oss-api/stacks.md) - [Components](https://docs.zenml.io/api-reference/oss-api/oss-api/components.md) - [Component types](https://docs.zenml.io/api-reference/oss-api/oss-api/component-types.md) - [Steps](https://docs.zenml.io/api-reference/oss-api/oss-api/steps.md) - [Step configuration](https://docs.zenml.io/api-reference/oss-api/oss-api/steps/step-configuration.md) - [Status](https://docs.zenml.io/api-reference/oss-api/oss-api/steps/status.md) - [Logs](https://docs.zenml.io/api-reference/oss-api/oss-api/steps/logs.md) - [Tags](https://docs.zenml.io/api-reference/oss-api/oss-api/tags.md) - [Users](https://docs.zenml.io/api-reference/oss-api/oss-api/users.md) - [Resource membership](https://docs.zenml.io/api-reference/oss-api/oss-api/users/resource-membership.md) - [Current user](https://docs.zenml.io/api-reference/oss-api/oss-api/current-user.md) - [Getting Started](https://docs.zenml.io/api-reference/pro-api/getting-started.md) - [Pro API](https://docs.zenml.io/api-reference/pro-api/pro-api.md) - [Tenants](https://docs.zenml.io/api-reference/pro-api/pro-api/tenants.md) - [Deploy](https://docs.zenml.io/api-reference/pro-api/pro-api/tenants/deploy.md) - [Deactivate](https://docs.zenml.io/api-reference/pro-api/pro-api/tenants/deactivate.md) - [Members](https://docs.zenml.io/api-reference/pro-api/pro-api/tenants/members.md) - [Tenant status](https://docs.zenml.io/api-reference/pro-api/pro-api/tenant-status.md) - [Users](https://docs.zenml.io/api-reference/pro-api/pro-api/users.md) - [Authorize server](https://docs.zenml.io/api-reference/pro-api/pro-api/users/authorize-server.md) - [Me](https://docs.zenml.io/api-reference/pro-api/pro-api/users/me.md) - [Invitations](https://docs.zenml.io/api-reference/pro-api/pro-api/invitations.md) - [Releases](https://docs.zenml.io/api-reference/pro-api/pro-api/releases.md) - [Devices](https://docs.zenml.io/api-reference/pro-api/pro-api/devices.md) - [Verify](https://docs.zenml.io/api-reference/pro-api/pro-api/devices/verify.md) - [Roles](https://docs.zenml.io/api-reference/pro-api/pro-api/roles.md) - [Assignments](https://docs.zenml.io/api-reference/pro-api/pro-api/roles/assignments.md) - [Permissions](https://docs.zenml.io/api-reference/pro-api/pro-api/permissions.md) - [Teams](https://docs.zenml.io/api-reference/pro-api/pro-api/teams.md) - [Members](https://docs.zenml.io/api-reference/pro-api/pro-api/teams/members.md) - [Organizations](https://docs.zenml.io/api-reference/pro-api/pro-api/organizations.md) - [Trial](https://docs.zenml.io/api-reference/pro-api/pro-api/organizations/trial.md) - [Invitations](https://docs.zenml.io/api-reference/pro-api/pro-api/organizations/invitations.md) - [Members](https://docs.zenml.io/api-reference/pro-api/pro-api/organizations/members.md) - [Roles](https://docs.zenml.io/api-reference/pro-api/pro-api/organizations/roles.md) - [Teams](https://docs.zenml.io/api-reference/pro-api/pro-api/organizations/teams.md) - [Tenants](https://docs.zenml.io/api-reference/pro-api/pro-api/organizations/tenants.md) - [Tenant](https://docs.zenml.io/api-reference/pro-api/pro-api/organizations/tenant.md) - [Entitlement](https://docs.zenml.io/api-reference/pro-api/pro-api/organizations/entitlement.md) - [Validation](https://docs.zenml.io/api-reference/pro-api/pro-api/organizations/validation.md) - [Name](https://docs.zenml.io/api-reference/pro-api/pro-api/organizations/validation/name.md) - [Tenant name](https://docs.zenml.io/api-reference/pro-api/pro-api/organizations/validation/tenant-name.md) - [Health](https://docs.zenml.io/api-reference/pro-api/pro-api/health.md) - [Usage event](https://docs.zenml.io/api-reference/pro-api/pro-api/usage-event.md) - [Usage batch](https://docs.zenml.io/api-reference/pro-api/pro-api/usage-batch.md) - [Stigg webhook](https://docs.zenml.io/api-reference/pro-api/pro-api/stigg-webhook.md) - [Auth](https://docs.zenml.io/api-reference/pro-api/pro-api/auth.md) - [Login](https://docs.zenml.io/api-reference/pro-api/pro-api/auth/login.md) - [Connections](https://docs.zenml.io/api-reference/pro-api/pro-api/auth/connections.md) - [Authorize](https://docs.zenml.io/api-reference/pro-api/pro-api/auth/authorize.md) - [Callback](https://docs.zenml.io/api-reference/pro-api/pro-api/auth/callback.md) - [Logout](https://docs.zenml.io/api-reference/pro-api/pro-api/auth/logout.md) - [Device authorization](https://docs.zenml.io/api-reference/pro-api/pro-api/auth/device-authorization.md) - [Api token](https://docs.zenml.io/api-reference/pro-api/pro-api/auth/api-token.md) - [Tenant authorization](https://docs.zenml.io/api-reference/pro-api/pro-api/auth/tenant-authorization.md) - [Rbac](https://docs.zenml.io/api-reference/pro-api/pro-api/rbac.md) - [Check permissions](https://docs.zenml.io/api-reference/pro-api/pro-api/rbac/check-permissions.md) - [Allowed resource ids](https://docs.zenml.io/api-reference/pro-api/pro-api/rbac/allowed-resource-ids.md) - [Resource members](https://docs.zenml.io/api-reference/pro-api/pro-api/rbac/resource-members.md) - [Server](https://docs.zenml.io/api-reference/pro-api/pro-api/server.md) - [Info](https://docs.zenml.io/api-reference/pro-api/pro-api/server/info.md) ## SDK Reference - [Overview](https://docs.zenml.io/sdk-reference/readme.md): Reference hub for the ZenML and Kitaru SDKs and CLIs. - [Client](https://docs.zenml.io/sdk-reference/zenml/client.md) - [Example usages](https://docs.zenml.io/sdk-reference/zenml/example-usages.md): Interacting with your ZenML instance through the ZenML Client. - [Python client](https://docs.zenml.io/sdk-reference/kitaru/client.md) - [Python examples](https://docs.zenml.io/sdk-reference/kitaru/example-usages.md) ## Changelog - [Overview](https://docs.zenml.io/changelog/readme.md): Stay up to date with the latest features, improvements, and fixes across ZenML OSS and ZenML Pro. - [Server & SDK](https://docs.zenml.io/changelog/server-sdk.md): Changelog for ZenML OSS and ZenML UI. - [Pro Control Plane](https://docs.zenml.io/changelog/pro-control-plane.md): Changelog for ZenML Pro. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation This site has an agentic ask interface you may use to query the documentation dynamically by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.zenml.io/index.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.