2.0.0b1

Classes

Class Description
flyte.Cache Cache configuration for a task.
flyte.Device Represents a device type, its quantity and partition if applicable.
flyte.Environment
flyte.Image This is a representation of Container Images, which can be used to create layered images programmatically.
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 ReusePolicy can be used to configure a task to reuse the environment.
flyte.Secret Secrets are used to inject sensitive information into tasks.
flyte.TaskEnvironment Environment class to define a new environment for a set of tasks.
flyte.Timeout Timeout class to define a timeout for a task.
flyte.config.Config This the parent configuration object and holds all the underlying configuration object types.
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.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.InvalidImageNameError This error is raised when the image name is invalid.
flyte.errors.LogsNotYetAvailableError This error is raised when the logs are not yet available for a task.
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.PrimaryContainerNotFoundError This error is raised when the primary container is not found.
flyte.errors.ReferenceTaskError This error is raised when the user tries to access a task that does not exist.
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.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.UnionRpcError This error is raised when communication with the Union server fails.
flyte.extend.AsyncFunctionTaskTemplate A task template that wraps an asynchronous functions.
flyte.extras.ContainerTask This is an intermediate class that represents Flyte Tasks that run a container at execution time.
flyte.io.DataFrame This is the user facing DataFrame class.
flyte.io.DataFrameDecoder Helper class that provides a standard way to create an ABC using.
flyte.io.DataFrameEncoder Helper class that provides a standard way to create an ABC using.
flyte.io.DataFrameTransformerEngine Think of this transformer as a higher-level meta transformer that is used for all the dataframe types.
flyte.io.Dir A generic directory class representing a directory with files of a specified format.
flyte.io.File A generic file class representing a file with a specified format.
flyte.models.ActionID A class representing the ID of an Action, nested within a Run.
flyte.models.Checkpoints A class representing the checkpoints for a task.
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.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.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.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.report.Report
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 Inappropriate argument type.

Protocols

Protocol Description
flyte.CachePolicy Base class for protocol classes.
flyte.types.Renderable Base class for protocol classes.