Preview Flyte 2 for production, hosted on Union.ai
Register now
↗
Union.ai Docs
Union.ai
Flyte OSS
v1
LATEST
v2
LATEST
v1
Search
⌘
K
Ask AI
⇧
⌘
K
Signup
User guide
Tutorials
Reference
Platform deployment
Integrations
Architecture
Community
Union.ai Docs
User guide
Introduction
Getting started
Local setup
First project
Understanding the code
Running your workflow
Core concepts
Workflows
Standard workflows
Subworkflows and sub-launch plans
Dynamic workflows
Imperative workflows
Launching workflows
Viewing workflows
Viewing workflow executions
Tasks
Map tasks
Task types
Task parameters
Launching tasks
Viewing tasks
Task software environment
Local image building
ImageSpec with ECR
ImageSpec with GAR
ImageSpec with ACR
Environment variables
Viewing logs
Reference tasks
Task hardware environment
Customizing task resources
Accelerators
Retries and timeouts
Interruptible instances
Task-level monitoring
Launch plans
Defining launch plans
Viewing launch plans
Notifications
Schedules
Activating and deactivating
Running launch plans
Reference launch plans
Mapping over launch plans
Reactive workflows
Concurrency control
Actors
Actors and regular tasks
Actor examples
Artifacts
Declaring artifacts
Materializing artifacts
Consuming artifacts in workflows
Connecting workflows with artifact event triggers
Viewing artifacts
App Serving
Serving custom code
Serving a Model from a Workflow With FastAPI
API Key Authentication with FastAPI
Cache a Huggingface Model as an Artifact
Deploy Optimized LLM Endpoints with vLLM and SGLang
Deploy Custom Flyte Connectors
Caching
Workspaces
Named outputs
ImageSpec
Development cycle
Authentication
Project structure
Projects and domains
Building workflows
Setting up a production project
Local dependencies
ImageSpec
Running your code
Overriding parameters
Run details
Debugging with interactive tasks
Managing secrets
Managing API keys
Accessing AWS S3 buckets
Task resource validation
Running in a local cluster
CI/CD deployment
Jupyter notebooks
Decks
Remote management
Remote examples
Streaming execution events
Data input/output
FlyteFile and FlyteDirectory
Downloading with FlyteFile and FlyteDirectory
Task input and output
Accelerated datasets
Accessing attributes
Dataclass
Enum type
Pickle type
Pydantic BaseModel
PyTorch type
StructuredDataset
TensorFlow types
Administration
Resources
Cost allocation
User management
Applications
Programming
Chaining entities
Conditionals
Decorating tasks
Decorating workflows
Intratask checkpoints
Waiting for external inputs
Nested parallelism
Failure node
FAQ
Tutorials
Bioinformatics
Genomic Alignment
Compound AI Systems
Video Dubbing
Natural Language SQL Query Agent using Smolagent
Optimizing the PDF-to-Podcast NVIDIA Blueprint for Production Use
Serving LlamaIndex RAG with FastAPI and LanceDB
Taking NVIDIA’s Enterprise RAG Blueprint to Production
Diffusion models
Video Generation with Mochi
Finance
Credit Default Prediction with XGBoost & NVIDIA RAPIDS
Language Models
Sentiment Classification with Language Models
HDBSCAN Soft Clustering With Headline Embeddings on GPUs
Benchmarking LLM training with the Liger Kernel
Fine-Tune BERT on Arabic Reviews with Multi-Node Training and Data Streaming
Parallel Processing and Job Scheduling
Reddit Slack Bot
Generating Wikipedia Embeddings
Retrieval Augmented Generation
Agentic Retrieval Augmented Generation
Creating a RAG App with LanceDB and Google Gemini
Building a Contextual RAG Workflow with Together AI
Serving
Deploy Custom Webhooks to Launch Workflows
Deploy Marimo Notebooks as WASM Applications
Finetuning a Reasoning LLM with Unsloth and Serving with vLLM
Serve your LLM with MAX Serve
Add Tracing and Guardrails to an Airbnb RAG App with Weave
Trace and Evaluate Models and RAG Apps with Arize
Deploying a Fine-Tuned Llama Model to an iOS App with MLC-LLM
Serve vLLM on Union Actors for Named Entity Recognition
Serve NVIDIA NIM Models with Union Actors
Time Series
Forecasting with GluonTS & PyTorch on GPUs
Time Series Model Comparison
Reference
LLM-optimized documentation
Union CLI
Uctl CLI
uctl
uctl version
uctl append
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
Flytekit SDK
Classes & Protocols
Packages
flytekit
flytekit.bin.entrypoint
flytekit.clients.auth_helper
flytekit.clients.auth.auth_client
flytekit.clients.auth.authenticator
flytekit.clients.auth.default_html
flytekit.clients.auth.exceptions
flytekit.clients.auth.keyring
flytekit.clients.auth.token_client
flytekit.clients.friendly
flytekit.clients.grpc_utils.auth_interceptor
flytekit.clients.grpc_utils.default_metadata_interceptor
flytekit.clients.grpc_utils.wrap_exception_interceptor
flytekit.clients.helpers
flytekit.clients.raw
flytekit.clis.helpers
flytekit.clis.sdk_in_container.backfill
flytekit.clis.sdk_in_container.build
flytekit.clis.sdk_in_container.constants
flytekit.clis.sdk_in_container.executions
flytekit.clis.sdk_in_container.helpers
flytekit.clis.sdk_in_container.metrics
flytekit.clis.sdk_in_container.package
flytekit.clis.sdk_in_container.pyflyte
flytekit.clis.sdk_in_container.run
flytekit.clis.sdk_in_container.serialize
flytekit.clis.sdk_in_container.serve
flytekit.clis.sdk_in_container.utils
flytekit.clis.version
flytekit.configuration
flytekit.configuration.default_images
flytekit.configuration.feature_flags
flytekit.configuration.file
flytekit.configuration.internal
flytekit.configuration.plugin
flytekit.constants
flytekit.core.annotation
flytekit.core.array_node
flytekit.core.array_node_map_task
flytekit.core.artifact
flytekit.core.artifact_utils
flytekit.core.base_sql_task
flytekit.core.base_task
flytekit.core.cache
flytekit.core.checkpointer
flytekit.core.class_based_resolver
flytekit.core.condition
flytekit.core.constants
flytekit.core.container_task
flytekit.core.context_manager
flytekit.core.data_persistence
flytekit.core.docstring
flytekit.core.environment
flytekit.core.gate
flytekit.core.hash
flytekit.core.interface
flytekit.core.launch_plan
flytekit.core.legacy_map_task
flytekit.core.local_cache
flytekit.core.local_fsspec
flytekit.core.mock_stats
flytekit.core.node
flytekit.core.node_creation
flytekit.core.notification
flytekit.core.options
flytekit.core.pod_template
flytekit.core.promise
flytekit.core.python_auto_container
flytekit.core.python_customized_container_task
flytekit.core.python_function_task
flytekit.core.reference
flytekit.core.reference_entity
flytekit.core.resources
flytekit.core.schedule
flytekit.core.shim_task
flytekit.core.task
flytekit.core.testing
flytekit.core.tracked_abc
flytekit.core.tracker
flytekit.core.type_engine
flytekit.core.type_helpers
flytekit.core.type_match_checking
flytekit.core.utils
flytekit.core.worker_queue
flytekit.core.workflow
flytekit.deck.deck
flytekit.deck.renderer
flytekit.exceptions.base
flytekit.exceptions.eager
flytekit.exceptions.scopes
flytekit.exceptions.system
flytekit.exceptions.user
flytekit.exceptions.utils
flytekit.experimental.eager_function
flytekit.extend.backend.base_connector
flytekit.extend.backend.connector_service
flytekit.extend.backend.utils
flytekit.extras.accelerators
flytekit.extras.cloud_pickle_resolver
flytekit.extras.pydantic_transformer.transformer
flytekit.extras.sklearn.native
flytekit.extras.sqlite3.task
flytekit.extras.tasks.shell
flytekit.extras.webhook
flytekit.extras.webhook.connector
flytekit.extras.webhook.constants
flytekit.extras.webhook.task
flytekit.image_spec.default_builder
flytekit.image_spec.image_spec
flytekit.image_spec.noop_builder
flytekit.interaction.click_types
flytekit.interaction.parse_stdin
flytekit.interaction.rich_utils
flytekit.interaction.string_literals
flytekit.interactive
flytekit.interactive.constants
flytekit.interactive.utils
flytekit.interactive.vscode_lib.config
flytekit.interactive.vscode_lib.decorator
flytekit.interactive.vscode_lib.vscode_constants
flytekit.interfaces.cli_identifiers
flytekit.interfaces.random
flytekit.interfaces.stats.client
flytekit.interfaces.stats.taggable
flytekit.lazy_import.lazy_module
flytekit.loggers
flytekit.models.admin.common
flytekit.models.admin.task_execution
flytekit.models.admin.workflow
flytekit.models.annotation
flytekit.models.array_job
flytekit.models.common
flytekit.models.concurrency
flytekit.models.core.catalog
flytekit.models.core.compiler
flytekit.models.core.condition
flytekit.models.core.errors
flytekit.models.core.execution
flytekit.models.core.identifier
flytekit.models.core.types
flytekit.models.core.workflow
flytekit.models.documentation
flytekit.models.domain
flytekit.models.dynamic_job
flytekit.models.event
flytekit.models.execution
flytekit.models.filters
flytekit.models.interface
flytekit.models.launch_plan
flytekit.models.literals
flytekit.models.matchable_resource
flytekit.models.named_entity
flytekit.models.node_execution
flytekit.models.presto
flytekit.models.project
flytekit.models.qubole
flytekit.models.schedule
flytekit.models.security
flytekit.models.task
flytekit.models.types
flytekit.models.workflow_closure
flytekit.remote.backfill
flytekit.remote.data
flytekit.remote.entities
flytekit.remote.executions
flytekit.remote.interface
flytekit.remote.lazy_entity
flytekit.remote.metrics
flytekit.remote.remote
flytekit.remote.remote_callable
flytekit.remote.remote_fs
flytekit.sensor.base_sensor
flytekit.sensor.file_sensor
flytekit.sensor.sensor_engine
flytekit.tools.fast_registration
flytekit.tools.ignore
flytekit.tools.interactive
flytekit.tools.module_loader
flytekit.tools.repo
flytekit.tools.script_mode
flytekit.tools.serialize_helpers
flytekit.tools.subprocess
flytekit.tools.translator
flytekit.types.directory
flytekit.types.directory.types
flytekit.types.error.error
flytekit.types.file
flytekit.types.file.file
flytekit.types.file.image
flytekit.types.iterator.iterator
flytekit.types.iterator.json_iterator
flytekit.types.numpy.ndarray
flytekit.types.pickle.pickle
flytekit.types.schema.types
flytekit.types.schema.types_pandas
flytekit.types.structured
flytekit.types.structured.basic_dfs
flytekit.types.structured.bigquery
flytekit.types.structured.snowflake
flytekit.types.structured.structured_dataset
flytekit.utils.asyn
flytekit.utils.dict_formatter
flytekit.utils.pbhash
flytekit.utils.rate_limiter
Union SDK
Classes & Protocols
Packages
union
union.actor
union.app
union.app.llm
union.artifacts
union.cache
union.configuration
union.filesystems
union.map
union.remote
union.ucimage
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
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
Data plane setup on GCP
Data plane setup on AWS
Setup with AWS CDK
Manual setup on AWS
Data plane setup on Azure
Data plane setup on OCI
Configuration
Helm Values
Node Pools
Code Viewer
Image Builder
Multiple Clusters
Persistent logs
Secrets
Terraform
Installation
Resource Management
Security Best Practices
Data retention policy
Integrations
Connectors
Airflow connector
Airflow connector example usage
BigQuery connector
BigQuery connector example usage
ChatGPT connector
ChatGPT connector
Databricks connector
Running Spark on Databricks
Memory Machine Cloud connector
Memory Machine Cloud connector example usage
OpenAI Batch connector
Batching Requests for Asynchronous Processing
Perian connector
Perian connector example usage
SageMaker connector
Deploy and serve an XGBoost model on AWS SageMaker using FastAPI
Sensor connectror
File Sensor
Slurm connector
Slurm connector example usage
Snowflake connector
Querying data in Snowflake
DGX connector
Architecture
Community
Contributing docs and examples
Quick start
Variants
Versions
Authoring
Shortcodes
Redirects
API docs
Publishing
Documentation navigation for Union including user guides, tutorials, API references, and integration examples
LLM-optimized documentation
Union CLI
Uctl CLI
uctl
uctl version
uctl append
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
Flytekit SDK
Classes & Protocols
Packages
flytekit
flytekit.bin.entrypoint
flytekit.clients.auth_helper
flytekit.clients.auth.auth_client
flytekit.clients.auth.authenticator
flytekit.clients.auth.default_html
flytekit.clients.auth.exceptions
flytekit.clients.auth.keyring
flytekit.clients.auth.token_client
flytekit.clients.friendly
flytekit.clients.grpc_utils.auth_interceptor
flytekit.clients.grpc_utils.default_metadata_interceptor
flytekit.clients.grpc_utils.wrap_exception_interceptor
flytekit.clients.helpers
flytekit.clients.raw
flytekit.clis.helpers
flytekit.clis.sdk_in_container.backfill
flytekit.clis.sdk_in_container.build
flytekit.clis.sdk_in_container.constants
flytekit.clis.sdk_in_container.executions
flytekit.clis.sdk_in_container.helpers
flytekit.clis.sdk_in_container.metrics
flytekit.clis.sdk_in_container.package
flytekit.clis.sdk_in_container.pyflyte
flytekit.clis.sdk_in_container.run
flytekit.clis.sdk_in_container.serialize
flytekit.clis.sdk_in_container.serve
flytekit.clis.sdk_in_container.utils
flytekit.clis.version
flytekit.configuration
flytekit.configuration.default_images
flytekit.configuration.feature_flags
flytekit.configuration.file
flytekit.configuration.internal
flytekit.configuration.plugin
flytekit.constants
flytekit.core.annotation
flytekit.core.array_node
flytekit.core.array_node_map_task
flytekit.core.artifact
flytekit.core.artifact_utils
flytekit.core.base_sql_task
flytekit.core.base_task
flytekit.core.cache
flytekit.core.checkpointer
flytekit.core.class_based_resolver
flytekit.core.condition
flytekit.core.constants
flytekit.core.container_task
flytekit.core.context_manager
flytekit.core.data_persistence
flytekit.core.docstring
flytekit.core.environment
flytekit.core.gate
flytekit.core.hash
flytekit.core.interface
flytekit.core.launch_plan
flytekit.core.legacy_map_task
flytekit.core.local_cache
flytekit.core.local_fsspec
flytekit.core.mock_stats
flytekit.core.node
flytekit.core.node_creation
flytekit.core.notification
flytekit.core.options
flytekit.core.pod_template
flytekit.core.promise
flytekit.core.python_auto_container
flytekit.core.python_customized_container_task
flytekit.core.python_function_task
flytekit.core.reference
flytekit.core.reference_entity
flytekit.core.resources
flytekit.core.schedule
flytekit.core.shim_task
flytekit.core.task
flytekit.core.testing
flytekit.core.tracked_abc
flytekit.core.tracker
flytekit.core.type_engine
flytekit.core.type_helpers
flytekit.core.type_match_checking
flytekit.core.utils
flytekit.core.worker_queue
flytekit.core.workflow
flytekit.deck.deck
flytekit.deck.renderer
flytekit.exceptions.base
flytekit.exceptions.eager
flytekit.exceptions.scopes
flytekit.exceptions.system
flytekit.exceptions.user
flytekit.exceptions.utils
flytekit.experimental.eager_function
flytekit.extend.backend.base_connector
flytekit.extend.backend.connector_service
flytekit.extend.backend.utils
flytekit.extras.accelerators
flytekit.extras.cloud_pickle_resolver
flytekit.extras.pydantic_transformer.transformer
flytekit.extras.sklearn.native
flytekit.extras.sqlite3.task
flytekit.extras.tasks.shell
flytekit.extras.webhook
flytekit.extras.webhook.connector
flytekit.extras.webhook.constants
flytekit.extras.webhook.task
flytekit.image_spec.default_builder
flytekit.image_spec.image_spec
flytekit.image_spec.noop_builder
flytekit.interaction.click_types
flytekit.interaction.parse_stdin
flytekit.interaction.rich_utils
flytekit.interaction.string_literals
flytekit.interactive
flytekit.interactive.constants
flytekit.interactive.utils
flytekit.interactive.vscode_lib.config
flytekit.interactive.vscode_lib.decorator
flytekit.interactive.vscode_lib.vscode_constants
flytekit.interfaces.cli_identifiers
flytekit.interfaces.random
flytekit.interfaces.stats.client
flytekit.interfaces.stats.taggable
flytekit.lazy_import.lazy_module
flytekit.loggers
flytekit.models.admin.common
flytekit.models.admin.task_execution
flytekit.models.admin.workflow
flytekit.models.annotation
flytekit.models.array_job
flytekit.models.common
flytekit.models.concurrency
flytekit.models.core.catalog
flytekit.models.core.compiler
flytekit.models.core.condition
flytekit.models.core.errors
flytekit.models.core.execution
flytekit.models.core.identifier
flytekit.models.core.types
flytekit.models.core.workflow
flytekit.models.documentation
flytekit.models.domain
flytekit.models.dynamic_job
flytekit.models.event
flytekit.models.execution
flytekit.models.filters
flytekit.models.interface
flytekit.models.launch_plan
flytekit.models.literals
flytekit.models.matchable_resource
flytekit.models.named_entity
flytekit.models.node_execution
flytekit.models.presto
flytekit.models.project
flytekit.models.qubole
flytekit.models.schedule
flytekit.models.security
flytekit.models.task
flytekit.models.types
flytekit.models.workflow_closure
flytekit.remote.backfill
flytekit.remote.data
flytekit.remote.entities
flytekit.remote.executions
flytekit.remote.interface
flytekit.remote.lazy_entity
flytekit.remote.metrics
flytekit.remote.remote
flytekit.remote.remote_callable
flytekit.remote.remote_fs
flytekit.sensor.base_sensor
flytekit.sensor.file_sensor
flytekit.sensor.sensor_engine
flytekit.tools.fast_registration
flytekit.tools.ignore
flytekit.tools.interactive
flytekit.tools.module_loader
flytekit.tools.repo
flytekit.tools.script_mode
flytekit.tools.serialize_helpers
flytekit.tools.subprocess
flytekit.tools.translator
flytekit.types.directory
flytekit.types.directory.types
flytekit.types.error.error
flytekit.types.file
flytekit.types.file.file
flytekit.types.file.image
flytekit.types.iterator.iterator
flytekit.types.iterator.json_iterator
flytekit.types.numpy.ndarray
flytekit.types.pickle.pickle
flytekit.types.schema.types
flytekit.types.schema.types_pandas
flytekit.types.structured
flytekit.types.structured.basic_dfs
flytekit.types.structured.bigquery
flytekit.types.structured.snowflake
flytekit.types.structured.structured_dataset
flytekit.utils.asyn
flytekit.utils.dict_formatter
flytekit.utils.pbhash
flytekit.utils.rate_limiter
Union SDK
Classes & Protocols
Packages
union
union.actor
union.app
union.app.llm
union.artifacts
union.cache
union.configuration
union.filesystems
union.map
union.remote
union.ucimage
Union.ai
Reference
Flytekit SDK
Packages
flytekit.clis.version
1.16.20
flytekit.clis.version
Directory
Variables
Property
Type
Description
Content
str
LLM-optimized
This page
Full docs index
On this page
404
Page not found
Showing closest match