Preview Flyte 2 for production, hosted on Union.ai
Register now
↗
Union.ai Docs
Union.ai
Flyte OSS
v2
LATEST
v2
LATEST
v1
Search
⌘
K
Ask AI
⇧
⌘
K
Support
Signup
User guide
Tutorials
Reference
Integrations
Platform deployment
Security
Community
Release notes
Union.ai Docs
User guide
Overview
Quickstart
Core concepts
TaskEnvironment
Tasks
Runs and actions
Apps
Projects and domains
Key capabilities
Basic project
Run modes
Running locally
Running on the devbox
Running on a remote cluster
Configure tasks
Container images
Resources
Secrets
Caching
Reusable containers
Pod templates
Multiple environments
Retries and timeouts
Triggers
Interruptible tasks and queues
Task plugins
Additional task settings
Build tasks
Files and directories
Data classes and structures
DataFrames
Custom types
Custom context
Abort and cancel actions
Raw Container Tasks
Links
Reports
Notebooks
Remote tasks
Error handling
Traces
Grouping actions
Fanout
Controlling parallel execution
Human-in-the-loop
Unit Testing Tasks
Other features
Run and deploy tasks
How task run works
Interact with runs and actions
Work with local data
Run command options
How task deployment works
Deploy command options
Packaging
Running Tasks via Webhooks
Deployment patterns
Run context
Entrypoint tasks
Run a Python script
Configure apps
App environments
Including additional files
Passing parameters into app environments
Autoscaling apps
Apps depending on other environments
Build apps
Single-script apps
Multi-script apps
Serving graphs
Hybrid app-task graphs
WebSocket apps
Browser apps
Secret-based authentication
Connector app
Native app integrations
Streamlit app
FastAPI app
vLLM app
SGLang app
Flyte webhook
Serve and deploy apps
How app serving works
How app custom domains work
How app deployment works
Activating and deactivating apps
Prefetching models
Build an agent
Building agentic workflows
Deploy an agent as a service
Sandboxing
Workflow sandboxing
Programmatic tool calling for agents
Code sandboxing
Authenticating
User management
Project patterns
Bring your own image (BYOI)
Monorepo with uv
CI/CD deployments
Resource management and multi-team scaling
Scale your runs
Data flow
Life of a run
Scale your workflows
Batch inference
Advanced project
Resilient generation
Agentic refinement
Parallel outputs
Serving app
Migration
From Flyte 1 to 2
Pure Python
Asynchronous model
Migration
Considerations
From Airflow to Flyte
Part 1 — Vanilla Operators
Tutorials
Distributed LLM pretraining
Fine-tuning a vision-language model with a frozen backbone
GPU-accelerated climate modeling
MLE Bot
Multi-agent trading simulation
Run LLM-generated code
Text-to-SQL
Automatic prompt engineering
Batching strategies
Deep research
Satellite Image Classification with EfficientNet
Hyperparameter optimization
Reference
LLM-optimized documentation
Migration from Flyte 1
Philosophy and imports
Container images
Configuration and CLI
Tasks and workflows
Secrets, resources, and caching
Parallelism and async
Triggers and dynamic workflows
Examples and common gotchas
Flyte CLI
Flyte SDK
Classes & Protocols
Packages
flyte
AppHandle
BaseCheckpoint
Cache
CachePolicy
Checkpoint
Cron
Device
Environment
FixedRate
Image
ImageBuild
Link
PodTemplate
Resources
RetryStrategy
ReusePolicy
Secret
TaskEnvironment
Timeout
Trigger
flyte.ai.agents
Agent
AgentResult
CodeModeAgent
flyte.ai.agents.codemode
CodeModeAgent
flyte.ai.agents.protocol
Agent
AgentResult
flyte.ai.chat
AgentChatAppEnvironment
CustomTheme
flyte.ai.chat.app
AgentChatAppEnvironment
CustomTheme
flyte.ai.mcp
FlyteMCPAppEnvironment
MCPAppEnvironment
flyte.app
AppEndpoint
AppEnvironment
ConnectorEnvironment
Domain
Link
Parameter
Port
RunOutput
Scaling
Timeouts
flyte.app.extras
FastAPIAppEnvironment
FastAPIPassthroughAuthMiddleware
FlyteWebhookAppEnvironment
flyte.config
Config
flyte.connectors
AsyncConnector
AsyncConnectorExecutorMixin
ConnectorRegistry
ConnectorService
Resource
ResourceMeta
flyte.connectors.utils
flyte.durable
flyte.errors
ActionAbortedError
ActionNotFoundError
BaseRuntimeError
CodeBundleError
CustomError
DeploymentError
ImageBuildError
ImagePullBackOffError
InitializationError
InlineIOMaxBytesBreached
InvalidImageNameError
InvalidPackageError
LogsNotYetAvailableError
ModuleLoadError
NonRecoverableError
NotInTaskContextError
OnlyAsyncIOSupportedError
OOMError
ParameterMaterializationError
PrimaryContainerNotFoundError
RemoteTaskNotFoundError
RemoteTaskUsageError
RestrictedTypeError
RetriesExhaustedError
RuntimeDataValidationError
RuntimeSystemError
RuntimeUnknownError
RuntimeUserError
SlowDownError
TaskInterruptedError
TaskTimeoutError
TraceDoesNotAllowNestedTasksError
UnionRpcError
flyte.extend
AsyncFunctionTaskTemplate
ImageBuildEngine
ImageBuilder
ImageChecker
TaskTemplate
flyte.extras
BatchStats
ContainerTask
CostEstimator
DynamicBatcher
Prompt
Sleep
SleepTask
TokenBatcher
TokenEstimator
flyte.git
GitStatus
flyte.io
DataFrame
Dir
EmptyDir
File
HashFunction
flyte.io.extend
DataFrameDecoder
DataFrameEncoder
DataFrameTransformerEngine
flyte.models
ActionID
ActionPhase
CheckpointPaths
CodeBundle
GroupData
NativeInterface
PathRewrite
RawDataPath
SerializationContext
TaskContext
flyte.notify
Email
NamedDelivery
NamedRule
Notification
Slack
Teams
Webhook
flyte.prefetch
HuggingFaceModelInfo
ShardConfig
StoredModelInfo
VLLMShardArgs
flyte.remote
Action
ActionDetails
ActionInputs
ActionOutputs
App
Project
Run
RunDetails
Secret
Settings
Task
TaskDetails
TimeFilter
Trigger
User
flyte.report
Report
flyte.sandbox
CodeTaskTemplate
ImageConfig
SandboxedConfig
SandboxedTaskTemplate
flyte.storage
ABFS
GCS
S3
Storage
flyte.syncify
Syncify
flyte.types
FlytePickle
Renderable
TypeEngine
TypeTransformer
TypeTransformerFailedError
Integrations
Anthropic
Classes
Packages
flyteplugins.anthropic
Agent
BigQuery
Classes
Packages
flyteplugins.bigquery
BigQueryConfig
BigQueryConnector
BigQueryTask
Code generation
Classes
Packages
flyteplugins.codegen
AutoCoderAgent
CodeGenEvalResult
CodePlan
CodeSolution
ErrorDiagnosis
ImageConfig
Dask
Classes
Packages
flyteplugins.dask
Dask
Scheduler
WorkerGroup
Databricks
Classes
Packages
flyteplugins.databricks
Databricks
DatabricksConnector
Gemini
Classes
Packages
flyteplugins.gemini
Agent
Human-in-the-Loop
Classes
Packages
flyteplugins.hitl
Event
Hydra
flyteplugins.hydra
JSONL
Classes
Packages
flyteplugins.jsonl
JsonlDir
JsonlFile
MLflow
Classes
Packages
flyteplugins.mlflow
Mlflow
OmegaConf
flyteplugins.omegaconf
OpenAI
flyteplugins.openai.agents
Papermill
Classes
Packages
flyteplugins.papermill
NotebookTask
Polars
Classes
Packages
flyteplugins.polars.df_transformer
ParquetToPolarsDecodingHandler
ParquetToPolarsLazyFrameDecodingHandler
PolarsLazyFrameToParquetEncodingHandler
PolarsToParquetEncodingHandler
PyTorch
Classes
Packages
flyteplugins.pytorch
Elastic
Ray
Classes
Packages
flyteplugins.ray
HeadNodeConfig
RayJobConfig
WorkerNodeConfig
SGLang
Classes
Packages
flyteplugins.sglang
SGLangAppEnvironment
Snowflake
Classes
Packages
flyteplugins.snowflake
Snowflake
SnowflakeConfig
SnowflakeConnector
Spark
Classes
Packages
flyteplugins.spark
ParquetToSparkDecoder
Spark
SparkToParquetEncoder
Union
Classes
Packages
flyteplugins.union.cli
flyteplugins.union.cli.queue
flyteplugins.union.internal.validate.validate.validate_pb2
flyteplugins.union.remote
ApiKey
Assignment
Cluster
Member
Policy
Queue
Role
User
flyteplugins.union.utils.auth
AppClientCredentials
vLLM
Classes
Packages
flyteplugins.vllm
VLLMAppEnvironment
Weights & Biases
Classes
Packages
flyteplugins.wandb
Wandb
WandbSweep
Uctl CLI
uctl
uctl version
uctl append
uctl append identityassignments
uctl apply
uctl apply app
uctl apply clusterconfig
uctl apply clusterconfigid
uctl apply clusterpoolconfig
uctl config
uctl config discover
uctl config docs
uctl config init
uctl config validate
uctl create
uctl create app
uctl create clusterpool
uctl create clusterpoolassignment
uctl create execution
uctl create policy
uctl create project
uctl create role
uctl delete
uctl delete app
uctl delete cluster
uctl delete cluster-pool-attributes
uctl delete cluster-resource-attribute
uctl delete clusterconfig
uctl delete clusterpool
uctl delete clusterpoolassignment
uctl delete execution
uctl delete execution-cluster-label
uctl delete execution-queue-attribute
uctl delete identityassignments
uctl delete plugin-override
uctl delete policy
uctl delete role
uctl delete task-resource-attribute
uctl delete workflow-execution-config
uctl demo
uctl demo exec
uctl demo reload
uctl demo start
uctl demo status
uctl demo teardown
uctl get
uctl get app
uctl get cluster
uctl get cluster-pool-attributes
uctl get cluster-resource-attribute
uctl get clusterconfig
uctl get clusterconfigs
uctl get clusterpool
uctl get clusterpoolconfig
uctl get clusterswithconfig
uctl get echo
uctl get execution
uctl get execution-cluster-label
uctl get execution-queue-attribute
uctl get executionoperation
uctl get identityassignment
uctl get launchplan
uctl get plugin-override
uctl get policy
uctl get project
uctl get role
uctl get task
uctl get task-resource-attribute
uctl get workflow
uctl get workflow-execution-config
uctl register
uctl register examples
uctl register files
uctl update
uctl update cluster-pool-attributes
uctl update cluster-resource-attribute
uctl update execution
uctl update execution-cluster-label
uctl update execution-queue-attribute
uctl update launchplan
uctl update launchplan-meta
uctl update plugin-override
uctl update project
uctl update task-meta
uctl update task-resource-attribute
uctl update workflow-execution-config
uctl update workflow-meta
Integrations
Anthropic
BigQuery
Code generation
Dask
Databricks
Gemini
Hydra
MLflow
OmegaConf
OpenAI
Agent tools
Pandera
Papermill
PyTorch
Ray
Snowflake
Spark
Weights & Biases
Experiments
Distributed training
Sweeps
Downloading logs
Constraints and best practices
Manual integration
Platform deployment
BYOC deployment
Platform architecture
Configuring your data plane
Multi-cluster and multi-cloud
Data plane setup on AWS
Data plane setup on GCP
Data plane setup on Azure
Data retention policy
Enabling AWS resources
Enabling AWS S3
Enabling AWS ECR
Enabling AWS Secrets Manager
Enabling GCP resources
Enabling Google Cloud Storage
Enabling Google Artifact Registry
Enabling Google Secret Manager
Enabling BigQuery
Enabling Azure resources
Enabling Azure Blob Storage
Enabling Azure Container Registry (ACR)
Enabling Azure Key Vault
Single sign on setup
Google OpenID Connect
Microsoft Entra ID (formerly Azure AD)
Other identity providers
Self-managed deployment
Architecture
Overview
Kubernetes Access Controls
Cluster Recommendations
Data plane setup on generic Kubernetes
Prepare infrastructure
Deploy the dataplane
Data plane setup on AWS
Prepare infrastructure
Deploy the dataplane
Data plane setup on GCP
Prepare infrastructure
Deploy the dataplane
Data plane setup on Azure
Prepare infrastructure
Deploy the dataplane
Data plane setup on OCI
Prepare infrastructure
Deploy the dataplane
Data plane setup on CoreWeave
Prepare infrastructure
Deploy the dataplane
Configuration
Node Pools
Authentication
Code Viewer
Image Builder
Multiple Clusters
Persistent logs
Monitoring
Secrets
Data retention policies
Compute plugins
Namespace mapping
Helm chart reference
Dataplane chart
Knative Operator chart
Manage Union through Terraform
Installation
Resource Management
Security Best Practices
Security
Architecture
Two-plane separation
Control plane
Data plane
Network architecture
Private connectivity (BYOC)
Deployment models
Data protection
Data classification and residency
Data flow
Encryption
Secrets management
Workflow data flow
Multi-cloud support
Logging and audit
Identity and access
Authentication
Role-based access control
Tenant isolation
Human access controls
Threat model
Compliance and governance
Certifications and Trust Center
HIPAA compliance
GDPR alignment
Standards compliance
Shared responsibility model
Organizational security
Vulnerability management
Community
Contributing docs and examples
Quick start
Variants
Versions
Authoring
Shortcodes
Redirects
API docs
LLM-optimized documentation
Publishing
Release notes
Documentation navigation for Union including user guides, tutorials, API references, and integration examples
LLM-optimized documentation
Migration from Flyte 1
Philosophy and imports
Container images
Configuration and CLI
Tasks and workflows
Secrets, resources, and caching
Parallelism and async
Triggers and dynamic workflows
Examples and common gotchas
Flyte CLI
Flyte SDK
Classes & Protocols
Packages
flyte
AppHandle
BaseCheckpoint
Cache
CachePolicy
Checkpoint
Cron
Device
Environment
FixedRate
Image
ImageBuild
Link
PodTemplate
Resources
RetryStrategy
ReusePolicy
Secret
TaskEnvironment
Timeout
Trigger
flyte.ai.agents
Agent
AgentResult
CodeModeAgent
flyte.ai.agents.codemode
CodeModeAgent
flyte.ai.agents.protocol
Agent
AgentResult
flyte.ai.chat
AgentChatAppEnvironment
CustomTheme
flyte.ai.chat.app
AgentChatAppEnvironment
CustomTheme
flyte.ai.mcp
FlyteMCPAppEnvironment
MCPAppEnvironment
flyte.app
AppEndpoint
AppEnvironment
ConnectorEnvironment
Domain
Link
Parameter
Port
RunOutput
Scaling
Timeouts
flyte.app.extras
FastAPIAppEnvironment
FastAPIPassthroughAuthMiddleware
FlyteWebhookAppEnvironment
flyte.config
Config
flyte.connectors
AsyncConnector
AsyncConnectorExecutorMixin
ConnectorRegistry
ConnectorService
Resource
ResourceMeta
flyte.connectors.utils
flyte.durable
flyte.errors
ActionAbortedError
ActionNotFoundError
BaseRuntimeError
CodeBundleError
CustomError
DeploymentError
ImageBuildError
ImagePullBackOffError
InitializationError
InlineIOMaxBytesBreached
InvalidImageNameError
InvalidPackageError
LogsNotYetAvailableError
ModuleLoadError
NonRecoverableError
NotInTaskContextError
OnlyAsyncIOSupportedError
OOMError
ParameterMaterializationError
PrimaryContainerNotFoundError
RemoteTaskNotFoundError
RemoteTaskUsageError
RestrictedTypeError
RetriesExhaustedError
RuntimeDataValidationError
RuntimeSystemError
RuntimeUnknownError
RuntimeUserError
SlowDownError
TaskInterruptedError
TaskTimeoutError
TraceDoesNotAllowNestedTasksError
UnionRpcError
flyte.extend
AsyncFunctionTaskTemplate
ImageBuildEngine
ImageBuilder
ImageChecker
TaskTemplate
flyte.extras
BatchStats
ContainerTask
CostEstimator
DynamicBatcher
Prompt
Sleep
SleepTask
TokenBatcher
TokenEstimator
flyte.git
GitStatus
flyte.io
DataFrame
Dir
EmptyDir
File
HashFunction
flyte.io.extend
DataFrameDecoder
DataFrameEncoder
DataFrameTransformerEngine
flyte.models
ActionID
ActionPhase
CheckpointPaths
CodeBundle
GroupData
NativeInterface
PathRewrite
RawDataPath
SerializationContext
TaskContext
flyte.notify
Email
NamedDelivery
NamedRule
Notification
Slack
Teams
Webhook
flyte.prefetch
HuggingFaceModelInfo
ShardConfig
StoredModelInfo
VLLMShardArgs
flyte.remote
Action
ActionDetails
ActionInputs
ActionOutputs
App
Project
Run
RunDetails
Secret
Settings
Task
TaskDetails
TimeFilter
Trigger
User
flyte.report
Report
flyte.sandbox
CodeTaskTemplate
ImageConfig
SandboxedConfig
SandboxedTaskTemplate
flyte.storage
ABFS
GCS
S3
Storage
flyte.syncify
Syncify
flyte.types
FlytePickle
Renderable
TypeEngine
TypeTransformer
TypeTransformerFailedError
Integrations
Anthropic
Classes
Packages
flyteplugins.anthropic
Agent
BigQuery
Classes
Packages
flyteplugins.bigquery
BigQueryConfig
BigQueryConnector
BigQueryTask
Code generation
Classes
Packages
flyteplugins.codegen
AutoCoderAgent
CodeGenEvalResult
CodePlan
CodeSolution
ErrorDiagnosis
ImageConfig
Dask
Classes
Packages
flyteplugins.dask
Dask
Scheduler
WorkerGroup
Databricks
Classes
Packages
flyteplugins.databricks
Databricks
DatabricksConnector
Gemini
Classes
Packages
flyteplugins.gemini
Agent
Human-in-the-Loop
Classes
Packages
flyteplugins.hitl
Event
Hydra
flyteplugins.hydra
JSONL
Classes
Packages
flyteplugins.jsonl
JsonlDir
JsonlFile
MLflow
Classes
Packages
flyteplugins.mlflow
Mlflow
OmegaConf
flyteplugins.omegaconf
OpenAI
flyteplugins.openai.agents
Papermill
Classes
Packages
flyteplugins.papermill
NotebookTask
Polars
Classes
Packages
flyteplugins.polars.df_transformer
ParquetToPolarsDecodingHandler
ParquetToPolarsLazyFrameDecodingHandler
PolarsLazyFrameToParquetEncodingHandler
PolarsToParquetEncodingHandler
PyTorch
Classes
Packages
flyteplugins.pytorch
Elastic
Ray
Classes
Packages
flyteplugins.ray
HeadNodeConfig
RayJobConfig
WorkerNodeConfig
SGLang
Classes
Packages
flyteplugins.sglang
SGLangAppEnvironment
Snowflake
Classes
Packages
flyteplugins.snowflake
Snowflake
SnowflakeConfig
SnowflakeConnector
Spark
Classes
Packages
flyteplugins.spark
ParquetToSparkDecoder
Spark
SparkToParquetEncoder
Union
Classes
Packages
flyteplugins.union.cli
flyteplugins.union.cli.queue
flyteplugins.union.internal.validate.validate.validate_pb2
flyteplugins.union.remote
ApiKey
Assignment
Cluster
Member
Policy
Queue
Role
User
flyteplugins.union.utils.auth
AppClientCredentials
vLLM
Classes
Packages
flyteplugins.vllm
VLLMAppEnvironment
Weights & Biases
Classes
Packages
flyteplugins.wandb
Wandb
WandbSweep
Uctl CLI
uctl
uctl version
uctl append
uctl append identityassignments
uctl apply
uctl apply app
uctl apply clusterconfig
uctl apply clusterconfigid
uctl apply clusterpoolconfig
uctl config
uctl config discover
uctl config docs
uctl config init
uctl config validate
uctl create
uctl create app
uctl create clusterpool
uctl create clusterpoolassignment
uctl create execution
uctl create policy
uctl create project
uctl create role
uctl delete
uctl delete app
uctl delete cluster
uctl delete cluster-pool-attributes
uctl delete cluster-resource-attribute
uctl delete clusterconfig
uctl delete clusterpool
uctl delete clusterpoolassignment
uctl delete execution
uctl delete execution-cluster-label
uctl delete execution-queue-attribute
uctl delete identityassignments
uctl delete plugin-override
uctl delete policy
uctl delete role
uctl delete task-resource-attribute
uctl delete workflow-execution-config
uctl demo
uctl demo exec
uctl demo reload
uctl demo start
uctl demo status
uctl demo teardown
uctl get
uctl get app
uctl get cluster
uctl get cluster-pool-attributes
uctl get cluster-resource-attribute
uctl get clusterconfig
uctl get clusterconfigs
uctl get clusterpool
uctl get clusterpoolconfig
uctl get clusterswithconfig
uctl get echo
uctl get execution
uctl get execution-cluster-label
uctl get execution-queue-attribute
uctl get executionoperation
uctl get identityassignment
uctl get launchplan
uctl get plugin-override
uctl get policy
uctl get project
uctl get role
uctl get task
uctl get task-resource-attribute
uctl get workflow
uctl get workflow-execution-config
uctl register
uctl register examples
uctl register files
uctl update
uctl update cluster-pool-attributes
uctl update cluster-resource-attribute
uctl update execution
uctl update execution-cluster-label
uctl update execution-queue-attribute
uctl update launchplan
uctl update launchplan-meta
uctl update plugin-override
uctl update project
uctl update task-meta
uctl update task-resource-attribute
uctl update workflow-execution-config
uctl update workflow-meta
Union.ai
Reference
Integrations
Dask
2.3.2
Dask
LLM-optimized
This page
Full docs index
On this page
404
Page not found
Showing closest match
