2.1.9

Classes

Class Description
flyte.BaseCheckpoint Base type for task checkpoint helpers.
flyte.Cache Cache configuration for a task.
flyte.Checkpoint Checkpoint helper using `flyte.
flyte.Cron Cron-based automation schedule for use with Trigger.
flyte.Device Represents a device type, its quantity and partition if applicable.
flyte.Environment Base class for execution environments, shared by TaskEnvironment and.
flyte.FixedRate Fixed-rate (interval-based) automation schedule for use with Trigger.
flyte.Image Container image specification built using a fluent, two-step pattern:.
flyte.ImageBuild Result of an image build operation.
flyte.PodTemplate Custom PodTemplate specification for a Task.
flyte.Resources Resources such as CPU, Memory, and GPU that can be allocated to a task.
flyte.RetryStrategy Retry strategy for the task or task environment.
flyte.ReusePolicy Configure a task environment for container reuse across multiple task invocations.
flyte.Secret Secrets are used to inject sensitive information into tasks or image build context.
flyte.TaskEnvironment Define an execution environment for a set of tasks.
flyte.Timeout Timeout class to define a timeout for a task.
flyte.Trigger Specification for a scheduled trigger that can be associated with any Flyte task.
flyte.app.AppEndpoint Embed an upstream app’s endpoint as an app parameter.
flyte.app.AppEnvironment Configure a long-running app environment for APIs, dashboards, or model servers.
flyte.app.ConnectorEnvironment Configure a connector environment for custom Flyte connectors.
flyte.app.Domain Subdomain to use for the domain.
flyte.app.Link Custom links to add to the app.
flyte.app.Parameter Parameter for application.
flyte.app.Port
flyte.app.RunOutput Use a run’s output for app parameters.
flyte.app.Scaling Controls replica count and autoscaling behavior for app environments.
flyte.app.Timeouts Timeout configuration for the application.
flyte.app.extras.FastAPIAppEnvironment
flyte.app.extras.FastAPIPassthroughAuthMiddleware FastAPI middleware that automatically sets Flyte auth metadata from request headers.
flyte.app.extras.FlyteWebhookAppEnvironment A pre-built FastAPI app environment for common Flyte webhook operations.
flyte.config.Config This the parent configuration object and holds all the underlying configuration object types.
flyte.connectors.AsyncConnector This is the base class for all async connectors, and it defines the interface that all connectors must implement.
flyte.connectors.AsyncConnectorExecutorMixin This mixin class is used to run the connector task locally, and it’s only used for local execution.
flyte.connectors.ConnectorRegistry This is the registry for all connectors.
flyte.connectors.ConnectorService
flyte.connectors.Resource This is the output resource of the job.
flyte.connectors.ResourceMeta This is the metadata for the job.
flyte.errors.ActionAbortedError This error is raised when an action was aborted, externally.
flyte.errors.ActionNotFoundError This error is raised when the user tries to access an action that does not exist.
flyte.errors.BaseRuntimeError Base class for all Union runtime errors.
flyte.errors.CodeBundleError This error is raised when the code bundle cannot be created, for example when no files are found to bundle.
flyte.errors.CustomError This error is raised when the user raises a custom error.
flyte.errors.DeploymentError This error is raised when the deployment of a task fails, or some preconditions for deployment are not met.
flyte.errors.ImageBuildError This error is raised when the image build fails.
flyte.errors.ImagePullBackOffError This error is raised when the image cannot be pulled.
flyte.errors.InitializationError This error is raised when the Union system is tried to access without being initialized.
flyte.errors.InlineIOMaxBytesBreached This error is raised when the inline IO max bytes limit is breached.
flyte.errors.InvalidImageNameError This error is raised when the image name is invalid.
flyte.errors.InvalidPackageError Raised when an invalid system package is detected during image build.
flyte.errors.LogsNotYetAvailableError This error is raised when the logs are not yet available for a task.
flyte.errors.ModuleLoadError This error is raised when the module cannot be loaded, either because it does not exist or because of a.
flyte.errors.NonRecoverableError Raised when an error is encountered that is not recoverable.
flyte.errors.NotInTaskContextError This error is raised when the user tries to access the task context outside of a task.
flyte.errors.OOMError This error is raised when the underlying task execution fails because of an out-of-memory error.
flyte.errors.OnlyAsyncIOSupportedError This error is raised when the user tries to use sync IO in an async task.
flyte.errors.ParameterMaterializationError This error is raised when the user tries to use a Parameter in an App, that has delayed Materialization,.
flyte.errors.PrimaryContainerNotFoundError This error is raised when the primary container is not found.
flyte.errors.RemoteTaskNotFoundError This error is raised when the user tries to access a task that does not exist.
flyte.errors.RemoteTaskUsageError This error is raised when the user tries to access a task that does not exist.
flyte.errors.RestrictedTypeError This error is raised when the user uses a restricted type, for example current a Tuple is not supported for one.
flyte.errors.RetriesExhaustedError This error is raised when the underlying task execution fails after all retries have been exhausted.
flyte.errors.RuntimeDataValidationError This error is raised when the user tries to access a resource that does not exist or is invalid.
flyte.errors.RuntimeSystemError This error is raised when the underlying task execution fails because of a system error.
flyte.errors.RuntimeUnknownError This error is raised when the underlying task execution fails because of an unknown error.
flyte.errors.RuntimeUserError This error is raised when the underlying task execution fails because of an error in the user’s code.
flyte.errors.SlowDownError This error is raised when the user tries to access a resource that does not exist or is invalid.
flyte.errors.TaskInterruptedError This error is raised when the underlying task execution is interrupted.
flyte.errors.TaskTimeoutError This error is raised when the underlying task execution runs for longer than the specified timeout.
flyte.errors.TraceDoesNotAllowNestedTasksError This error is raised when the user tries to use a task from within a trace.
flyte.errors.UnionRpcError This error is raised when communication with the Union server fails.
flyte.extend.AsyncFunctionTaskTemplate A task template that wraps an asynchronous functions.
flyte.extend.ImageBuildEngine ImageBuildEngine contains a list of builders that can be used to build an ImageSpec.
flyte.extend.TaskTemplate Task template is a template for a task that can be executed.
flyte.extras.BatchStats Monitoring statistics exposed by `DynamicBatcher.
flyte.extras.ContainerTask This is an intermediate class that represents Flyte Tasks that run a container at execution time.
flyte.extras.DynamicBatcher Batches records from many concurrent producers and runs them through.
flyte.extras.Prompt Simple prompt record with built-in token estimation.
flyte.extras.Sleep Route a task to the backend core-sleep plugin.
flyte.extras.SleepTask
flyte.extras.TokenBatcher Token-aware batcher for LLM inference workloads.
flyte.git.GitStatus A class representing the status of a git repository.
flyte.io.DataFrame A Flyte meta DataFrame object, that wraps all other dataframe types (usually available as plugins, pandas.
flyte.io.Dir A generic directory class representing a directory with files of a specified format.
flyte.io.EmptyDir A sentinel :class:Dir representing ’no directory was produced'.
flyte.io.File A generic file class representing a file with a specified format.
flyte.io.HashFunction A hash method that wraps a user-provided function to compute hashes.
flyte.io.extend.DataFrameDecoder
flyte.io.extend.DataFrameEncoder
flyte.io.extend.DataFrameTransformerEngine Think of this transformer as a higher-level meta transformer that is used for all the dataframe types.
flyte.models.ActionID A class representing the ID of an Action, nested within a Run.
flyte.models.ActionPhase Represents the execution phase of a Flyte action (run).
flyte.models.CheckpointPaths Paths the platform provides for this task’s checkpoint output and optional previous-attempt input.
flyte.models.CodeBundle A class representing a code bundle for a task.
flyte.models.GroupData
flyte.models.NativeInterface A class representing the native interface for a task.
flyte.models.PathRewrite Configuration for rewriting paths during input loading.
flyte.models.RawDataPath A class representing the raw data path for a task.
flyte.models.SerializationContext This object holds serialization time contextual information, that can be used when serializing the task and.
flyte.models.TaskContext A context class to hold the current task executions context.
flyte.notify.Email Send email notifications.
flyte.notify.NamedDelivery Use a pre-configured delivery channel by name.
flyte.notify.NamedRule Reference a pre-defined notification rule by name.
flyte.notify.Notification Base notification class.
flyte.notify.Slack Send Slack notifications with optional Block Kit formatting.
flyte.notify.Teams Send Microsoft Teams notifications with optional Adaptive Cards.
flyte.notify.Webhook Send custom HTTP webhook notifications (most flexible option).
flyte.prefetch.HuggingFaceModelInfo Information about a HuggingFace model to store.
flyte.prefetch.ShardConfig Configuration for model sharding.
flyte.prefetch.StoredModelInfo Information about a stored model.
flyte.prefetch.VLLMShardArgs Arguments for sharding a model using vLLM.
flyte.remote.Action A class representing an action.
flyte.remote.ActionDetails A class representing an action.
flyte.remote.ActionInputs A class representing the inputs of an action.
flyte.remote.ActionOutputs A class representing the outputs of an action.
flyte.remote.App
flyte.remote.Project A class representing a project in the Union API.
flyte.remote.Run A class representing a run of a task.
flyte.remote.RunDetails A class representing a run of a task.
flyte.remote.Secret
flyte.remote.Task
flyte.remote.TaskDetails
flyte.remote.TimeFilter Filter for time-based fields (e.
flyte.remote.Trigger Represents a trigger in the Flyte platform.
flyte.remote.User Represents a user in the Flyte platform.
flyte.report.Report
flyte.sandbox.CodeTaskTemplate A sandboxed task created from a code string rather than a decorated function.
flyte.sandbox.ImageConfig Configuration for Docker image building at runtime.
flyte.sandbox.SandboxedConfig Configuration for a sandboxed task executed via Monty.
flyte.sandbox.SandboxedTaskTemplate A task template that executes the function body in a Monty sandbox.
flyte.storage.ABFS Any Azure Blob Storage specific configuration.
flyte.storage.GCS Any GCS specific configuration.
flyte.storage.S3 S3 specific configuration.
flyte.storage.Storage Data storage configuration that applies across any provider.
flyte.syncify.Syncify A decorator to convert asynchronous functions or methods into synchronous ones.
flyte.types.FlytePickle This type is only used by flytekit internally.
flyte.types.TypeEngine Core Extensible TypeEngine of Flytekit.
flyte.types.TypeTransformer Base transformer type that should be implemented for every python native type that can be handled by flytekit.
flyte.types.TypeTransformerFailedError

Protocols

Protocol Description
flyte.AppHandle Protocol defining the common interface between local and remote app handles.
flyte.CachePolicy Protocol for custom cache version strategies.
flyte.Link
flyte.extend.ImageBuilder
flyte.extend.ImageChecker
flyte.extras.CostEstimator Protocol for records that can estimate their own processing cost.
flyte.extras.TokenEstimator Protocol for records that can estimate their own token count.
flyte.types.Renderable