1.15.4.dev2+g3e3ce2426
Classes
| Class | Description |
|---|---|
flytekit.Annotations |
None |
flytekit.Artifact |
An Artifact is effectively just a metadata layer on top of data that exists in Flyte |
flytekit.AuthRole |
None |
flytekit.BatchSize |
This is used to annotate a FlyteDirectory when we want to download/upload the contents of the directory in batches |
flytekit.Blob |
None |
flytekit.BlobMetadata |
This is metadata for the Blob literal |
flytekit.BlobType |
This type represents offloaded data and is typically used for things like files |
flytekit.Cache |
Cache configuration for a task |
flytekit.CachePolicy |
Base class for protocol classes |
flytekit.Checkpoint |
Base class for Checkpoint system |
flytekit.Config |
This the parent configuration object and holds all the underlying configuration object types |
flytekit.ContainerTask |
This is an intermediate class that represents Flyte Tasks that run a container at execution time |
flytekit.CronSchedule |
Use this when you have a launch plan that you want to run on a cron expression |
flytekit.Deck |
Deck enable users to get customizable and default visibility into their tasks |
flytekit.Description |
Full user description with formatting preserved |
flytekit.Documentation |
DescriptionEntity contains detailed description for the task/workflow/launch plan |
flytekit.Email |
This notification should be used when sending regular emails to people |
flytekit.Environment |
None |
flytekit.ExecutionParameters |
This is a run-time user-centric context object that is accessible to every @task method |
flytekit.FixedRate |
Use this class to schedule a fixed-rate interval for a launch plan |
flytekit.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.FlyteDirectory |
None |
flytekit.FlyteFile |
None |
flytekit.FlyteRemote |
Main entrypoint for programmatically accessing a Flyte remote backend |
flytekit.HashMethod |
Flyte-specific object used to wrap the hash function for a specific type |
flytekit.ImageSpec |
This class is used to specify the docker image that will be used to run the task |
flytekit.Labels |
None |
flytekit.LaunchPlan |
Launch Plans are one of the core constructs of Flyte |
flytekit.LaunchPlanReference |
A reference object containing metadata that points to a remote launch plan |
flytekit.Literal |
None |
flytekit.LiteralType |
None |
flytekit.Options |
These are options that can be configured for a launchplan during registration or overridden during an execution |
flytekit.PagerDuty |
This notification should be used when sending emails to the PagerDuty service |
flytekit.PodTemplate |
Custom PodTemplate specification for a Task |
flytekit.PythonFunctionTask |
A Python Function task should be used as the base for all extensions that have a python function |
flytekit.PythonInstanceTask |
This class should be used as the base class for all Tasks that do not have a user defined function body, but have |
flytekit.Resources |
This class is used to specify both resource requests and resource limits |
flytekit.SQLTask |
Base task types for all SQL tasks |
flytekit.Scalar |
None |
flytekit.Secret |
See :std:ref:cookbook:secrets for usage examples |
flytekit.SecurityContext |
This is a higher level wrapper object that for the most part users shouldn’t have to worry about |
flytekit.SensorEngine |
This is the base class for all async agents |
flytekit.Slack |
This notification should be used when sending emails to the Slack |
flytekit.SourceCode |
Link to source code used to define this task or workflow |
flytekit.StructuredDataset |
This is the user facing StructuredDataset class |
flytekit.StructuredDatasetFormat |
str(object=’’) -> str |
flytekit.StructuredDatasetTransformerEngine |
Think of this transformer as a higher-level meta transformer that is used for all the dataframe types |
flytekit.StructuredDatasetType |
None |
flytekit.TaskMetadata |
Metadata for a Task |
flytekit.TaskReference |
A reference object containing metadata that points to a remote task |
flytekit.VersionParameters |
Parameters used for version hash generation |
flytekit.Workflow |
An imperative workflow is a programmatic analogue to the typical @workflow function-based workflow and is |
flytekit.WorkflowExecutionPhase |
This class holds enum values used for setting notifications |
flytekit.WorkflowFailurePolicy |
Defines the behavior for a workflow execution in the case of an observed node execution failure |
flytekit.WorkflowReference |
A reference object containing metadata that points to a remote workflow |
flytekit.bin.entrypoint.ExecutionParameters |
This is a run-time user-centric context object that is accessible to every @task method |
flytekit.bin.entrypoint.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.bin.entrypoint.FastSerializationSettings |
This object hold information about settings necessary to serialize an object so that it can be fast-registered |
flytekit.bin.entrypoint.FileAccessProvider |
This is the class that is available through the FlyteContext and can be used for persisting data to the remote |
flytekit.bin.entrypoint.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.bin.entrypoint.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.bin.entrypoint.FlyteException |
Common base class for all non-exit exceptions |
flytekit.bin.entrypoint.FlyteNonRecoverableSystemException |
Common base class for all non-exit exceptions |
flytekit.bin.entrypoint.FlyteRecoverableException |
Common base class for all non-exit exceptions |
flytekit.bin.entrypoint.FlyteUserRuntimeException |
Common base class for all non-exit exceptions |
flytekit.bin.entrypoint.IgnoreOutputs |
This exception should be used to indicate that the outputs generated by this can be safely ignored |
flytekit.bin.entrypoint.ImageConfig |
We recommend you to use ImageConfig |
flytekit.bin.entrypoint.OutputMetadataTracker |
This class is for the users to set arbitrary metadata on output literals |
flytekit.bin.entrypoint.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.bin.entrypoint.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.bin.entrypoint.StatsConfig |
Configuration for sending statsd |
flytekit.bin.entrypoint.SyncCheckpoint |
This class is NOT THREAD-SAFE! |
flytekit.bin.entrypoint.Timestamp |
A ProtocolMessage |
flytekit.bin.entrypoint.VoidPromise |
This object is returned for tasks that do not return any outputs (declared interface is empty) |
flytekit.clients.auth.auth_client.AccessTokenNotFoundError |
This error is raised with Access token is not found or if Refreshing the token fails |
flytekit.clients.auth.auth_client.AuthorizationClient |
Authorization client that stores the credentials in keyring and uses oauth2 standard flow to retrieve the |
flytekit.clients.auth.auth_client.AuthorizationCode |
None |
flytekit.clients.auth.auth_client.Credentials |
Stores the credentials together |
flytekit.clients.auth.auth_client.EndpointMetadata |
This class can be used to control the rendering of the page on login successful or failure |
flytekit.clients.auth.auth_client.OAuthCallbackHandler |
A simple wrapper around BaseHTTPServer |
flytekit.clients.auth.auth_client.OAuthHTTPServer |
A simple wrapper around the BaseHTTPServer |
flytekit.clients.auth.auth_client.Queue |
Create a queue object with a given maximum size |
flytekit.clients.auth.authenticator.AccessTokenNotFoundError |
This error is raised with Access token is not found or if Refreshing the token fails |
flytekit.clients.auth.authenticator.AuthenticationError |
This is raised for any AuthenticationError |
flytekit.clients.auth.authenticator.AuthenticationPending |
This is raised if the token endpoint returns authentication pending |
flytekit.clients.auth.authenticator.Authenticator |
Base authenticator for all authentication flows |
flytekit.clients.auth.authenticator.AuthorizationClient |
Authorization client that stores the credentials in keyring and uses oauth2 standard flow to retrieve the |
flytekit.clients.auth.authenticator.ClientConfig |
Client Configuration that is needed by the authenticator |
flytekit.clients.auth.authenticator.ClientConfigStore |
Client Config store retrieve client config |
flytekit.clients.auth.authenticator.ClientCredentialsAuthenticator |
This Authenticator uses ClientId and ClientSecret to authenticate |
flytekit.clients.auth.authenticator.CommandAuthenticator |
This Authenticator retrieves access_token using the provided command |
flytekit.clients.auth.authenticator.Credentials |
Stores the credentials together |
flytekit.clients.auth.authenticator.DeviceCodeAuthenticator |
This Authenticator implements the Device Code authorization flow useful for headless user authentication |
flytekit.clients.auth.authenticator.KeyringStore |
Methods to access Keyring Store |
flytekit.clients.auth.authenticator.PKCEAuthenticator |
This Authenticator encapsulates the entire PKCE flow and automatically opens a browser window for login |
flytekit.clients.auth.authenticator.StaticClientConfigStore |
Client Config store retrieve client config |
flytekit.clients.auth.default_html.suppress |
Context manager to suppress specified exceptions |
flytekit.clients.auth.exceptions.AccessTokenNotFoundError |
This error is raised with Access token is not found or if Refreshing the token fails |
flytekit.clients.auth.exceptions.AuthenticationError |
This is raised for any AuthenticationError |
flytekit.clients.auth.exceptions.AuthenticationPending |
This is raised if the token endpoint returns authentication pending |
flytekit.clients.auth.keyring.Credentials |
Stores the credentials together |
flytekit.clients.auth.keyring.KeyringStore |
Methods to access Keyring Store |
flytekit.clients.auth.keyring.NoKeyringError |
Raised when there is no keyring backend |
flytekit.clients.auth.keyring.PasswordDeleteError |
Raised when the password can’t be deleted |
flytekit.clients.auth.token_client.AuthenticationError |
This is raised for any AuthenticationError |
flytekit.clients.auth.token_client.AuthenticationPending |
This is raised if the token endpoint returns authentication pending |
flytekit.clients.auth.token_client.DeviceCodeResponse |
Response from device auth flow endpoint |
flytekit.clients.auth.token_client.GrantType |
str(object=’’) -> str |
flytekit.clients.auth.token_client.datetime |
datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]]) |
flytekit.clients.auth.token_client.timedelta |
Difference between two datetime values |
flytekit.clients.auth_helper.AuthMetadataServiceStub |
The following defines an RPC service that is also served over HTTP via grpc-gateway |
flytekit.clients.auth_helper.AuthType |
Create a collection of name/value pairs |
flytekit.clients.auth_helper.AuthUnaryInterceptor |
This Interceptor can be used to automatically add Auth Metadata for every call - lazily in case authentication |
flytekit.clients.auth_helper.AuthenticationHTTPAdapter |
A custom HTTPAdapter that adds authentication headers to requests of a session |
flytekit.clients.auth_helper.Authenticator |
Base authenticator for all authentication flows |
flytekit.clients.auth_helper.ClientConfig |
Client Configuration that is needed by the authenticator |
flytekit.clients.auth_helper.ClientConfigStore |
Client Config store retrieve client config |
flytekit.clients.auth_helper.ClientCredentialsAuthenticator |
This Authenticator uses ClientId and ClientSecret to authenticate |
flytekit.clients.auth_helper.CommandAuthenticator |
This Authenticator retrieves access_token using the provided command |
flytekit.clients.auth_helper.DefaultMetadataInterceptor |
Affords intercepting unary-unary invocations |
flytekit.clients.auth_helper.DeviceCodeAuthenticator |
This Authenticator implements the Device Code authorization flow useful for headless user authentication |
flytekit.clients.auth_helper.HTTPStatus |
HTTP status codes and reason phrases |
flytekit.clients.auth_helper.OAuth2MetadataRequest |
A ProtocolMessage |
flytekit.clients.auth_helper.PKCEAuthenticator |
This Authenticator encapsulates the entire PKCE flow and automatically opens a browser window for login |
flytekit.clients.auth_helper.PlatformConfig |
This object contains the settings to talk to a Flyte backend (the DNS location of your Admin server basically) |
flytekit.clients.auth_helper.PublicClientAuthConfigRequest |
A ProtocolMessage |
flytekit.clients.auth_helper.RemoteClientConfigStore |
This class implements the ClientConfigStore that is served by the Flyte Server, that implements AuthMetadataService |
flytekit.clients.auth_helper.RetryExceptionWrapperInterceptor |
Affords intercepting unary-unary invocations |
flytekit.clients.friendly.Duration |
A ProtocolMessage |
flytekit.clients.friendly.SynchronousFlyteClient |
This is a low-level client that users can use to make direct gRPC service calls to the control plane |
flytekit.clients.grpc_utils.auth_interceptor.AuthUnaryInterceptor |
This Interceptor can be used to automatically add Auth Metadata for every call - lazily in case authentication |
flytekit.clients.grpc_utils.auth_interceptor.Authenticator |
Base authenticator for all authentication flows |
flytekit.clients.grpc_utils.default_metadata_interceptor.DefaultMetadataInterceptor |
Affords intercepting unary-unary invocations |
flytekit.clients.grpc_utils.wrap_exception_interceptor.FlyteAuthenticationException |
Assertion failed |
flytekit.clients.grpc_utils.wrap_exception_interceptor.FlyteEntityAlreadyExistsException |
Assertion failed |
flytekit.clients.grpc_utils.wrap_exception_interceptor.FlyteEntityNotExistException |
Assertion failed |
flytekit.clients.grpc_utils.wrap_exception_interceptor.FlyteException |
Common base class for all non-exit exceptions |
flytekit.clients.grpc_utils.wrap_exception_interceptor.FlyteInvalidInputException |
Common base class for all non-exit exceptions |
flytekit.clients.grpc_utils.wrap_exception_interceptor.FlyteSystemException |
Common base class for all non-exit exceptions |
flytekit.clients.grpc_utils.wrap_exception_interceptor.FlyteSystemUnavailableException |
Common base class for all non-exit exceptions |
flytekit.clients.grpc_utils.wrap_exception_interceptor.RetryExceptionWrapperInterceptor |
Affords intercepting unary-unary invocations |
flytekit.clients.raw.DataProxyServiceStub |
DataProxyService defines an RPC Service that allows access to user-data in a controlled manner |
flytekit.clients.raw.GetDomainRequest |
A ProtocolMessage |
flytekit.clients.raw.PlatformConfig |
This object contains the settings to talk to a Flyte backend (the DNS location of your Admin server basically) |
flytekit.clients.raw.ProjectListRequest |
A ProtocolMessage |
flytekit.clients.raw.RawSynchronousFlyteClient |
This is a thin synchronous wrapper around the auto-generated GRPC stubs for communicating with the admin service |
flytekit.clients.raw.SignalList |
A ProtocolMessage |
flytekit.clients.raw.SignalListRequest |
A ProtocolMessage |
flytekit.clients.raw.SignalSetRequest |
A ProtocolMessage |
flytekit.clients.raw.SignalSetResponse |
A ProtocolMessage |
flytekit.clis.flyte_cli.main.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.clis.helpers.LaunchPlan |
A ProtocolMessage |
flytekit.clis.helpers.TaskSpec |
A ProtocolMessage |
flytekit.clis.helpers.WorkflowSpec |
A ProtocolMessage |
flytekit.clis.sdk_in_container.backfill.DateTimeType |
The DateTime type converts date strings into datetime objects |
flytekit.clis.sdk_in_container.backfill.DurationParamType |
Represents the type of a parameter |
flytekit.clis.sdk_in_container.backfill.WorkflowFailurePolicy |
Defines the behavior for a workflow execution in the case of an observed node execution failure |
flytekit.clis.sdk_in_container.backfill.datetime |
datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]]) |
flytekit.clis.sdk_in_container.backfill.timedelta |
Difference between two datetime values |
flytekit.clis.sdk_in_container.build.BuildCommand |
A click command group for building a image for flyte workflows & tasks in a file |
flytekit.clis.sdk_in_container.build.BuildParams |
None |
flytekit.clis.sdk_in_container.build.BuildWorkflowCommand |
click multicommand at the python file layer, subcommands should be all the workflows in the file |
flytekit.clis.sdk_in_container.build.ImageConfig |
We recommend you to use ImageConfig |
flytekit.clis.sdk_in_container.build.PythonFunctionWorkflow |
Please read :std:ref:flyte:divedeep-workflows first for a high-level understanding of what workflows are in Flyte |
flytekit.clis.sdk_in_container.build.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.clis.sdk_in_container.build.RunCommand |
A click command group for registering and executing flyte workflows & tasks in a file |
flytekit.clis.sdk_in_container.build.RunLevelParams |
This class is used to store the parameters that are used to run a workflow / task / launchplan |
flytekit.clis.sdk_in_container.build.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.clis.sdk_in_container.build.WorkflowCommand |
click multicommand at the python file layer, subcommands should be all the workflows in the file |
flytekit.clis.sdk_in_container.executions.FlyteRemote |
Main entrypoint for programmatically accessing a Flyte remote backend |
flytekit.clis.sdk_in_container.fetch.FlyteRemote |
Main entrypoint for programmatically accessing a Flyte remote backend |
flytekit.clis.sdk_in_container.fetch.Literal |
None |
flytekit.clis.sdk_in_container.fetch.LiteralsResolver |
LiteralsResolver is a helper class meant primarily for use with the FlyteRemote experience or any other situation |
flytekit.clis.sdk_in_container.fetch.Panel |
A console renderable that draws a border around its contents |
flytekit.clis.sdk_in_container.fetch.Pretty |
A rich renderable that pretty prints an object |
flytekit.clis.sdk_in_container.get.Console |
A high level console interface |
flytekit.clis.sdk_in_container.get.FlyteRemote |
Main entrypoint for programmatically accessing a Flyte remote backend |
flytekit.clis.sdk_in_container.get.Identifier |
None |
flytekit.clis.sdk_in_container.get.LaunchPlanState |
None |
flytekit.clis.sdk_in_container.get.NamedEntityIdentifier |
None |
flytekit.clis.sdk_in_container.get.ResourceType |
None |
flytekit.clis.sdk_in_container.get.Sort |
None |
flytekit.clis.sdk_in_container.get.Table |
A console renderable to draw a table |
flytekit.clis.sdk_in_container.helpers.CopyFileDetection |
Create a collection of name/value pairs |
flytekit.clis.sdk_in_container.helpers.FlyteRemote |
Main entrypoint for programmatically accessing a Flyte remote backend |
flytekit.clis.sdk_in_container.helpers.ImageConfig |
We recommend you to use ImageConfig |
flytekit.clis.sdk_in_container.init.BytesIO |
Buffered I/O implementation using an in-memory bytes buffer |
flytekit.clis.sdk_in_container.init.ZipFile |
Class with methods to open, read, write, close, list zip files |
flytekit.clis.sdk_in_container.launchplan.LaunchPlanState |
None |
flytekit.clis.sdk_in_container.launchplan.Progress |
Renders an auto-updating progress bar(s) |
flytekit.clis.sdk_in_container.local_cache.LocalTaskCache |
This class implements a persistent store able to cache the result of local task executions |
flytekit.clis.sdk_in_container.package.CopyFileDetection |
Create a collection of name/value pairs |
flytekit.clis.sdk_in_container.package.FastPackageOptions |
FastPackageOptions is used to set configuration options when packaging files |
flytekit.clis.sdk_in_container.package.FastSerializationSettings |
This object hold information about settings necessary to serialize an object so that it can be fast-registered |
flytekit.clis.sdk_in_container.package.ImageConfig |
We recommend you to use ImageConfig |
flytekit.clis.sdk_in_container.package.NoSerializableEntitiesError |
Common base class for all non-exit exceptions |
flytekit.clis.sdk_in_container.package.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.clis.sdk_in_container.pyflyte.ErrorHandlingCommand |
Helper class that wraps the invoke method of a click command to catch exceptions and print them in a nice way |
flytekit.clis.sdk_in_container.pyflyte.LocalSDK |
None |
flytekit.clis.sdk_in_container.register.CopyFileDetection |
Create a collection of name/value pairs |
flytekit.clis.sdk_in_container.register.DefaultImages |
We may want to load the default images from remote - maybe s3 location etc? |
flytekit.clis.sdk_in_container.register.ImageConfig |
We recommend you to use ImageConfig |
flytekit.clis.sdk_in_container.run.Annotations |
None |
flytekit.clis.sdk_in_container.run.ArtifactQuery |
None |
flytekit.clis.sdk_in_container.run.Context |
The context is a special internal object that holds state relevant |
flytekit.clis.sdk_in_container.run.CopyFileDetection |
Create a collection of name/value pairs |
flytekit.clis.sdk_in_container.run.DefaultImages |
We may want to load the default images from remote - maybe s3 location etc? |
flytekit.clis.sdk_in_container.run.DynamicEntityLaunchCommand |
This is a dynamic command that is created for each launch plan |
flytekit.clis.sdk_in_container.run.Entities |
NamedTuple to group all entities in a file |
flytekit.clis.sdk_in_container.run.FastPackageOptions |
FastPackageOptions is used to set configuration options when packaging files |
flytekit.clis.sdk_in_container.run.FastSerializationSettings |
This object hold information about settings necessary to serialize an object so that it can be fast-registered |
flytekit.clis.sdk_in_container.run.FileAccessProvider |
This is the class that is available through the FlyteContext and can be used for persisting data to the remote |
flytekit.clis.sdk_in_container.run.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.clis.sdk_in_container.run.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.clis.sdk_in_container.run.FlyteEntityNotFoundException |
Inappropriate argument value (of correct type) |
flytekit.clis.sdk_in_container.run.FlyteLaunchPlan |
A class encapsulating a remote Flyte launch plan |
flytekit.clis.sdk_in_container.run.FlyteLiteralConverter |
None |
flytekit.clis.sdk_in_container.run.FlyteRemote |
Main entrypoint for programmatically accessing a Flyte remote backend |
flytekit.clis.sdk_in_container.run.FlyteSystemException |
Common base class for all non-exit exceptions |
flytekit.clis.sdk_in_container.run.FlyteTask |
A class encapsulating a remote Flyte task |
flytekit.clis.sdk_in_container.run.FlyteWorkflow |
A class encapsulating a remote Flyte workflow |
flytekit.clis.sdk_in_container.run.FlyteWorkflowExecution |
A class encapsulating a workflow execution being run on a Flyte remote backend |
flytekit.clis.sdk_in_container.run.ImageConfig |
We recommend you to use ImageConfig |
flytekit.clis.sdk_in_container.run.JSONEncoder |
Abstract base class for generic types |
flytekit.clis.sdk_in_container.run.Labels |
None |
flytekit.clis.sdk_in_container.run.LaunchPlan |
Launch Plans are one of the core constructs of Flyte |
flytekit.clis.sdk_in_container.run.Literal |
None |
flytekit.clis.sdk_in_container.run.Options |
These are options that can be configured for a launchplan during registration or overridden during an execution |
flytekit.clis.sdk_in_container.run.Parameter |
None |
flytekit.clis.sdk_in_container.run.Progress |
Renders an auto-updating progress bar(s) |
flytekit.clis.sdk_in_container.run.PyFlyteParams |
None |
flytekit.clis.sdk_in_container.run.PythonFunctionWorkflow |
Please read :std:ref:flyte:divedeep-workflows first for a high-level understanding of what workflows are in Flyte |
flytekit.clis.sdk_in_container.run.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.clis.sdk_in_container.run.RawOutputDataConfig |
None |
flytekit.clis.sdk_in_container.run.RemoteEntityGroup |
click multicommand that retrieves launchplans from a remote flyte instance and executes them |
flytekit.clis.sdk_in_container.run.RunCommand |
A click command group for registering and executing flyte workflows & tasks in a file |
flytekit.clis.sdk_in_container.run.RunLevelComputedParams |
This class is used to store the computed parameters that are used to run a workflow / task / launchplan |
flytekit.clis.sdk_in_container.run.RunLevelParams |
This class is used to store the parameters that are used to run a workflow / task / launchplan |
flytekit.clis.sdk_in_container.run.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.clis.sdk_in_container.run.SimpleType |
None |
flytekit.clis.sdk_in_container.run.TextColumn |
A column containing text |
flytekit.clis.sdk_in_container.run.TimeElapsedColumn |
Renders time elapsed |
flytekit.clis.sdk_in_container.run.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.clis.sdk_in_container.run.Variable |
None |
flytekit.clis.sdk_in_container.run.WorkflowBase |
None |
flytekit.clis.sdk_in_container.run.WorkflowCommand |
click multicommand at the python file layer, subcommands should be all the workflows in the file |
flytekit.clis.sdk_in_container.run.WorkflowExecutionPhase |
This class holds enum values used for setting notifications |
flytekit.clis.sdk_in_container.run.YamlFileReadingCommand |
Richly formatted click Command |
flytekit.clis.sdk_in_container.serialize.Enum |
Create a collection of name/value pairs |
flytekit.clis.sdk_in_container.serialize.FastSerializationSettings |
This object hold information about settings necessary to serialize an object so that it can be fast-registered |
flytekit.clis.sdk_in_container.serialize.ImageConfig |
We recommend you to use ImageConfig |
flytekit.clis.sdk_in_container.serialize.SerializationMode |
Create a collection of name/value pairs |
flytekit.clis.sdk_in_container.serialize.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.clis.sdk_in_container.serve.Console |
A high level console interface |
flytekit.clis.sdk_in_container.serve.Table |
A console renderable to draw a table |
flytekit.clis.sdk_in_container.utils.Console |
A high level console interface |
flytekit.clis.sdk_in_container.utils.ErrorHandlingCommand |
Helper class that wraps the invoke method of a click command to catch exceptions and print them in a nice way |
flytekit.clis.sdk_in_container.utils.Field |
None |
flytekit.clis.sdk_in_container.utils.FlyteCompilationException |
Common base class for all non-exit exceptions |
flytekit.clis.sdk_in_container.utils.FlyteException |
Common base class for all non-exit exceptions |
flytekit.clis.sdk_in_container.utils.FlyteInvalidInputException |
Common base class for all non-exit exceptions |
flytekit.clis.sdk_in_container.utils.MappingProxyType |
None |
flytekit.clis.sdk_in_container.utils.Panel |
A console renderable that draws a border around its contents |
flytekit.clis.sdk_in_container.utils.PyFlyteParams |
None |
flytekit.clis.sdk_in_container.utils.Syntax |
Construct a Syntax object to render syntax highlighted code |
flytekit.clis.sdk_in_container.utils.Traceback |
A Console renderable that renders a traceback |
flytekit.clis.version.FlyteRemote |
Main entrypoint for programmatically accessing a Flyte remote backend |
flytekit.clis.version.Panel |
A console renderable that draws a border around its contents |
flytekit.configuration.AuthType |
Create a collection of name/value pairs |
flytekit.configuration.AzureBlobStorageConfig |
Any Azure Blob Storage specific configuration |
flytekit.configuration.BytesIO |
Buffered I/O implementation using an in-memory bytes buffer |
flytekit.configuration.Config |
This the parent configuration object and holds all the underlying configuration object types |
flytekit.configuration.ConfigEntry |
A top level Config entry holder, that holds multiple different representations of the config |
flytekit.configuration.ConfigFile |
None |
flytekit.configuration.DataClassJsonMixin |
DataClassJsonMixin is an ABC that functions as a Mixin |
flytekit.configuration.DataConfig |
Any data storage specific configuration |
flytekit.configuration.DefaultImages |
We may want to load the default images from remote - maybe s3 location etc? |
flytekit.configuration.EntrypointSettings |
This object carries information about the path of the entrypoint command that will be invoked at runtime |
flytekit.configuration.FastSerializationSettings |
This object hold information about settings necessary to serialize an object so that it can be fast-registered |
flytekit.configuration.GCSConfig |
Any GCS specific configuration |
flytekit.configuration.GenericPersistenceConfig |
Data storage configuration that applies across any provider |
flytekit.configuration.Image |
Image is a structured wrapper for task container images used in object serialization |
flytekit.configuration.ImageBuildEngine |
ImageBuildEngine contains a list of builders that can be used to build an ImageSpec |
flytekit.configuration.ImageConfig |
We recommend you to use ImageConfig |
flytekit.configuration.ImageSpec |
This class is used to specify the docker image that will be used to run the task |
flytekit.configuration.LocalConfig |
Any configuration specific to local runs |
flytekit.configuration.PlatformConfig |
This object contains the settings to talk to a Flyte backend (the DNS location of your Admin server basically) |
flytekit.configuration.S3Config |
S3 specific configuration |
flytekit.configuration.SecretsConfig |
Configuration for secrets |
flytekit.configuration.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.configuration.StatsConfig |
Configuration for sending statsd |
flytekit.configuration.default_images.DefaultImages |
We may want to load the default images from remote - maybe s3 location etc? |
flytekit.configuration.default_images.PythonVersion |
Create a collection of name/value pairs |
flytekit.configuration.default_images.suppress |
Context manager to suppress specified exceptions |
flytekit.configuration.feature_flags.FeatureFlags |
None |
flytekit.configuration.file.ConfigEntry |
A top level Config entry holder, that holds multiple different representations of the config |
flytekit.configuration.file.ConfigFile |
None |
flytekit.configuration.file.LegacyConfigEntry |
Creates a record for the config entry |
flytekit.configuration.file.Path |
PurePath subclass that can make system calls |
flytekit.configuration.file.YamlConfigEntry |
Creates a record for the config entry |
flytekit.configuration.internal.AWS |
None |
flytekit.configuration.internal.AZURE |
None |
flytekit.configuration.internal.ConfigEntry |
A top level Config entry holder, that holds multiple different representations of the config |
flytekit.configuration.internal.ConfigFile |
None |
flytekit.configuration.internal.Credentials |
None |
flytekit.configuration.internal.GCP |
None |
flytekit.configuration.internal.Images |
None |
flytekit.configuration.internal.LegacyConfigEntry |
Creates a record for the config entry |
flytekit.configuration.internal.Local |
None |
flytekit.configuration.internal.LocalSDK |
None |
flytekit.configuration.internal.Persistence |
None |
flytekit.configuration.internal.Platform |
None |
flytekit.configuration.internal.Secrets |
None |
flytekit.configuration.internal.StatsD |
None |
flytekit.configuration.internal.YamlConfigEntry |
Creates a record for the config entry |
flytekit.configuration.plugin.CachePolicy |
Base class for protocol classes |
flytekit.configuration.plugin.Config |
This the parent configuration object and holds all the underlying configuration object types |
flytekit.configuration.plugin.FlyteRemote |
Main entrypoint for programmatically accessing a Flyte remote backend |
flytekit.configuration.plugin.FlytekitPlugin |
None |
flytekit.configuration.plugin.FlytekitPluginProtocol |
Base class for protocol classes |
flytekit.configuration.plugin.Group |
A group allows a command to have subcommands attached |
flytekit.configuration.plugin.Protocol |
Base class for protocol classes |
flytekit.constants.CopyFileDetection |
Create a collection of name/value pairs |
flytekit.constants.Enum |
Create a collection of name/value pairs |
flytekit.core.annotation.Any |
Special type indicating an unconstrained type |
flytekit.core.annotation.FlyteAnnotation |
A core object to add arbitrary annotations to flyte types |
flytekit.core.array_node.Any |
Special type indicating an unconstrained type |
flytekit.core.array_node.ArrayNode |
None |
flytekit.core.array_node.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.core.array_node.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.array_node.LaunchPlan |
Launch Plans are one of the core constructs of Flyte |
flytekit.core.array_node.Literal |
None |
flytekit.core.array_node.LiteralCollection |
None |
flytekit.core.array_node.Node |
This class will hold all the things necessary to make an SdkNode but we won’t make one until we know things like |
flytekit.core.array_node.Promise |
This object is a wrapper and exists for three main reasons |
flytekit.core.array_node.ReferenceLaunchPlan |
A reference launch plan serves as a pointer to a Launch Plan that already exists on your Flyte installation |
flytekit.core.array_node.ReferenceTask |
This is a reference task, the body of the function passed in through the constructor will never be used, only the |
flytekit.core.array_node.Scalar |
None |
flytekit.core.array_node.VoidPromise |
This object is returned for tasks that do not return any outputs (declared interface is empty) |
flytekit.core.array_node_map_task.Any |
Special type indicating an unconstrained type |
flytekit.core.array_node_map_task.ArrayNodeMapTask |
Base Class for all Tasks with a Python native Interface |
flytekit.core.array_node_map_task.ArrayNodeMapTaskResolver |
Special resolver that is used for ArrayNodeMapTasks |
flytekit.core.array_node_map_task.Container |
None |
flytekit.core.array_node_map_task.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.core.array_node_map_task.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.array_node_map_task.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.array_node_map_task.K8sPod |
None |
flytekit.core.array_node_map_task.LaunchPlan |
Launch Plans are one of the core constructs of Flyte |
flytekit.core.array_node_map_task.NodeMetadata |
None |
flytekit.core.array_node_map_task.PythonFunctionTask |
A Python Function task should be used as the base for all extensions that have a python function |
flytekit.core.array_node_map_task.PythonInstanceTask |
This class should be used as the base class for all Tasks that do not have a user defined function body, but have |
flytekit.core.array_node_map_task.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.core.array_node_map_task.ReferenceTask |
This is a reference task, the body of the function passed in through the constructor will never be used, only the |
flytekit.core.array_node_map_task.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.core.array_node_map_task.Sql |
None |
flytekit.core.array_node_map_task.Task |
None |
flytekit.core.array_node_map_task.TaskResolverMixin |
Flytekit tasks interact with the Flyte platform very, very broadly in two steps |
flytekit.core.array_node_map_task.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.core.array_node_map_task.Variable |
None |
flytekit.core.array_node_map_task.timeit |
A context manager and a decorator that measures the execution time of the wrapped code block or functions |
flytekit.core.artifact.Artifact |
An Artifact is effectively just a metadata layer on top of data that exists in Flyte |
flytekit.core.artifact.ArtifactIDSpecification |
This is a special object that helps specify how Artifacts are to be created |
flytekit.core.artifact.ArtifactQuery |
None |
flytekit.core.artifact.ArtifactSerializationHandler |
This protocol defines the interface for serializing artifact-related entities down to Flyte IDL |
flytekit.core.artifact.DefaultArtifactSerializationHandler |
This protocol defines the interface for serializing artifact-related entities down to Flyte IDL |
flytekit.core.artifact.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.artifact.InputsBase |
A class to provide better partition semantics |
flytekit.core.artifact.OutputMetadata |
None |
flytekit.core.artifact.Partition |
None |
flytekit.core.artifact.Partitions |
None |
flytekit.core.artifact.SerializableToString |
This protocol is used by the Artifact create_from function |
flytekit.core.artifact.Serializer |
None |
flytekit.core.artifact.TimePartition |
None |
flytekit.core.artifact.Timestamp |
A ProtocolMessage |
flytekit.core.artifact.timedelta |
Difference between two datetime values |
flytekit.core.artifact_utils.LabelValue |
A ProtocolMessage |
flytekit.core.artifact_utils.Partitions |
A ProtocolMessage |
flytekit.core.artifact_utils.TimePartition |
A ProtocolMessage |
flytekit.core.artifact_utils.Timestamp |
A ProtocolMessage |
flytekit.core.artifact_utils.datetime |
datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]]) |
flytekit.core.base_sql_task.Any |
Special type indicating an unconstrained type |
flytekit.core.base_sql_task.Interface |
A Python native interface object, like inspect |
flytekit.core.base_sql_task.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.core.base_sql_task.SQLTask |
Base task types for all SQL tasks |
flytekit.core.base_sql_task.TaskMetadata |
Metadata for a Task |
flytekit.core.base_sql_task.TypeVar |
Type variable |
flytekit.core.base_task.Any |
Special type indicating an unconstrained type |
flytekit.core.base_task.DeckField |
DeckField is used to specify the fields that will be rendered in the deck |
flytekit.core.base_task.Description |
Full user description with formatting preserved |
flytekit.core.base_task.Documentation |
DescriptionEntity contains detailed description for the task/workflow/launch plan |
flytekit.core.base_task.ExecutionParameters |
This is a run-time user-centric context object that is accessible to every @task method |
flytekit.core.base_task.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.core.base_task.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.base_task.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.base_task.FlyteDownloadDataException |
Common base class for all non-exit exceptions |
flytekit.core.base_task.FlyteEntities |
This is a global Object that tracks various tasks and workflows that are declared within a VM during the |
flytekit.core.base_task.FlyteNonRecoverableSystemException |
Common base class for all non-exit exceptions |
flytekit.core.base_task.FlyteUploadDataException |
Common base class for all non-exit exceptions |
flytekit.core.base_task.FlyteUserRuntimeException |
Common base class for all non-exit exceptions |
flytekit.core.base_task.Generic |
Abstract base class for generic types |
flytekit.core.base_task.IgnoreOutputs |
This exception should be used to indicate that the outputs generated by this can be safely ignored |
flytekit.core.base_task.Interface |
A Python native interface object, like inspect |
flytekit.core.base_task.LocalConfig |
Any configuration specific to local runs |
flytekit.core.base_task.LocalTaskCache |
This class implements a persistent store able to cache the result of local task executions |
flytekit.core.base_task.Promise |
This object is a wrapper and exists for three main reasons |
flytekit.core.base_task.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.core.base_task.SecurityContext |
This is a higher level wrapper object that for the most part users shouldn’t have to worry about |
flytekit.core.base_task.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.core.base_task.Task |
The base of all Tasks in flytekit |
flytekit.core.base_task.TaskMetadata |
Metadata for a Task |
flytekit.core.base_task.TaskResolverMixin |
Flytekit tasks interact with the Flyte platform very, very broadly in two steps |
flytekit.core.base_task.TrackedInstance |
Please see the notes for the metaclass above first |
flytekit.core.base_task.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.core.base_task.TypeTransformerFailedError |
Inappropriate argument type |
flytekit.core.base_task.TypeVar |
Type variable |
flytekit.core.base_task.Variable |
None |
flytekit.core.base_task.VoidPromise |
This object is returned for tasks that do not return any outputs (declared interface is empty) |
flytekit.core.base_task.timeit |
A context manager and a decorator that measures the execution time of the wrapped code block or functions |
flytekit.core.cache.Cache |
Cache configuration for a task |
flytekit.core.cache.CachePolicy |
Base class for protocol classes |
flytekit.core.cache.Generic |
Abstract base class for generic types |
flytekit.core.cache.ImageSpec |
This class is used to specify the docker image that will be used to run the task |
flytekit.core.cache.ParamSpec |
Parameter specification |
flytekit.core.cache.PodTemplate |
Custom PodTemplate specification for a Task |
flytekit.core.cache.Protocol |
Base class for protocol classes |
flytekit.core.cache.TypeVar |
Type variable |
flytekit.core.cache.VersionParameters |
Parameters used for version hash generation |
flytekit.core.checkpointer.Checkpoint |
Base class for Checkpoint system |
flytekit.core.checkpointer.Path |
PurePath subclass that can make system calls |
flytekit.core.checkpointer.SyncCheckpoint |
This class is NOT THREAD-SAFE! |
flytekit.core.class_based_resolver.ClassStorageTaskResolver |
Stores tasks inside a class variable |
flytekit.core.class_based_resolver.PythonAutoContainerTask |
A Python AutoContainer task should be used as the base for all extensions that want the user’s code to be in the |
flytekit.core.class_based_resolver.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.core.class_based_resolver.TaskResolverMixin |
Flytekit tasks interact with the Flyte platform very, very broadly in two steps |
flytekit.core.class_based_resolver.TrackedInstance |
Please see the notes for the metaclass above first |
flytekit.core.condition.Binding |
None |
flytekit.core.condition.BindingData |
None |
flytekit.core.condition.BranchNode |
None |
flytekit.core.condition.Case |
None |
flytekit.core.condition.ComparisonExpression |
ComparisonExpression refers to an expression of the form (lhs operator rhs), where lhs and rhs are operands |
flytekit.core.condition.ComparisonOps |
Create a collection of name/value pairs |
flytekit.core.condition.Condition |
None |
flytekit.core.condition.ConditionalSection |
ConditionalSection is used to denote a condition within a Workflow |
flytekit.core.condition.ConjunctionExpression |
A Conjunction Expression is an expression of the form either (A and B) or (A or B) |
flytekit.core.condition.ConjunctionOps |
Create a collection of name/value pairs |
flytekit.core.condition.Error |
None |
flytekit.core.condition.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.condition.Literal |
None |
flytekit.core.condition.LocalExecutedConditionalSection |
ConditionalSection is used to denote a condition within a Workflow |
flytekit.core.condition.Node |
This class will hold all the things necessary to make an SdkNode but we won’t make one until we know things like |
flytekit.core.condition.NodeOutput |
None |
flytekit.core.condition.Promise |
This object is a wrapper and exists for three main reasons |
flytekit.core.condition.RetryStrategy |
None |
flytekit.core.condition.SkippedConditionalSection |
This ConditionalSection is used for nested conditionals, when the branch has been evaluated to false |
flytekit.core.condition.VoidPromise |
This object is returned for tasks that do not return any outputs (declared interface is empty) |
flytekit.core.container_task.Any |
Special type indicating an unconstrained type |
flytekit.core.container_task.ContainerTask |
This is an intermediate class that represents Flyte Tasks that run a container at execution time |
flytekit.core.container_task.Enum |
Create a collection of name/value pairs |
flytekit.core.container_task.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.container_task.ImageSpec |
This class is used to specify the docker image that will be used to run the task |
flytekit.core.container_task.Interface |
A Python native interface object, like inspect |
flytekit.core.container_task.LiteralMap |
None |
flytekit.core.container_task.PodTemplate |
Custom PodTemplate specification for a Task |
flytekit.core.container_task.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.core.container_task.ResourceSpec |
None |
flytekit.core.container_task.Resources |
This class is used to specify both resource requests and resource limits |
flytekit.core.container_task.Secret |
See :std:ref:cookbook:secrets for usage examples |
flytekit.core.container_task.SecurityContext |
This is a higher level wrapper object that for the most part users shouldn’t have to worry about |
flytekit.core.container_task.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.core.container_task.TaskMetadata |
Metadata for a Task |
flytekit.core.context_manager.BranchEvalMode |
This is a 3-way class, with the None value meaning that we are not within a conditional context |
flytekit.core.context_manager.Checkpoint |
Base class for Checkpoint system |
flytekit.core.context_manager.CompilationState |
Compilation state is used during the compilation of a workflow or task |
flytekit.core.context_manager.Config |
This the parent configuration object and holds all the underlying configuration object types |
flytekit.core.context_manager.ContextVar |
None |
flytekit.core.context_manager.Enum |
Create a collection of name/value pairs |
flytekit.core.context_manager.ExecutionParameters |
This is a run-time user-centric context object that is accessible to every @task method |
flytekit.core.context_manager.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.core.context_manager.FileAccessProvider |
This is the class that is available through the FlyteContext and can be used for persisting data to the remote |
flytekit.core.context_manager.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.context_manager.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.context_manager.FlyteEntities |
This is a global Object that tracks various tasks and workflows that are declared within a VM during the |
flytekit.core.context_manager.FrameType |
None |
flytekit.core.context_manager.Node |
This class will hold all the things necessary to make an SdkNode but we won’t make one until we know things like |
flytekit.core.context_manager.OutputMetadata |
None |
flytekit.core.context_manager.OutputMetadataTracker |
This class is for the users to set arbitrary metadata on output literals |
flytekit.core.context_manager.SecretsConfig |
Configuration for secrets |
flytekit.core.context_manager.SecretsManager |
This provides a secrets resolution logic at runtime |
flytekit.core.context_manager.SerializableToString |
This protocol is used by the Artifact create_from function |
flytekit.core.context_manager.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.core.context_manager.SyncCheckpoint |
This class is NOT THREAD-SAFE! |
flytekit.core.context_manager.WorkflowExecutionIdentifier |
None |
flytekit.core.context_manager.datetime |
datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]]) |
flytekit.core.context_manager.timezone |
Fixed offset from UTC implementation of tzinfo |
flytekit.core.data_persistence.Any |
Special type indicating an unconstrained type |
flytekit.core.data_persistence.AsyncFileSystem |
Async file operations, default implementations |
flytekit.core.data_persistence.DataConfig |
Any data storage specific configuration |
flytekit.core.data_persistence.FileAccessProvider |
This is the class that is available through the FlyteContext and can be used for persisting data to the remote |
flytekit.core.data_persistence.FlyteAssertion |
Assertion failed |
flytekit.core.data_persistence.FlyteDataNotFoundException |
Inappropriate argument value (of correct type) |
flytekit.core.data_persistence.FlyteDownloadDataException |
Common base class for all non-exit exceptions |
flytekit.core.data_persistence.FlyteLocalFileSystem |
This class doesn’t do anything except override the separator so that it works on windows |
flytekit.core.data_persistence.FlyteUploadDataException |
Common base class for all non-exit exceptions |
flytekit.core.data_persistence.UUID |
Instances of the UUID class represent UUIDs as specified in RFC 4122 |
flytekit.core.data_persistence.timeit |
A context manager and a decorator that measures the execution time of the wrapped code block or functions |
flytekit.core.docstring.Docstring |
None |
flytekit.core.dynamic_workflow_task.PythonFunctionTask |
A Python Function task should be used as the base for all extensions that have a python function |
flytekit.core.environment.Any |
Special type indicating an unconstrained type |
flytekit.core.environment.Console |
A high level console interface |
flytekit.core.environment.Environment |
None |
flytekit.core.environment.Panel |
A console renderable that draws a border around its contents |
flytekit.core.environment.ParamSpec |
Parameter specification |
flytekit.core.environment.Pretty |
A rich renderable that pretty prints an object |
flytekit.core.environment.TypeVar |
Type variable |
flytekit.core.environment.partial |
partial(func, *args, **keywords) - new function with partial application |
flytekit.core.gate.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.core.gate.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.gate.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.gate.FlyteDisapprovalException |
Assertion failed |
flytekit.core.gate.Gate |
A node type that waits for user input before proceeding with a workflow |
flytekit.core.gate.LiteralType |
None |
flytekit.core.gate.Promise |
This object is a wrapper and exists for three main reasons |
flytekit.core.gate.Scalar |
None |
flytekit.core.gate.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.core.gate.VoidPromise |
This object is returned for tasks that do not return any outputs (declared interface is empty) |
flytekit.core.hash.Generic |
Abstract base class for generic types |
flytekit.core.hash.HashMethod |
Flyte-specific object used to wrap the hash function for a specific type |
flytekit.core.hash.HashOnReferenceMixin |
None |
flytekit.core.hash.TypeVar |
Type variable |
flytekit.core.interface.Any |
Special type indicating an unconstrained type |
flytekit.core.interface.Artifact |
An Artifact is effectively just a metadata layer on top of data that exists in Flyte |
flytekit.core.interface.ArtifactIDSpecification |
This is a special object that helps specify how Artifacts are to be created |
flytekit.core.interface.ArtifactQuery |
None |
flytekit.core.interface.Docstring |
None |
flytekit.core.interface.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.interface.FlyteMissingReturnValueException |
Common base class for all non-exit exceptions |
flytekit.core.interface.FlyteMissingTypeException |
Common base class for all non-exit exceptions |
flytekit.core.interface.FlyteValidationException |
Assertion failed |
flytekit.core.interface.Interface |
A Python native interface object, like inspect |
flytekit.core.interface.Literal |
None |
flytekit.core.interface.OrderedDict |
Dictionary that remembers insertion order |
flytekit.core.interface.Scalar |
None |
flytekit.core.interface.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.core.interface.TypeVar |
Type variable |
flytekit.core.interface.UnionTransformer |
Transformer that handles a typing |
flytekit.core.interface.Void |
None |
flytekit.core.launch_plan.Any |
Special type indicating an unconstrained type |
flytekit.core.launch_plan.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.launch_plan.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.launch_plan.FlyteEntities |
This is a global Object that tracks various tasks and workflows that are declared within a VM during the |
flytekit.core.launch_plan.Interface |
A Python native interface object, like inspect |
flytekit.core.launch_plan.LaunchPlan |
Launch Plans are one of the core constructs of Flyte |
flytekit.core.launch_plan.LaunchPlanReference |
A reference object containing metadata that points to a remote launch plan |
flytekit.core.launch_plan.LaunchPlanTriggerBase |
Base class for protocol classes |
flytekit.core.launch_plan.ReferenceEntity |
None |
flytekit.core.launch_plan.ReferenceLaunchPlan |
A reference launch plan serves as a pointer to a Launch Plan that already exists on your Flyte installation |
flytekit.core.legacy_map_task.Any |
Special type indicating an unconstrained type |
flytekit.core.legacy_map_task.ArrayJob |
None |
flytekit.core.legacy_map_task.Container |
None |
flytekit.core.legacy_map_task.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.core.legacy_map_task.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.legacy_map_task.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.legacy_map_task.K8sPod |
None |
flytekit.core.legacy_map_task.MapPythonTask |
A MapPythonTask defines a :py:class:`flytekit |
flytekit.core.legacy_map_task.MapTaskResolver |
Special resolver that is used for MapTasks |
flytekit.core.legacy_map_task.PythonFunctionTask |
A Python Function task should be used as the base for all extensions that have a python function |
flytekit.core.legacy_map_task.PythonInstanceTask |
This class should be used as the base class for all Tasks that do not have a user defined function body, but have |
flytekit.core.legacy_map_task.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.core.legacy_map_task.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.core.legacy_map_task.Sql |
None |
flytekit.core.legacy_map_task.Task |
The base of all Tasks in flytekit |
flytekit.core.legacy_map_task.TaskResolverMixin |
Flytekit tasks interact with the Flyte platform very, very broadly in two steps |
flytekit.core.legacy_map_task.TrackedInstance |
Please see the notes for the metaclass above first |
flytekit.core.legacy_map_task.Variable |
None |
flytekit.core.legacy_map_task.timeit |
A context manager and a decorator that measures the execution time of the wrapped code block or functions |
flytekit.core.local_cache.Cache |
Disk and file backed cache |
flytekit.core.local_cache.Literal |
None |
flytekit.core.local_cache.LiteralCollection |
None |
flytekit.core.local_cache.LiteralMap |
A ProtocolMessage |
flytekit.core.local_cache.LocalTaskCache |
This class implements a persistent store able to cache the result of local task executions |
flytekit.core.local_cache.ModelLiteralMap |
None |
flytekit.core.local_fsspec.FlyteLocalFileSystem |
This class doesn’t do anything except override the separator so that it works on windows |
flytekit.core.local_fsspec.LocalFileSystem |
Interface to files on local storage |
flytekit.core.mock_stats.MockStats |
None |
flytekit.core.node.Any |
Special type indicating an unconstrained type |
flytekit.core.node.BaseAccelerator |
Base class for all accelerator types |
flytekit.core.node.Node |
This class will hold all the things necessary to make an SdkNode but we won’t make one until we know things like |
flytekit.core.node.PodTemplate |
Custom PodTemplate specification for a Task |
flytekit.core.node.ResourceSpec |
None |
flytekit.core.node.Resources |
This class is used to specify both resource requests and resource limits |
flytekit.core.node_creation.BranchEvalMode |
This is a 3-way class, with the None value meaning that we are not within a conditional context |
flytekit.core.node_creation.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.core.node_creation.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.node_creation.LaunchPlan |
Launch Plans are one of the core constructs of Flyte |
flytekit.core.node_creation.Node |
This class will hold all the things necessary to make an SdkNode but we won’t make one until we know things like |
flytekit.core.node_creation.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.core.node_creation.VoidPromise |
This object is returned for tasks that do not return any outputs (declared interface is empty) |
flytekit.core.node_creation.WorkflowBase |
None |
flytekit.core.notification.Email |
This notification should be used when sending regular emails to people |
flytekit.core.notification.Notification |
None |
flytekit.core.notification.PagerDuty |
This notification should be used when sending emails to the PagerDuty service |
flytekit.core.notification.Slack |
This notification should be used when sending emails to the Slack |
flytekit.core.options.Options |
These are options that can be configured for a launchplan during registration or overridden during an execution |
flytekit.core.pod_template.PodTemplate |
Custom PodTemplate specification for a Task |
flytekit.core.promise.Annotated |
Add context-specific metadata to a type |
flytekit.core.promise.Any |
Special type indicating an unconstrained type |
flytekit.core.promise.AsyncTypeTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.core.promise.BaseAccelerator |
Base class for all accelerator types |
flytekit.core.promise.Binary |
None |
flytekit.core.promise.BranchEvalMode |
This is a 3-way class, with the None value meaning that we are not within a conditional context |
flytekit.core.promise.ComparisonExpression |
ComparisonExpression refers to an expression of the form (lhs operator rhs), where lhs and rhs are operands |
flytekit.core.promise.ComparisonOps |
Create a collection of name/value pairs |
flytekit.core.promise.ConjunctionExpression |
A Conjunction Expression is an expression of the form either (A and B) or (A or B) |
flytekit.core.promise.ConjunctionOps |
Create a collection of name/value pairs |
flytekit.core.promise.DictTransformer |
Transformer that transforms an univariate dictionary Dict[str, T] to a Literal Map or |
flytekit.core.promise.Enum |
Create a collection of name/value pairs |
flytekit.core.promise.ExecutionParameters |
This is a run-time user-centric context object that is accessible to every @task method |
flytekit.core.promise.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.core.promise.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.promise.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.promise.FlytePromiseAttributeResolveException |
Assertion failed |
flytekit.core.promise.HasFlyteInterface |
Base class for protocol classes |
flytekit.core.promise.Interface |
A Python native interface object, like inspect |
flytekit.core.promise.Iterable |
None |
flytekit.core.promise.ListTransformer |
Transformer that handles a univariate typing |
flytekit.core.promise.Literal |
None |
flytekit.core.promise.LocallyExecutable |
Base class for protocol classes |
flytekit.core.promise.Node |
This class will hold all the things necessary to make an SdkNode but we won’t make one until we know things like |
flytekit.core.promise.NodeOutput |
None |
flytekit.core.promise.OutputMetadataTracker |
This class is for the users to set arbitrary metadata on output literals |
flytekit.core.promise.Primitive |
None |
flytekit.core.promise.Promise |
This object is a wrapper and exists for three main reasons |
flytekit.core.promise.Protocol |
Base class for protocol classes |
flytekit.core.promise.Resources |
None |
flytekit.core.promise.Scalar |
None |
flytekit.core.promise.SimpleType |
None |
flytekit.core.promise.SupportsNodeCreation |
Base class for protocol classes |
flytekit.core.promise.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.core.promise.TypeTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.core.promise.TypeTransformerFailedError |
Inappropriate argument type |
flytekit.core.promise.UnionTransformer |
Transformer that handles a typing |
flytekit.core.promise.VoidPromise |
This object is returned for tasks that do not return any outputs (declared interface is empty) |
flytekit.core.python_auto_container.ABC |
Helper class that provides a standard way to create an ABC using |
flytekit.core.python_auto_container.BaseAccelerator |
Base class for all accelerator types |
flytekit.core.python_auto_container.CopyFileDetection |
Create a collection of name/value pairs |
flytekit.core.python_auto_container.DefaultNotebookTaskResolver |
This resolved is used when the task is defined in a notebook |
flytekit.core.python_auto_container.DefaultTaskResolver |
Please see the notes in the TaskResolverMixin as it describes this default behavior |
flytekit.core.python_auto_container.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.python_auto_container.FlyteTrackedABC |
This class exists because if you try to inherit from abc |
flytekit.core.python_auto_container.ImageBuildEngine |
ImageBuildEngine contains a list of builders that can be used to build an ImageSpec |
flytekit.core.python_auto_container.ImageConfig |
We recommend you to use ImageConfig |
flytekit.core.python_auto_container.ImageSpec |
This class is used to specify the docker image that will be used to run the task |
flytekit.core.python_auto_container.PickledEntity |
Represents the structure of the pickled object stored in the |
flytekit.core.python_auto_container.PickledEntityMetadata |
Metadata for a pickled entity containing version information |
flytekit.core.python_auto_container.PodTemplate |
Custom PodTemplate specification for a Task |
flytekit.core.python_auto_container.PythonAutoContainerTask |
A Python AutoContainer task should be used as the base for all extensions that want the user’s code to be in the |
flytekit.core.python_auto_container.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.core.python_auto_container.ResourceSpec |
None |
flytekit.core.python_auto_container.Resources |
This class is used to specify both resource requests and resource limits |
flytekit.core.python_auto_container.Secret |
See :std:ref:cookbook:secrets for usage examples |
flytekit.core.python_auto_container.SecurityContext |
This is a higher level wrapper object that for the most part users shouldn’t have to worry about |
flytekit.core.python_auto_container.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.core.python_auto_container.TaskMetadata |
Metadata for a Task |
flytekit.core.python_auto_container.TaskResolverMixin |
Flytekit tasks interact with the Flyte platform very, very broadly in two steps |
flytekit.core.python_auto_container.TrackedInstance |
Please see the notes for the metaclass above first |
flytekit.core.python_auto_container.TypeVar |
Type variable |
flytekit.core.python_auto_container.timeit |
A context manager and a decorator that measures the execution time of the wrapped code block or functions |
flytekit.core.python_customized_container_task.Any |
Special type indicating an unconstrained type |
flytekit.core.python_customized_container_task.ExecutableTemplateShimTask |
The canonical @task decorated Python function task is pretty simple to reason about |
flytekit.core.python_customized_container_task.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.python_customized_container_task.Image |
Image is a structured wrapper for task container images used in object serialization |
flytekit.core.python_customized_container_task.ImageConfig |
We recommend you to use ImageConfig |
flytekit.core.python_customized_container_task.ImageSpec |
This class is used to specify the docker image that will be used to run the task |
flytekit.core.python_customized_container_task.PythonCustomizedContainerTask |
Please take a look at the comments for :py:class`flytekit |
flytekit.core.python_customized_container_task.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.core.python_customized_container_task.ResourceSpec |
None |
flytekit.core.python_customized_container_task.Resources |
This class is used to specify both resource requests and resource limits |
flytekit.core.python_customized_container_task.Secret |
See :std:ref:cookbook:secrets for usage examples |
flytekit.core.python_customized_container_task.SecurityContext |
This is a higher level wrapper object that for the most part users shouldn’t have to worry about |
flytekit.core.python_customized_container_task.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.core.python_customized_container_task.ShimTaskExecutor |
Please see the notes for the metaclass above first |
flytekit.core.python_customized_container_task.Task |
The base of all Tasks in flytekit |
flytekit.core.python_customized_container_task.TaskResolverMixin |
Flytekit tasks interact with the Flyte platform very, very broadly in two steps |
flytekit.core.python_customized_container_task.TaskTemplateResolver |
This is a special resolver that resolves the task above at execution time, using only the TaskTemplate, |
flytekit.core.python_customized_container_task.TrackedInstance |
Please see the notes for the metaclass above first |
flytekit.core.python_customized_container_task.TypeVar |
Type variable |
flytekit.core.python_function_task.ABC |
Helper class that provides a standard way to create an ABC using |
flytekit.core.python_function_task.Any |
Special type indicating an unconstrained type |
flytekit.core.python_function_task.AsyncPythonFunctionTask |
This is the base task for eager tasks, as well as normal async tasks |
flytekit.core.python_function_task.Controller |
This controller object is responsible for kicking off and monitoring executions against a Flyte Admin endpoint |
flytekit.core.python_function_task.Deck |
Deck enable users to get customizable and default visibility into their tasks |
flytekit.core.python_function_task.Docstring |
None |
flytekit.core.python_function_task.EagerAsyncPythonFunctionTask |
This is the base eager task (aka eager workflow) type |
flytekit.core.python_function_task.EagerException |
Raised when a node in an eager workflow encounters an error |
flytekit.core.python_function_task.EagerFailureHandlerTask |
A Python AutoContainer task should be used as the base for all extensions that want the user’s code to be in the |
flytekit.core.python_function_task.EagerFailureTaskResolver |
Flytekit tasks interact with the Flyte platform very, very broadly in two steps |
flytekit.core.python_function_task.Enum |
Create a collection of name/value pairs |
flytekit.core.python_function_task.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.core.python_function_task.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.python_function_task.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.python_function_task.FlyteNonRecoverableSystemException |
Common base class for all non-exit exceptions |
flytekit.core.python_function_task.FlyteTrackedABC |
This class exists because if you try to inherit from abc |
flytekit.core.python_function_task.FlyteValueException |
Inappropriate argument value (of correct type) |
flytekit.core.python_function_task.ImageConfig |
We recommend you to use ImageConfig |
flytekit.core.python_function_task.ImageSpec |
This class is used to specify the docker image that will be used to run the task |
flytekit.core.python_function_task.Interface |
A Python native interface object, like inspect |
flytekit.core.python_function_task.LiteralMap |
None |
flytekit.core.python_function_task.OrderedDict |
Dictionary that remembers insertion order |
flytekit.core.python_function_task.Promise |
This object is a wrapper and exists for three main reasons |
flytekit.core.python_function_task.PythonAutoContainerTask |
A Python AutoContainer task should be used as the base for all extensions that want the user’s code to be in the |
flytekit.core.python_function_task.PythonFunctionTask |
A Python Function task should be used as the base for all extensions that have a python function |
flytekit.core.python_function_task.PythonFunctionWorkflow |
Please read :std:ref:flyte:divedeep-workflows first for a high-level understanding of what workflows are in Flyte |
flytekit.core.python_function_task.PythonInstanceTask |
This class should be used as the base class for all Tasks that do not have a user defined function body, but have |
flytekit.core.python_function_task.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.core.python_function_task.Task |
The base of all Tasks in flytekit |
flytekit.core.python_function_task.TaskMetadata |
Metadata for a Task |
flytekit.core.python_function_task.TaskResolverMixin |
Flytekit tasks interact with the Flyte platform very, very broadly in two steps |
flytekit.core.python_function_task.TypeVar |
Type variable |
flytekit.core.python_function_task.ValueIn |
None |
flytekit.core.python_function_task.VoidPromise |
This object is returned for tasks that do not return any outputs (declared interface is empty) |
flytekit.core.python_function_task.WorkflowBase |
None |
flytekit.core.python_function_task.WorkflowFailurePolicy |
Defines the behavior for a workflow execution in the case of an observed node execution failure |
flytekit.core.python_function_task.WorkflowMetadata |
None |
flytekit.core.python_function_task.WorkflowMetadataDefaults |
This class is similarly named to the one above |
flytekit.core.python_function_task.suppress |
Context manager to suppress specified exceptions |
flytekit.core.reference.FlyteValidationException |
Assertion failed |
flytekit.core.reference.ReferenceLaunchPlan |
A reference launch plan serves as a pointer to a Launch Plan that already exists on your Flyte installation |
flytekit.core.reference.ReferenceTask |
This is a reference task, the body of the function passed in through the constructor will never be used, only the |
flytekit.core.reference.ReferenceWorkflow |
A reference workflow is a pointer to a workflow that already exists on your Flyte installation |
flytekit.core.reference_entity.ABC |
Helper class that provides a standard way to create an ABC using |
flytekit.core.reference_entity.Any |
Special type indicating an unconstrained type |
flytekit.core.reference_entity.BranchEvalMode |
This is a 3-way class, with the None value meaning that we are not within a conditional context |
flytekit.core.reference_entity.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.core.reference_entity.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.reference_entity.Interface |
A Python native interface object, like inspect |
flytekit.core.reference_entity.LaunchPlanReference |
A reference object containing metadata that points to a remote launch plan |
flytekit.core.reference_entity.Promise |
This object is a wrapper and exists for three main reasons |
flytekit.core.reference_entity.Reference |
None |
flytekit.core.reference_entity.ReferenceEntity |
None |
flytekit.core.reference_entity.ReferenceSpec |
None |
flytekit.core.reference_entity.ReferenceTemplate |
None |
flytekit.core.reference_entity.TaskReference |
A reference object containing metadata that points to a remote task |
flytekit.core.reference_entity.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.core.reference_entity.VoidPromise |
This object is returned for tasks that do not return any outputs (declared interface is empty) |
flytekit.core.reference_entity.WorkflowReference |
A reference object containing metadata that points to a remote workflow |
flytekit.core.resources.BaseAccelerator |
Base class for all accelerator types |
flytekit.core.resources.DataClassJSONMixin |
None |
flytekit.core.resources.ResourceSpec |
None |
flytekit.core.resources.Resources |
This class is used to specify both resource requests and resource limits |
flytekit.core.schedule.CronSchedule |
Use this when you have a launch plan that you want to run on a cron expression |
flytekit.core.schedule.FixedRate |
Use this class to schedule a fixed-rate interval for a launch plan |
flytekit.core.schedule.LaunchPlanTriggerBase |
Base class for protocol classes |
flytekit.core.schedule.OnSchedule |
Base class for protocol classes |
flytekit.core.schedule.Protocol |
Base class for protocol classes |
flytekit.core.shim_task.Any |
Special type indicating an unconstrained type |
flytekit.core.shim_task.ExecutableTemplateShimTask |
The canonical @task decorated Python function task is pretty simple to reason about |
flytekit.core.shim_task.ExecutionParameters |
This is a run-time user-centric context object that is accessible to every @task method |
flytekit.core.shim_task.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.core.shim_task.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.shim_task.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.shim_task.Generic |
Abstract base class for generic types |
flytekit.core.shim_task.ShimTaskExecutor |
Please see the notes for the metaclass above first |
flytekit.core.shim_task.TrackedInstance |
Please see the notes for the metaclass above first |
flytekit.core.shim_task.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.core.shim_task.TypeVar |
Type variable |
flytekit.core.task.Any |
Special type indicating an unconstrained type |
flytekit.core.task.AsyncPythonFunctionTask |
This is the base task for eager tasks, as well as normal async tasks |
flytekit.core.task.BaseAccelerator |
Base class for all accelerator types |
flytekit.core.task.Cache |
Cache configuration for a task |
flytekit.core.task.DeckField |
DeckField is used to specify the fields that will be rendered in the deck |
flytekit.core.task.Documentation |
DescriptionEntity contains detailed description for the task/workflow/launch plan |
flytekit.core.task.EagerAsyncPythonFunctionTask |
This is the base eager task (aka eager workflow) type |
flytekit.core.task.Echo |
Base Class for all Tasks with a Python native Interface |
flytekit.core.task.ImageSpec |
This class is used to specify the docker image that will be used to run the task |
flytekit.core.task.Interface |
A Python native interface object, like inspect |
flytekit.core.task.ParamSpec |
Parameter specification |
flytekit.core.task.PodTemplate |
Custom PodTemplate specification for a Task |
flytekit.core.task.PythonFunctionTask |
A Python Function task should be used as the base for all extensions that have a python function |
flytekit.core.task.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.core.task.ReferenceEntity |
None |
flytekit.core.task.ReferenceTask |
This is a reference task, the body of the function passed in through the constructor will never be used, only the |
flytekit.core.task.Resources |
This class is used to specify both resource requests and resource limits |
flytekit.core.task.Secret |
See :std:ref:cookbook:secrets for usage examples |
flytekit.core.task.TaskMetadata |
Metadata for a Task |
flytekit.core.task.TaskPlugins |
This is the TaskPlugins factory for task types that are derivative of PythonFunctionTask |
flytekit.core.task.TaskReference |
A reference object containing metadata that points to a remote task |
flytekit.core.task.TaskResolverMixin |
Flytekit tasks interact with the Flyte platform very, very broadly in two steps |
flytekit.core.task.TypeVar |
Type variable |
flytekit.core.task.VersionParameters |
Parameters used for version hash generation |
flytekit.core.task.partial |
partial(func, *args, **keywords) - new function with partial application |
flytekit.core.task.vscode |
Abstract class for class decorators |
flytekit.core.testing.MagicMock |
MagicMock is a subclass of Mock with default implementations |
flytekit.core.testing.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.core.testing.ReferenceEntity |
None |
flytekit.core.testing.WorkflowBase |
None |
flytekit.core.tracked_abc.ABC |
Helper class that provides a standard way to create an ABC using |
flytekit.core.tracked_abc.FlyteTrackedABC |
This class exists because if you try to inherit from abc |
flytekit.core.tracked_abc.TrackedInstance |
Please see the notes for the metaclass above first |
flytekit.core.tracker.FeatureFlags |
None |
flytekit.core.tracker.InstanceTrackingMeta |
Please see the original class :py:class`flytekit |
flytekit.core.tracker.ModuleType |
Create a module object |
flytekit.core.tracker.Path |
PurePath subclass that can make system calls |
flytekit.core.tracker.TrackedInstance |
Please see the notes for the metaclass above first |
flytekit.core.type_engine.ABC |
Helper class that provides a standard way to create an ABC using |
flytekit.core.type_engine.Annotated |
Add context-specific metadata to a type |
flytekit.core.type_engine.Any |
Special type indicating an unconstrained type |
flytekit.core.type_engine.AsyncTypeTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.core.type_engine.BatchSize |
This is used to annotate a FlyteDirectory when we want to download/upload the contents of the directory in batches |
flytekit.core.type_engine.Binary |
None |
flytekit.core.type_engine.BinaryIOTransformer |
Handler for BinaryIO |
flytekit.core.type_engine.DataClassJSONMixin |
None |
flytekit.core.type_engine.DataClassJsonMixin |
DataClassJsonMixin is an ABC that functions as a Mixin |
flytekit.core.type_engine.DataclassTransformer |
The Dataclass Transformer provides a type transformer for dataclasses |
flytekit.core.type_engine.DictTransformer |
Transformer that transforms an univariate dictionary Dict[str, T] to a Literal Map or |
flytekit.core.type_engine.EnumTransformer |
Enables converting a python type enum |
flytekit.core.type_engine.FlyteAnnotation |
A core object to add arbitrary annotations to flyte types |
flytekit.core.type_engine.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.type_engine.GenericAlias |
Represent a PEP 585 generic type |
flytekit.core.type_engine.HashMethod |
Flyte-specific object used to wrap the hash function for a specific type |
flytekit.core.type_engine.JSONDecoder |
Abstract base class for generic types |
flytekit.core.type_engine.JSONEncoder |
Abstract base class for generic types |
flytekit.core.type_engine.ListTransformer |
Transformer that handles a univariate typing |
flytekit.core.type_engine.Literal |
None |
flytekit.core.type_engine.LiteralCollection |
None |
flytekit.core.type_engine.LiteralMap |
None |
flytekit.core.type_engine.LiteralType |
None |
flytekit.core.type_engine.LiteralsResolver |
LiteralsResolver is a helper class meant primarily for use with the FlyteRemote experience or any other situation |
flytekit.core.type_engine.Message |
Abstract base class for protocol messages |
flytekit.core.type_engine.MessagePackDecoder |
Abstract base class for generic types |
flytekit.core.type_engine.MessagePackEncoder |
Abstract base class for generic types |
flytekit.core.type_engine.OrderedDict |
Dictionary that remembers insertion order |
flytekit.core.type_engine.Primitive |
None |
flytekit.core.type_engine.ProtobufTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.core.type_engine.RestrictedTypeError |
Common base class for all non-exit exceptions |
flytekit.core.type_engine.RestrictedTypeTransformer |
Types registered with the RestrictedTypeTransformer are not allowed to be converted to and from literals |
flytekit.core.type_engine.Scalar |
None |
flytekit.core.type_engine.SimpleTransformer |
A Simple implementation of a type transformer that uses simple lambdas to transform and reduces boilerplate |
flytekit.core.type_engine.SimpleType |
None |
flytekit.core.type_engine.Struct |
A ProtocolMessage |
flytekit.core.type_engine.TextIOTransformer |
Handler for TextIO |
flytekit.core.type_engine.TypeAnnotationModel |
Python class representation of the flyteidl TypeAnnotation message |
flytekit.core.type_engine.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.core.type_engine.TypeStructure |
Models _types_pb2 |
flytekit.core.type_engine.TypeTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.core.type_engine.TypeTransformerFailedError |
Inappropriate argument type |
flytekit.core.type_engine.Union |
None |
flytekit.core.type_engine.UnionTransformer |
Transformer that handles a typing |
flytekit.core.type_engine.UnionType |
Models _types_pb2 |
flytekit.core.type_engine.Void |
None |
flytekit.core.type_engine.timeit |
A context manager and a decorator that measures the execution time of the wrapped code block or functions |
flytekit.core.type_match_checking.EnumType |
Models _types_pb2 |
flytekit.core.type_match_checking.LiteralType |
None |
flytekit.core.type_match_checking.UnionType |
Models _types_pb2 |
flytekit.core.utils.ABC |
Helper class that provides a standard way to create an ABC using |
flytekit.core.utils.Any |
Special type indicating an unconstrained type |
flytekit.core.utils.AutoDeletingTempDir |
Creates a posix safe tempdir which is auto deleted once out of scope |
flytekit.core.utils.ClassDecorator |
Abstract class for class decorators |
flytekit.core.utils.Directory |
None |
flytekit.core.utils.Path |
PurePath subclass that can make system calls |
flytekit.core.utils.PodTemplate |
Custom PodTemplate specification for a Task |
flytekit.core.utils.ResourceSpec |
None |
flytekit.core.utils.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.core.utils.timeit |
A context manager and a decorator that measures the execution time of the wrapped code block or functions |
flytekit.core.worker_queue.Controller |
This controller object is responsible for kicking off and monitoring executions against a Flyte Admin endpoint |
flytekit.core.worker_queue.Deck |
Deck enable users to get customizable and default visibility into their tasks |
flytekit.core.worker_queue.Enum |
Create a collection of name/value pairs |
flytekit.core.worker_queue.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.worker_queue.FlyteSystemException |
Common base class for all non-exit exceptions |
flytekit.core.worker_queue.ImageConfig |
We recommend you to use ImageConfig |
flytekit.core.worker_queue.ItemStatus |
Create a collection of name/value pairs |
flytekit.core.worker_queue.Labels |
None |
flytekit.core.worker_queue.LaunchPlan |
Launch Plans are one of the core constructs of Flyte |
flytekit.core.worker_queue.Options |
These are options that can be configured for a launchplan during registration or overridden during an execution |
flytekit.core.worker_queue.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.core.worker_queue.RateLimiter |
Rate limiter that allows up to a certain number of requests per minute |
flytekit.core.worker_queue.ReferenceEntity |
None |
flytekit.core.worker_queue.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.core.worker_queue.Update |
None |
flytekit.core.worker_queue.WorkItem |
This is a class to keep track of what the user requested |
flytekit.core.worker_queue.WorkflowBase |
None |
flytekit.core.worker_queue.WorkflowExecutionPhase |
This class holds enum values used for setting notifications |
flytekit.core.workflow.Any |
Special type indicating an unconstrained type |
flytekit.core.workflow.ClassStorageTaskResolver |
Stores tasks inside a class variable |
flytekit.core.workflow.CompilationState |
Compilation state is used during the compilation of a workflow or task |
flytekit.core.workflow.ConditionalSection |
ConditionalSection is used to denote a condition within a Workflow |
flytekit.core.workflow.Description |
Full user description with formatting preserved |
flytekit.core.workflow.Docstring |
None |
flytekit.core.workflow.Documentation |
DescriptionEntity contains detailed description for the task/workflow/launch plan |
flytekit.core.workflow.Enum |
Create a collection of name/value pairs |
flytekit.core.workflow.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.core.workflow.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.core.workflow.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.core.workflow.FlyteEntities |
This is a global Object that tracks various tasks and workflows that are declared within a VM during the |
flytekit.core.workflow.FlyteError |
Special Task type that will be used in the failure node |
flytekit.core.workflow.FlyteFailureNodeInputMismatchException |
Assertion failed |
flytekit.core.workflow.FlyteValidationException |
Assertion failed |
flytekit.core.workflow.FlyteValueException |
Inappropriate argument value (of correct type) |
flytekit.core.workflow.ImperativeWorkflow |
An imperative workflow is a programmatic analogue to the typical @workflow function-based workflow and is |
flytekit.core.workflow.Interface |
A Python native interface object, like inspect |
flytekit.core.workflow.Node |
This class will hold all the things necessary to make an SdkNode but we won’t make one until we know things like |
flytekit.core.workflow.NodeOutput |
None |
flytekit.core.workflow.Options |
These are options that can be configured for a launchplan during registration or overridden during an execution |
flytekit.core.workflow.ParamSpec |
Parameter specification |
flytekit.core.workflow.Promise |
This object is a wrapper and exists for three main reasons |
flytekit.core.workflow.PythonAutoContainerTask |
A Python AutoContainer task should be used as the base for all extensions that want the user’s code to be in the |
flytekit.core.workflow.PythonFunctionWorkflow |
Please read :std:ref:flyte:divedeep-workflows first for a high-level understanding of what workflows are in Flyte |
flytekit.core.workflow.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.core.workflow.ReferenceEntity |
None |
flytekit.core.workflow.ReferenceWorkflow |
A reference workflow is a pointer to a workflow that already exists on your Flyte installation |
flytekit.core.workflow.Task |
The base of all Tasks in flytekit |
flytekit.core.workflow.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.core.workflow.VoidPromise |
This object is returned for tasks that do not return any outputs (declared interface is empty) |
flytekit.core.workflow.WorkflowBase |
None |
flytekit.core.workflow.WorkflowFailurePolicy |
Defines the behavior for a workflow execution in the case of an observed node execution failure |
flytekit.core.workflow.WorkflowMetadata |
None |
flytekit.core.workflow.WorkflowMetadataDefaults |
This class is similarly named to the one above |
flytekit.core.workflow.WorkflowReference |
A reference object containing metadata that points to a remote workflow |
flytekit.deck.Deck |
Deck enable users to get customizable and default visibility into their tasks |
flytekit.deck.DeckField |
DeckField is used to specify the fields that will be rendered in the deck |
flytekit.deck.MarkdownRenderer |
Convert a markdown string to HTML and return HTML as a unicode string |
flytekit.deck.SourceCodeRenderer |
Convert Python source code to HTML, and return HTML as a unicode string |
flytekit.deck.TopFrameRenderer |
Render a DataFrame as an HTML table |
flytekit.deck.deck.Deck |
Deck enable users to get customizable and default visibility into their tasks |
flytekit.deck.deck.DeckField |
DeckField is used to specify the fields that will be rendered in the deck |
flytekit.deck.deck.ExecutionParameters |
This is a run-time user-centric context object that is accessible to every @task method |
flytekit.deck.deck.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.deck.deck.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.deck.deck.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.deck.deck.Template |
A string class for supporting $-substitutions |
flytekit.deck.deck.TimeLineDeck |
The TimeLineDeck class is designed to render the execution time of each part of a task |
flytekit.deck.renderer.Any |
Special type indicating an unconstrained type |
flytekit.deck.renderer.ArrowRenderer |
Render an Arrow dataframe as an HTML table |
flytekit.deck.renderer.MarkdownRenderer |
Convert a markdown string to HTML and return HTML as a unicode string |
flytekit.deck.renderer.Protocol |
Base class for protocol classes |
flytekit.deck.renderer.PythonDependencyRenderer |
PythonDependencyDeck is a deck that contains information about packages installed via pip |
flytekit.deck.renderer.Renderable |
Base class for protocol classes |
flytekit.deck.renderer.SourceCodeRenderer |
Convert Python source code to HTML, and return HTML as a unicode string |
flytekit.deck.renderer.TopFrameRenderer |
Render a DataFrame as an HTML table |
flytekit.exceptions.base.FlyteException |
Common base class for all non-exit exceptions |
flytekit.exceptions.base.FlyteRecoverableException |
Common base class for all non-exit exceptions |
flytekit.exceptions.eager.EagerException |
Raised when a node in an eager workflow encounters an error |
flytekit.exceptions.scopes.FlyteScopedException |
Common base class for all non-exit exceptions |
flytekit.exceptions.scopes.FlyteScopedSystemException |
Common base class for all non-exit exceptions |
flytekit.exceptions.scopes.FlyteScopedUserException |
Common base class for all non-exit exceptions |
flytekit.exceptions.system.FlyteAgentNotFound |
Assertion failed |
flytekit.exceptions.system.FlyteDownloadDataException |
Common base class for all non-exit exceptions |
flytekit.exceptions.system.FlyteEntrypointNotLoadable |
Common base class for all non-exit exceptions |
flytekit.exceptions.system.FlyteException |
Common base class for all non-exit exceptions |
flytekit.exceptions.system.FlyteNonRecoverableSystemException |
Common base class for all non-exit exceptions |
flytekit.exceptions.system.FlyteNotImplementedException |
Method or function hasn’t been implemented yet |
flytekit.exceptions.system.FlyteSystemAssertion |
Assertion failed |
flytekit.exceptions.system.FlyteSystemException |
Common base class for all non-exit exceptions |
flytekit.exceptions.system.FlyteSystemUnavailableException |
Common base class for all non-exit exceptions |
flytekit.exceptions.system.FlyteUploadDataException |
Common base class for all non-exit exceptions |
flytekit.exceptions.user.FlyteAssertion |
Assertion failed |
flytekit.exceptions.user.FlyteAuthenticationException |
Assertion failed |
flytekit.exceptions.user.FlyteCompilationException |
Common base class for all non-exit exceptions |
flytekit.exceptions.user.FlyteDataNotFoundException |
Inappropriate argument value (of correct type) |
flytekit.exceptions.user.FlyteDisapprovalException |
Assertion failed |
flytekit.exceptions.user.FlyteEntityAlreadyExistsException |
Assertion failed |
flytekit.exceptions.user.FlyteEntityNotExistException |
Assertion failed |
flytekit.exceptions.user.FlyteEntityNotFoundException |
Inappropriate argument value (of correct type) |
flytekit.exceptions.user.FlyteFailureNodeInputMismatchException |
Assertion failed |
flytekit.exceptions.user.FlyteInvalidInputException |
Common base class for all non-exit exceptions |
flytekit.exceptions.user.FlyteMissingReturnValueException |
Common base class for all non-exit exceptions |
flytekit.exceptions.user.FlyteMissingTypeException |
Common base class for all non-exit exceptions |
flytekit.exceptions.user.FlytePromiseAttributeResolveException |
Assertion failed |
flytekit.exceptions.user.FlyteRecoverableException |
Common base class for all non-exit exceptions |
flytekit.exceptions.user.FlyteTimeout |
Assertion failed |
flytekit.exceptions.user.FlyteTypeException |
Inappropriate argument type |
flytekit.exceptions.user.FlyteUserException |
Common base class for all non-exit exceptions |
flytekit.exceptions.user.FlyteUserRuntimeException |
Common base class for all non-exit exceptions |
flytekit.exceptions.user.FlyteValidationException |
Assertion failed |
flytekit.exceptions.user.FlyteValueException |
Inappropriate argument value (of correct type) |
flytekit.exceptions.utils.FlyteUserException |
Common base class for all non-exit exceptions |
flytekit.experimental.eager_function.DataConfig |
Any data storage specific configuration |
flytekit.experimental.eager_function.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.experimental.eager_function.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.experimental.eager_function.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.experimental.eager_function.FlyteRemote |
Main entrypoint for programmatically accessing a Flyte remote backend |
flytekit.experimental.eager_function.PlatformConfig |
This object contains the settings to talk to a Flyte backend (the DNS location of your Admin server basically) |
flytekit.experimental.eager_function.S3Config |
S3 specific configuration |
flytekit.extend.ClassStorageTaskResolver |
Stores tasks inside a class variable |
flytekit.extend.DictTransformer |
Transformer that transforms an univariate dictionary Dict[str, T] to a Literal Map or |
flytekit.extend.ExecutableTemplateShimTask |
The canonical @task decorated Python function task is pretty simple to reason about |
flytekit.extend.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.extend.FileAccessProvider |
This is the class that is available through the FlyteContext and can be used for persisting data to the remote |
flytekit.extend.IgnoreOutputs |
This exception should be used to indicate that the outputs generated by this can be safely ignored |
flytekit.extend.Image |
Image is a structured wrapper for task container images used in object serialization |
flytekit.extend.ImageConfig |
We recommend you to use ImageConfig |
flytekit.extend.Interface |
A Python native interface object, like inspect |
flytekit.extend.Promise |
This object is a wrapper and exists for three main reasons |
flytekit.extend.PythonCustomizedContainerTask |
Please take a look at the comments for :py:class`flytekit |
flytekit.extend.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.extend.SQLTask |
Base task types for all SQL tasks |
flytekit.extend.SecretsManager |
This provides a secrets resolution logic at runtime |
flytekit.extend.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.extend.ShimTaskExecutor |
Please see the notes for the metaclass above first |
flytekit.extend.TaskPlugins |
This is the TaskPlugins factory for task types that are derivative of PythonFunctionTask |
flytekit.extend.TaskResolverMixin |
Flytekit tasks interact with the Flyte platform very, very broadly in two steps |
flytekit.extend.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.extend.TypeTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.extend.backend.base_agent.ABC |
Helper class that provides a standard way to create an ABC using |
flytekit.extend.backend.base_agent.Agent |
A ProtocolMessage |
flytekit.extend.backend.base_agent.AgentBase |
Helper class that provides a standard way to create an ABC using |
flytekit.extend.backend.base_agent.AgentRegistry |
This is the registry for all agents |
flytekit.extend.backend.base_agent.Any |
Special type indicating an unconstrained type |
flytekit.extend.backend.base_agent.AsyncAgentBase |
This is the base class for all async agents |
flytekit.extend.backend.base_agent.AsyncAgentExecutorMixin |
This mixin class is used to run the async task locally, and it’s only used for local execution |
flytekit.extend.backend.base_agent.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.extend.backend.base_agent.FlyteAgentNotFound |
Assertion failed |
flytekit.extend.backend.base_agent.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.extend.backend.base_agent.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.extend.backend.base_agent.FlyteUserException |
Common base class for all non-exit exceptions |
flytekit.extend.backend.base_agent.FrameType |
None |
flytekit.extend.backend.base_agent.ImageConfig |
We recommend you to use ImageConfig |
flytekit.extend.backend.base_agent.LiteralMap |
None |
flytekit.extend.backend.base_agent.OrderedDict |
Dictionary that remembers insertion order |
flytekit.extend.backend.base_agent.Progress |
Renders an auto-updating progress bar(s) |
flytekit.extend.backend.base_agent.PythonFunctionTask |
A Python Function task should be used as the base for all extensions that have a python function |
flytekit.extend.backend.base_agent.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.extend.backend.base_agent.Resource |
This is the output resource of the job |
flytekit.extend.backend.base_agent.ResourceMeta |
This is the metadata for the job |
flytekit.extend.backend.base_agent.RichHandler |
A logging handler that renders output with Rich |
flytekit.extend.backend.base_agent.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.extend.backend.base_agent.Struct |
A ProtocolMessage |
flytekit.extend.backend.base_agent.SyncAgentBase |
This is the base class for all sync agents |
flytekit.extend.backend.base_agent.SyncAgentExecutorMixin |
This mixin class is used to run the sync task locally, and it’s only used for local execution |
flytekit.extend.backend.base_agent.TaskCategory |
None |
flytekit.extend.backend.base_agent.TaskExecution |
A ProtocolMessage |
flytekit.extend.backend.base_agent.TaskExecutionMetadata |
None |
flytekit.extend.backend.base_agent.TaskLog |
A ProtocolMessage |
flytekit.extend.backend.base_agent.TaskTemplate |
None |
flytekit.extend.backend.base_agent.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.extend.backend.base_agent.partial |
partial(func, *args, **keywords) - new function with partial application |
flytekit.extend.backend.utils.TaskExecution |
A ProtocolMessage |
flytekit.extend.backend.utils.TaskTemplate |
None |
flytekit.extras.accelerators.BaseAccelerator |
Base class for all accelerator types |
flytekit.extras.accelerators.GPUAccelerator |
Class that represents a GPU accelerator |
flytekit.extras.accelerators.Generic |
Abstract base class for generic types |
flytekit.extras.accelerators.MultiInstanceGPUAccelerator |
Base class for all multi-instance GPU accelerator types |
flytekit.extras.accelerators.TypeVar |
Type variable |
flytekit.extras.cloud_pickle_resolver.ExperimentalNaiveCloudPickleResolver |
Please do not use this resolver, basically ever |
flytekit.extras.cloud_pickle_resolver.PythonAutoContainerTask |
A Python AutoContainer task should be used as the base for all extensions that want the user’s code to be in the |
flytekit.extras.cloud_pickle_resolver.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.extras.cloud_pickle_resolver.TaskResolverMixin |
Flytekit tasks interact with the Flyte platform very, very broadly in two steps |
flytekit.extras.cloud_pickle_resolver.TrackedInstance |
Please see the notes for the metaclass above first |
flytekit.extras.pydantic_transformer.decorator.Any |
Special type indicating an unconstrained type |
flytekit.extras.pydantic_transformer.decorator.TypeVar |
Type variable |
flytekit.extras.sqlite3.task.DefaultImages |
We may want to load the default images from remote - maybe s3 location etc? |
flytekit.extras.sqlite3.task.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.extras.sqlite3.task.PythonCustomizedContainerTask |
Please take a look at the comments for :py:class`flytekit |
flytekit.extras.sqlite3.task.SQLTask |
Base task types for all SQL tasks |
flytekit.extras.sqlite3.task.SQLite3Config |
Use this configuration to configure if sqlite3 files that should be loaded by the task |
flytekit.extras.sqlite3.task.SQLite3Task |
Run client side SQLite3 queries that optionally return a FlyteSchema object |
flytekit.extras.sqlite3.task.SQLite3TaskExecutor |
Please see the notes for the metaclass above first |
flytekit.extras.sqlite3.task.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.extras.sqlite3.task.ShimTaskExecutor |
Please see the notes for the metaclass above first |
flytekit.extras.tasks.shell.AttrDict |
Convert a dictionary to an attribute style lookup |
flytekit.extras.tasks.shell.ExecutionParameters |
This is a run-time user-centric context object that is accessible to every @task method |
flytekit.extras.tasks.shell.FlyteDirectory |
None |
flytekit.extras.tasks.shell.FlyteFile |
None |
flytekit.extras.tasks.shell.FlyteRecoverableException |
Common base class for all non-exit exceptions |
flytekit.extras.tasks.shell.Interface |
A Python native interface object, like inspect |
flytekit.extras.tasks.shell.OutputLocation |
|
flytekit.extras.tasks.shell.ProcessResult |
Stores a process return code, standard output and standard error |
flytekit.extras.tasks.shell.PythonInstanceTask |
This class should be used as the base class for all Tasks that do not have a user defined function body, but have |
flytekit.extras.tasks.shell.RawShellTask |
None |
flytekit.extras.tasks.shell.ShellTask |
None |
flytekit.extras.tasks.shell.TaskPlugins |
This is the TaskPlugins factory for task types that are derivative of PythonFunctionTask |
flytekit.image_spec.DefaultImageBuilder |
Image builder using Docker and buildkit |
flytekit.image_spec.ImageBuildEngine |
ImageBuildEngine contains a list of builders that can be used to build an ImageSpec |
flytekit.image_spec.ImageSpec |
This class is used to specify the docker image that will be used to run the task |
flytekit.image_spec.default_builder.CopyFileDetection |
Create a collection of name/value pairs |
flytekit.image_spec.default_builder.DefaultImageBuilder |
Image builder using Docker and buildkit |
flytekit.image_spec.default_builder.DockerIgnore |
Uses docker-py’s PatternMatcher to check whether a path is ignored |
flytekit.image_spec.default_builder.GitIgnore |
Uses git cli (if available) to list all ignored files and compare with those |
flytekit.image_spec.default_builder.IgnoreGroup |
Groups multiple Ignores and checks a path against them |
flytekit.image_spec.default_builder.ImageSpec |
This class is used to specify the docker image that will be used to run the task |
flytekit.image_spec.default_builder.ImageSpecBuilder |
None |
flytekit.image_spec.default_builder.Path |
PurePath subclass that can make system calls |
flytekit.image_spec.default_builder.StandardIgnore |
Retains the standard ignore functionality that previously existed |
flytekit.image_spec.default_builder.Template |
A string class for supporting $-substitutions |
flytekit.image_spec.image_spec.CopyFileDetection |
Create a collection of name/value pairs |
flytekit.image_spec.image_spec.FlyteAssertion |
Assertion failed |
flytekit.image_spec.image_spec.ImageBuildEngine |
ImageBuildEngine contains a list of builders that can be used to build an ImageSpec |
flytekit.image_spec.image_spec.ImageSpec |
This class is used to specify the docker image that will be used to run the task |
flytekit.image_spec.image_spec.ImageSpecBuilder |
None |
flytekit.image_spec.image_spec.Version |
This class abstracts handling of a project’s versions |
flytekit.image_spec.image_spec.cached_property |
None |
flytekit.interaction.click_types.ArtifactQuery |
None |
flytekit.interaction.click_types.BlobType |
This type represents offloaded data and is typically used for things like files |
flytekit.interaction.click_types.DataClassJsonMixin |
DataClassJsonMixin is an ABC that functions as a Mixin |
flytekit.interaction.click_types.DateTimeType |
The DateTime type converts date strings into datetime objects |
flytekit.interaction.click_types.DirParamType |
Represents the type of a parameter |
flytekit.interaction.click_types.DurationParamType |
Represents the type of a parameter |
flytekit.interaction.click_types.EnumParamType |
The choice type allows a value to be checked against a fixed set |
flytekit.interaction.click_types.FileAccessProvider |
This is the class that is available through the FlyteContext and can be used for persisting data to the remote |
flytekit.interaction.click_types.FileParamType |
Represents the type of a parameter |
flytekit.interaction.click_types.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.interaction.click_types.FlyteDirectory |
None |
flytekit.interaction.click_types.FlyteFile |
None |
flytekit.interaction.click_types.FlyteLiteralConverter |
None |
flytekit.interaction.click_types.FlytePathResolver |
None |
flytekit.interaction.click_types.FlytePickleTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.interaction.click_types.FlyteSchema |
None |
flytekit.interaction.click_types.JSONIteratorParamType |
Represents the type of a parameter |
flytekit.interaction.click_types.JSONIteratorTransformer |
A JSON iterator that handles conversion between an iterator/generator and a JSONL file |
flytekit.interaction.click_types.JsonParamType |
Represents the type of a parameter |
flytekit.interaction.click_types.Literal |
None |
flytekit.interaction.click_types.LiteralType |
None |
flytekit.interaction.click_types.PickleParamType |
Represents the type of a parameter |
flytekit.interaction.click_types.SimpleType |
None |
flytekit.interaction.click_types.StructuredDataset |
This is the user facing StructuredDataset class |
flytekit.interaction.click_types.StructuredDatasetParamType |
TODO handle column types |
flytekit.interaction.click_types.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.interaction.click_types.UnionParamType |
A composite type that allows for multiple types to be specified |
flytekit.interaction.parse_stdin.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.interaction.parse_stdin.Literal |
None |
flytekit.interaction.parse_stdin.LiteralType |
None |
flytekit.interaction.parse_stdin.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.interaction.rich_utils.Callback |
Base class and interface for callback mechanism |
flytekit.interaction.rich_utils.Progress |
Renders an auto-updating progress bar(s) |
flytekit.interaction.rich_utils.RichCallback |
Base class and interface for callback mechanism |
flytekit.interaction.string_literals.Literal |
None |
flytekit.interaction.string_literals.LiteralMap |
None |
flytekit.interaction.string_literals.Primitive |
None |
flytekit.interaction.string_literals.Scalar |
None |
flytekit.interactive.VscodeConfig |
VscodeConfig is the config contains default URLs of the VSCode server and extension remote paths |
flytekit.interactive.vscode |
Abstract class for class decorators |
flytekit.interactive.utils.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.interactive.utils.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.interactive.vscode_lib.config.VscodeConfig |
VscodeConfig is the config contains default URLs of the VSCode server and extension remote paths |
flytekit.interactive.vscode_lib.decorator.ClassDecorator |
Abstract class for class decorators |
flytekit.interactive.vscode_lib.decorator.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.interactive.vscode_lib.decorator.VscodeConfig |
VscodeConfig is the config contains default URLs of the VSCode server and extension remote paths |
flytekit.interactive.vscode_lib.decorator.vscode |
Abstract class for class decorators |
flytekit.interactive.vscode_lib.vscode_constants.Path |
PurePath subclass that can make system calls |
flytekit.interfaces.cli_identifiers.Identifier |
None |
flytekit.interfaces.cli_identifiers.TaskExecutionIdentifier |
None |
flytekit.interfaces.cli_identifiers.WorkflowExecutionIdentifier |
None |
flytekit.interfaces.stats.client.DummyStatsClient |
A dummy client for statsd |
flytekit.interfaces.stats.client.ScopeableStatsProxy |
A Proxy object for an underlying statsd client |
flytekit.interfaces.stats.client.StatsClientProxy |
A Proxy object for an underlying statsd client |
flytekit.interfaces.stats.client.StatsConfig |
Configuration for sending statsd |
flytekit.interfaces.stats.taggable.StatsConfig |
Configuration for sending statsd |
flytekit.interfaces.stats.taggable.TaggableStats |
A Proxy object for an underlying statsd client |
flytekit.models.admin.common.Sort |
None |
flytekit.models.admin.task_execution.TaskExecution |
None |
flytekit.models.admin.task_execution.TaskExecutionClosure |
None |
flytekit.models.admin.workflow.Documentation |
DescriptionEntity contains detailed description for the task/workflow/launch plan |
flytekit.models.admin.workflow.Workflow |
None |
flytekit.models.admin.workflow.WorkflowClosure |
None |
flytekit.models.admin.workflow.WorkflowSpec |
None |
flytekit.models.annotation.Any |
Special type indicating an unconstrained type |
flytekit.models.annotation.TypeAnnotation |
Python class representation of the flyteidl TypeAnnotation message |
flytekit.models.array_job.ArrayJob |
None |
flytekit.models.common.Annotations |
None |
flytekit.models.common.AuthRole |
None |
flytekit.models.common.EmailNotification |
None |
flytekit.models.common.Envs |
None |
flytekit.models.common.FlyteABCMeta |
Metaclass for defining Abstract Base Classes (ABCs) |
flytekit.models.common.FlyteCustomIdlEntity |
None |
flytekit.models.common.FlyteIdlEntity |
None |
flytekit.models.common.FlyteType |
Metaclass for defining Abstract Base Classes (ABCs) |
flytekit.models.common.Labels |
None |
flytekit.models.common.NamedEntityIdentifier |
None |
flytekit.models.common.Notification |
None |
flytekit.models.common.PagerDutyNotification |
None |
flytekit.models.common.RawOutputDataConfig |
None |
flytekit.models.common.SlackNotification |
None |
flytekit.models.common.StringIO |
Text I/O implementation using an in-memory buffer |
flytekit.models.common.UrlBlob |
None |
flytekit.models.core.catalog.CatalogArtifactTag |
None |
flytekit.models.core.catalog.CatalogMetadata |
None |
flytekit.models.core.compiler.CompiledTask |
None |
flytekit.models.core.compiler.CompiledWorkflow |
None |
flytekit.models.core.compiler.CompiledWorkflowClosure |
None |
flytekit.models.core.compiler.ConnectionSet |
None |
flytekit.models.core.condition.BooleanExpression |
None |
flytekit.models.core.condition.ComparisonExpression |
None |
flytekit.models.core.condition.ConjunctionExpression |
None |
flytekit.models.core.condition.Operand |
None |
flytekit.models.core.errors.ContainerError |
None |
flytekit.models.core.errors.ErrorDocument |
None |
flytekit.models.core.errors.Timestamp |
A ProtocolMessage |
flytekit.models.core.execution.ExecutionError |
None |
flytekit.models.core.execution.NodeExecutionPhase |
None |
flytekit.models.core.execution.TaskExecutionPhase |
None |
flytekit.models.core.execution.TaskLog |
None |
flytekit.models.core.execution.WorkflowExecutionPhase |
This class holds enum values used for setting notifications |
flytekit.models.core.identifier.Identifier |
None |
flytekit.models.core.identifier.NodeExecutionIdentifier |
None |
flytekit.models.core.identifier.ResourceType |
None |
flytekit.models.core.identifier.SignalIdentifier |
None |
flytekit.models.core.identifier.TaskExecutionIdentifier |
None |
flytekit.models.core.identifier.WorkflowExecutionIdentifier |
None |
flytekit.models.core.types.BlobType |
This type represents offloaded data and is typically used for things like files |
flytekit.models.core.types.EnumType |
Models _types_pb2 |
flytekit.models.core.workflow.Alias |
None |
flytekit.models.core.workflow.ApproveCondition |
None |
flytekit.models.core.workflow.ArrayNode |
None |
flytekit.models.core.workflow.BoolValue |
A ProtocolMessage |
flytekit.models.core.workflow.BranchNode |
None |
flytekit.models.core.workflow.GateNode |
None |
flytekit.models.core.workflow.IfBlock |
None |
flytekit.models.core.workflow.IfElseBlock |
None |
flytekit.models.core.workflow.K8sObjectMetadata |
None |
flytekit.models.core.workflow.Node |
None |
flytekit.models.core.workflow.NodeMetadata |
None |
flytekit.models.core.workflow.PodTemplate |
Custom PodTemplate specification for a Task |
flytekit.models.core.workflow.Resources |
None |
flytekit.models.core.workflow.SignalCondition |
None |
flytekit.models.core.workflow.SleepCondition |
None |
flytekit.models.core.workflow.TaskNode |
None |
flytekit.models.core.workflow.TaskNodeOverrides |
None |
flytekit.models.core.workflow.WorkflowMetadata |
None |
flytekit.models.core.workflow.WorkflowMetadataDefaults |
None |
flytekit.models.core.workflow.WorkflowNode |
None |
flytekit.models.core.workflow.WorkflowTemplate |
None |
flytekit.models.documentation.Description |
Full user description with formatting preserved |
flytekit.models.documentation.Documentation |
DescriptionEntity contains detailed description for the task/workflow/launch plan |
flytekit.models.documentation.Enum |
Create a collection of name/value pairs |
flytekit.models.documentation.SourceCode |
Link to source code used to define this task or workflow |
flytekit.models.domain.Domain |
Domains are fixed and unique at the global level, and provide an abstraction to isolate resources and feature configuration for different deployment environments |
flytekit.models.dynamic_job.DynamicJobSpec |
None |
flytekit.models.event.TaskExecutionMetadata |
|
flytekit.models.execution.AbortMetadata |
None |
flytekit.models.execution.BoolValue |
A ProtocolMessage |
flytekit.models.execution.ClusterAssignment |
None |
flytekit.models.execution.DynamicWorkflowNodeMetadata |
None |
flytekit.models.execution.Execution |
None |
flytekit.models.execution.ExecutionClosure |
None |
flytekit.models.execution.ExecutionClusterLabel |
None |
flytekit.models.execution.ExecutionMetadata |
None |
flytekit.models.execution.ExecutionSpec |
None |
flytekit.models.execution.LiteralMapBlob |
None |
flytekit.models.execution.NodeExecutionGetDataResponse |
Currently, node, task, and workflow execution all have the same get data response |
flytekit.models.execution.NotificationList |
None |
flytekit.models.execution.SystemMetadata |
None |
flytekit.models.execution.TaskExecutionGetDataResponse |
Currently, node, task, and workflow execution all have the same get data response |
flytekit.models.execution.WorkflowExecutionGetDataResponse |
Currently, node, task, and workflow execution all have the same get data response |
flytekit.models.filters.Contains |
None |
flytekit.models.filters.Equal |
None |
flytekit.models.filters.Filter |
None |
flytekit.models.filters.FilterList |
None |
flytekit.models.filters.GreaterThan |
None |
flytekit.models.filters.GreaterThanOrEqual |
None |
flytekit.models.filters.LessThan |
None |
flytekit.models.filters.LessThanOrEqual |
None |
flytekit.models.filters.NotEqual |
None |
flytekit.models.filters.SetFilter |
None |
flytekit.models.filters.ValueIn |
None |
flytekit.models.filters.ValueNotIn |
None |
flytekit.models.interface.Parameter |
None |
flytekit.models.interface.ParameterMap |
None |
flytekit.models.interface.TypedInterface |
None |
flytekit.models.interface.Variable |
None |
flytekit.models.interface.VariableMap |
None |
flytekit.models.launch_plan.Any |
A ProtocolMessage |
flytekit.models.launch_plan.Auth |
None |
flytekit.models.launch_plan.LaunchPlan |
None |
flytekit.models.launch_plan.LaunchPlanClosure |
None |
flytekit.models.launch_plan.LaunchPlanMetadata |
None |
flytekit.models.launch_plan.LaunchPlanSpec |
None |
flytekit.models.launch_plan.LaunchPlanState |
None |
flytekit.models.literals.Binary |
None |
flytekit.models.literals.Binding |
None |
flytekit.models.literals.BindingData |
None |
flytekit.models.literals.BindingDataCollection |
None |
flytekit.models.literals.BindingDataMap |
None |
flytekit.models.literals.Blob |
None |
flytekit.models.literals.BlobMetadata |
This is metadata for the Blob literal |
flytekit.models.literals.Error |
None |
flytekit.models.literals.Literal |
None |
flytekit.models.literals.LiteralCollection |
None |
flytekit.models.literals.LiteralMap |
None |
flytekit.models.literals.LiteralOffloadedMetadata |
None |
flytekit.models.literals.LiteralType |
None |
flytekit.models.literals.Primitive |
None |
flytekit.models.literals.RetryStrategy |
None |
flytekit.models.literals.Scalar |
None |
flytekit.models.literals.Schema |
None |
flytekit.models.literals.Struct |
A ProtocolMessage |
flytekit.models.literals.StructuredDataset |
None |
flytekit.models.literals.StructuredDatasetMetadata |
None |
flytekit.models.literals.StructuredDatasetType |
None |
flytekit.models.literals.Union |
None |
flytekit.models.literals.Void |
None |
flytekit.models.matchable_resource.ClusterResourceAttributes |
None |
flytekit.models.matchable_resource.ExecutionClusterLabel |
None |
flytekit.models.matchable_resource.ExecutionQueueAttributes |
None |
flytekit.models.matchable_resource.MatchableResource |
None |
flytekit.models.matchable_resource.MatchingAttributes |
None |
flytekit.models.matchable_resource.PluginOverride |
None |
flytekit.models.matchable_resource.PluginOverrides |
None |
flytekit.models.named_entity.NamedEntityIdentifier |
None |
flytekit.models.named_entity.NamedEntityMetadata |
None |
flytekit.models.named_entity.NamedEntityState |
None |
flytekit.models.node_execution.DynamicWorkflowNodeMetadata |
None |
flytekit.models.node_execution.NodeExecution |
None |
flytekit.models.node_execution.NodeExecutionClosure |
None |
flytekit.models.node_execution.TaskNodeMetadata |
None |
flytekit.models.node_execution.WorkflowNodeMetadata |
None |
flytekit.models.presto.PrestoQuery |
None |
flytekit.models.project.Project |
None |
flytekit.models.qubole.HiveQuery |
None |
flytekit.models.qubole.HiveQueryCollection |
None |
flytekit.models.qubole.QuboleHiveJob |
None |
flytekit.models.schedule.Schedule |
None |
flytekit.models.security.Enum |
Create a collection of name/value pairs |
flytekit.models.security.Identity |
None |
flytekit.models.security.OAuth2Client |
None |
flytekit.models.security.OAuth2TokenRequest |
None |
flytekit.models.security.Secret |
See :std:ref:cookbook:secrets for usage examples |
flytekit.models.security.SecurityContext |
This is a higher level wrapper object that for the most part users shouldn’t have to worry about |
flytekit.models.task.BoolValue |
A ProtocolMessage |
flytekit.models.task.CompiledTask |
None |
flytekit.models.task.Container |
None |
flytekit.models.task.DataLoadingConfig |
None |
flytekit.models.task.Documentation |
DescriptionEntity contains detailed description for the task/workflow/launch plan |
flytekit.models.task.IOStrategy |
Provides methods to manage data in and out of the Raw container using Download Modes |
flytekit.models.task.K8sObjectMetadata |
None |
flytekit.models.task.K8sPod |
None |
flytekit.models.task.Resources |
None |
flytekit.models.task.RuntimeMetadata |
None |
flytekit.models.task.Sql |
None |
flytekit.models.task.Task |
None |
flytekit.models.task.TaskClosure |
None |
flytekit.models.task.TaskExecutionMetadata |
None |
flytekit.models.task.TaskMetadata |
None |
flytekit.models.task.TaskSpec |
None |
flytekit.models.task.TaskTemplate |
None |
flytekit.models.types.Error |
None |
flytekit.models.types.LiteralType |
None |
flytekit.models.types.OutputReference |
None |
flytekit.models.types.SchemaType |
None |
flytekit.models.types.SimpleType |
None |
flytekit.models.types.StructuredDatasetType |
None |
flytekit.models.types.TypeAnnotationModel |
Python class representation of the flyteidl TypeAnnotation message |
flytekit.models.types.TypeStructure |
Models _types_pb2 |
flytekit.models.types.UnionType |
Models _types_pb2 |
flytekit.models.workflow_closure.WorkflowClosure |
None |
flytekit.remote.FlyteBranchNode |
None |
flytekit.remote.FlyteLaunchPlan |
A class encapsulating a remote Flyte launch plan |
flytekit.remote.FlyteNode |
A class encapsulating a remote Flyte node |
flytekit.remote.FlyteNodeExecution |
A class encapsulating a node execution being run on a Flyte remote backend |
flytekit.remote.FlyteRemote |
Main entrypoint for programmatically accessing a Flyte remote backend |
flytekit.remote.FlyteTask |
A class encapsulating a remote Flyte task |
flytekit.remote.FlyteTaskExecution |
A class encapsulating a task execution being run on a Flyte remote backend |
flytekit.remote.FlyteTaskNode |
A class encapsulating a task that a Flyte node needs to execute |
flytekit.remote.FlyteWorkflow |
A class encapsulating a remote Flyte workflow |
flytekit.remote.FlyteWorkflowExecution |
A class encapsulating a workflow execution being run on a Flyte remote backend |
flytekit.remote.FlyteWorkflowNode |
A class encapsulating a workflow that a Flyte node needs to execute |
flytekit.remote.backfill.FlyteLaunchPlan |
A class encapsulating a remote Flyte launch plan |
flytekit.remote.backfill.ImperativeWorkflow |
An imperative workflow is a programmatic analogue to the typical @workflow function-based workflow and is |
flytekit.remote.backfill.LaunchPlan |
Launch Plans are one of the core constructs of Flyte |
flytekit.remote.backfill.WorkflowBase |
None |
flytekit.remote.backfill.WorkflowFailurePolicy |
Defines the behavior for a workflow execution in the case of an observed node execution failure |
flytekit.remote.backfill.croniter |
None |
flytekit.remote.backfill.datetime |
datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]]) |
flytekit.remote.backfill.timedelta |
Difference between two datetime values |
flytekit.remote.data.BlobType |
This type represents offloaded data and is typically used for things like files |
flytekit.remote.data.FileAccessProvider |
This is the class that is available through the FlyteContext and can be used for persisting data to the remote |
flytekit.remote.data.Literal |
None |
flytekit.remote.data.RichCallback |
Base class and interface for callback mechanism |
flytekit.remote.entities.Binding |
None |
flytekit.remote.entities.FlyteArrayNode |
None |
flytekit.remote.entities.FlyteBranchNode |
None |
flytekit.remote.entities.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.remote.entities.FlyteGateNode |
None |
flytekit.remote.entities.FlyteLaunchPlan |
A class encapsulating a remote Flyte launch plan |
flytekit.remote.entities.FlyteNode |
A class encapsulating a remote Flyte node |
flytekit.remote.entities.FlyteTask |
A class encapsulating a remote Flyte task |
flytekit.remote.entities.FlyteTaskNode |
A class encapsulating a task that a Flyte node needs to execute |
flytekit.remote.entities.FlyteWorkflow |
A class encapsulating a remote Flyte workflow |
flytekit.remote.entities.FlyteWorkflowNode |
A class encapsulating a workflow that a Flyte node needs to execute |
flytekit.remote.entities.Identifier |
None |
flytekit.remote.entities.Node |
None |
flytekit.remote.entities.RemoteEntity |
Helper class that provides a standard way to create an ABC using |
flytekit.remote.entities.TaskSpec |
None |
flytekit.remote.entities.TypedInterface |
None |
flytekit.remote.entities.WorkflowMetadata |
None |
flytekit.remote.entities.WorkflowMetadataDefaults |
None |
flytekit.remote.entities.WorkflowSpec |
None |
flytekit.remote.executions.FlyteNodeExecution |
A class encapsulating a node execution being run on a Flyte remote backend |
flytekit.remote.executions.FlyteTask |
A class encapsulating a remote Flyte task |
flytekit.remote.executions.FlyteTaskExecution |
A class encapsulating a task execution being run on a Flyte remote backend |
flytekit.remote.executions.FlyteWorkflow |
A class encapsulating a remote Flyte workflow |
flytekit.remote.executions.FlyteWorkflowExecution |
A class encapsulating a workflow execution being run on a Flyte remote backend |
flytekit.remote.executions.LiteralsResolver |
LiteralsResolver is a helper class meant primarily for use with the FlyteRemote experience or any other situation |
flytekit.remote.executions.RemoteExecutionBase |
None |
flytekit.remote.executions.TypedInterface |
None |
flytekit.remote.executions.timedelta |
Difference between two datetime values |
flytekit.remote.interface.TypedInterface |
None |
flytekit.remote.lazy_entity.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.remote.lazy_entity.Identifier |
None |
flytekit.remote.lazy_entity.LazyEntity |
Fetches the entity when the entity is called or when the entity is retrieved |
flytekit.remote.lazy_entity.RemoteEntity |
Helper class that provides a standard way to create an ABC using |
flytekit.remote.metrics.FlyteExecutionSpan |
None |
flytekit.remote.metrics.datetime |
datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]]) |
flytekit.remote.remote.ArrayNodeMapTask |
Base Class for all Tasks with a Python native Interface |
flytekit.remote.remote.Artifact |
An Artifact is effectively just a metadata layer on top of data that exists in Flyte |
flytekit.remote.remote.BranchNode |
None |
flytekit.remote.remote.ClusterAssignment |
None |
flytekit.remote.remote.Config |
This the parent configuration object and holds all the underlying configuration object types |
flytekit.remote.remote.ConfigFile |
None |
flytekit.remote.remote.CopyFileDetection |
Create a collection of name/value pairs |
flytekit.remote.remote.CoreNode |
This class will hold all the things necessary to make an SdkNode but we won’t make one until we know things like |
flytekit.remote.remote.DataConfig |
Any data storage specific configuration |
flytekit.remote.remote.Domain |
Domains are fixed and unique at the global level, and provide an abstraction to isolate resources and feature configuration for different deployment environments |
flytekit.remote.remote.ExecutionClusterLabel |
None |
flytekit.remote.remote.ExecutionMetadata |
None |
flytekit.remote.remote.ExecutionSpec |
None |
flytekit.remote.remote.FastPackageOptions |
FastPackageOptions is used to set configuration options when packaging files |
flytekit.remote.remote.FastSerializationSettings |
This object hold information about settings necessary to serialize an object so that it can be fast-registered |
flytekit.remote.remote.FileAccessProvider |
This is the class that is available through the FlyteContext and can be used for persisting data to the remote |
flytekit.remote.remote.FlyteAssertion |
Assertion failed |
flytekit.remote.remote.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.remote.remote.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.remote.remote.FlyteEntityAlreadyExistsException |
Assertion failed |
flytekit.remote.remote.FlyteEntityNotExistException |
Assertion failed |
flytekit.remote.remote.FlyteExecutionSpan |
None |
flytekit.remote.remote.FlyteLaunchPlan |
A class encapsulating a remote Flyte launch plan |
flytekit.remote.remote.FlyteNode |
A class encapsulating a remote Flyte node |
flytekit.remote.remote.FlyteNodeExecution |
A class encapsulating a node execution being run on a Flyte remote backend |
flytekit.remote.remote.FlyteRemote |
Main entrypoint for programmatically accessing a Flyte remote backend |
flytekit.remote.remote.FlyteTask |
A class encapsulating a remote Flyte task |
flytekit.remote.remote.FlyteTaskExecution |
A class encapsulating a task execution being run on a Flyte remote backend |
flytekit.remote.remote.FlyteTaskNode |
A class encapsulating a task that a Flyte node needs to execute |
flytekit.remote.remote.FlyteValueException |
Inappropriate argument value (of correct type) |
flytekit.remote.remote.FlyteWorkflow |
A class encapsulating a remote Flyte workflow |
flytekit.remote.remote.FlyteWorkflowExecution |
A class encapsulating a workflow execution being run on a Flyte remote backend |
flytekit.remote.remote.Identifier |
None |
flytekit.remote.remote.ImageConfig |
We recommend you to use ImageConfig |
flytekit.remote.remote.ImageSpec |
This class is used to specify the docker image that will be used to run the task |
flytekit.remote.remote.LaunchPlan |
Launch Plans are one of the core constructs of Flyte |
flytekit.remote.remote.LaunchPlanState |
None |
flytekit.remote.remote.LazyEntity |
Fetches the entity when the entity is called or when the entity is retrieved |
flytekit.remote.remote.Literal |
None |
flytekit.remote.remote.LiteralMap |
None |
flytekit.remote.remote.LiteralsResolver |
LiteralsResolver is a helper class meant primarily for use with the FlyteRemote experience or any other situation |
flytekit.remote.remote.NamedEntityIdentifier |
None |
flytekit.remote.remote.Node |
None |
flytekit.remote.remote.NodeExecutionGetDataResponse |
Currently, node, task, and workflow execution all have the same get data response |
flytekit.remote.remote.NodeMetadata |
None |
flytekit.remote.remote.NotificationList |
None |
flytekit.remote.remote.Options |
These are options that can be configured for a launchplan during registration or overridden during an execution |
flytekit.remote.remote.OrderedDict |
Dictionary that remembers insertion order |
flytekit.remote.remote.PickledEntity |
Represents the structure of the pickled object stored in the |
flytekit.remote.remote.PickledEntityMetadata |
Metadata for a pickled entity containing version information |
flytekit.remote.remote.Progress |
Renders an auto-updating progress bar(s) |
flytekit.remote.remote.Project |
None |
flytekit.remote.remote.PythonAutoContainerTask |
A Python AutoContainer task should be used as the base for all extensions that want the user’s code to be in the |
flytekit.remote.remote.PythonFunctionTask |
A Python Function task should be used as the base for all extensions that have a python function |
flytekit.remote.remote.PythonFunctionWorkflow |
Please read :std:ref:flyte:divedeep-workflows first for a high-level understanding of what workflows are in Flyte |
flytekit.remote.remote.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.remote.remote.ReferenceEntity |
None |
flytekit.remote.remote.ReferenceLaunchPlan |
A reference launch plan serves as a pointer to a Launch Plan that already exists on your Flyte installation |
flytekit.remote.remote.ReferenceSpec |
None |
flytekit.remote.remote.ReferenceTask |
This is a reference task, the body of the function passed in through the constructor will never be used, only the |
flytekit.remote.remote.ReferenceWorkflow |
A reference workflow is a pointer to a workflow that already exists on your Flyte installation |
flytekit.remote.remote.RegistrationSkipped |
RegistrationSkipped error is raised when trying to register an entity that is not registrable |
flytekit.remote.remote.RemoteEntity |
Helper class that provides a standard way to create an ABC using |
flytekit.remote.remote.ResolvedIdentifiers |
None |
flytekit.remote.remote.ResourceType |
None |
flytekit.remote.remote.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.remote.remote.Signal |
A ProtocolMessage |
flytekit.remote.remote.SignalIdentifier |
None |
flytekit.remote.remote.SignalListRequest |
A ProtocolMessage |
flytekit.remote.remote.SignalSetRequest |
A ProtocolMessage |
flytekit.remote.remote.Sort |
None |
flytekit.remote.remote.SynchronousFlyteClient |
This is a low-level client that users can use to make direct gRPC service calls to the control plane |
flytekit.remote.remote.TextColumn |
A column containing text |
flytekit.remote.remote.TimeElapsedColumn |
Renders time elapsed |
flytekit.remote.remote.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.remote.remote.TypedInterface |
None |
flytekit.remote.remote.WorkflowBase |
None |
flytekit.remote.remote.WorkflowExecutionGetDataResponse |
Currently, node, task, and workflow execution all have the same get data response |
flytekit.remote.remote.WorkflowExecutionIdentifier |
None |
flytekit.remote.remote.WorkflowFailurePolicy |
Defines the behavior for a workflow execution in the case of an observed node execution failure |
flytekit.remote.remote.datetime |
datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]]) |
flytekit.remote.remote.timedelta |
Difference between two datetime values |
flytekit.remote.remote_callable.ABC |
Helper class that provides a standard way to create an ABC using |
flytekit.remote.remote_callable.Any |
Special type indicating an unconstrained type |
flytekit.remote.remote_callable.BranchEvalMode |
This is a 3-way class, with the None value meaning that we are not within a conditional context |
flytekit.remote.remote_callable.ExecutionState |
This is the context that is active when executing a task or a local workflow |
flytekit.remote.remote_callable.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.remote.remote_callable.Identifier |
None |
flytekit.remote.remote_callable.NodeMetadata |
None |
flytekit.remote.remote_callable.Promise |
This object is a wrapper and exists for three main reasons |
flytekit.remote.remote_callable.RemoteEntity |
Helper class that provides a standard way to create an ABC using |
flytekit.remote.remote_callable.VoidPromise |
This object is returned for tasks that do not return any outputs (declared interface is empty) |
flytekit.remote.remote_fs.FlytePathResolver |
None |
flytekit.remote.remote_fs.NoOpCallback |
This implementation of Callback does exactly nothing |
flytekit.remote.remote_fs.UUID |
Instances of the UUID class represent UUIDs as specified in RFC 4122 |
flytekit.sensor.BaseSensor |
Base class for all sensors |
flytekit.sensor.FileSensor |
Base class for all sensors |
flytekit.sensor.SensorEngine |
This is the base class for all async agents |
flytekit.sensor.base_sensor.Any |
Special type indicating an unconstrained type |
flytekit.sensor.base_sensor.AsyncAgentExecutorMixin |
This mixin class is used to run the async task locally, and it’s only used for local execution |
flytekit.sensor.base_sensor.BaseSensor |
Base class for all sensors |
flytekit.sensor.base_sensor.Interface |
A Python native interface object, like inspect |
flytekit.sensor.base_sensor.Protocol |
Base class for protocol classes |
flytekit.sensor.base_sensor.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.sensor.base_sensor.ResourceMeta |
This is the metadata for the job |
flytekit.sensor.base_sensor.SensorConfig |
Base class for protocol classes |
flytekit.sensor.base_sensor.SensorMetadata |
None |
flytekit.sensor.base_sensor.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.sensor.base_sensor.TaskMetadata |
Metadata for a Task |
flytekit.sensor.base_sensor.TypeVar |
Type variable |
flytekit.sensor.file_sensor.BaseSensor |
Base class for all sensors |
flytekit.sensor.file_sensor.FileSensor |
Base class for all sensors |
flytekit.sensor.file_sensor.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.sensor.sensor_engine.AgentRegistry |
This is the registry for all agents |
flytekit.sensor.sensor_engine.AsyncAgentBase |
This is the base class for all async agents |
flytekit.sensor.sensor_engine.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.sensor.sensor_engine.LiteralMap |
None |
flytekit.sensor.sensor_engine.Resource |
This is the output resource of the job |
flytekit.sensor.sensor_engine.SensorEngine |
This is the base class for all async agents |
flytekit.sensor.sensor_engine.SensorMetadata |
None |
flytekit.sensor.sensor_engine.TaskExecution |
A ProtocolMessage |
flytekit.sensor.sensor_engine.TaskTemplate |
None |
flytekit.sensor.sensor_engine.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.testing.SecretsManager |
This provides a secrets resolution logic at runtime |
flytekit.tools.fast_registration.BarColumn |
Renders a visual progress bar |
flytekit.tools.fast_registration.CopyFileDetection |
Create a collection of name/value pairs |
flytekit.tools.fast_registration.DockerIgnore |
Uses docker-py’s PatternMatcher to check whether a path is ignored |
flytekit.tools.fast_registration.FastPackageOptions |
FastPackageOptions is used to set configuration options when packaging files |
flytekit.tools.fast_registration.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.tools.fast_registration.FlyteDataNotFoundException |
Inappropriate argument value (of correct type) |
flytekit.tools.fast_registration.FlyteIgnore |
Uses a |
flytekit.tools.fast_registration.GitIgnore |
Uses git cli (if available) to list all ignored files and compare with those |
flytekit.tools.fast_registration.Ignore |
Base for Ignores, implements core logic |
flytekit.tools.fast_registration.IgnoreGroup |
Groups multiple Ignores and checks a path against them |
flytekit.tools.fast_registration.Progress |
Renders an auto-updating progress bar(s) |
flytekit.tools.fast_registration.StandardIgnore |
Retains the standard ignore functionality that previously existed |
flytekit.tools.fast_registration.TextColumn |
A column containing text |
flytekit.tools.fast_registration.TimeElapsedColumn |
Renders time elapsed |
flytekit.tools.fast_registration.Tree |
A renderable for a tree structure |
flytekit.tools.fast_registration.timeit |
A context manager and a decorator that measures the execution time of the wrapped code block or functions |
flytekit.tools.ignore.ABC |
Helper class that provides a standard way to create an ABC using |
flytekit.tools.ignore.DockerIgnore |
Uses docker-py’s PatternMatcher to check whether a path is ignored |
flytekit.tools.ignore.FlyteIgnore |
Uses a |
flytekit.tools.ignore.GitIgnore |
Uses git cli (if available) to list all ignored files and compare with those |
flytekit.tools.ignore.Ignore |
Base for Ignores, implements core logic |
flytekit.tools.ignore.IgnoreGroup |
Groups multiple Ignores and checks a path against them |
flytekit.tools.ignore.Path |
PurePath subclass that can make system calls |
flytekit.tools.ignore.PatternMatcher |
None |
flytekit.tools.ignore.StandardIgnore |
Retains the standard ignore functionality that previously existed |
flytekit.tools.module_loader.Any |
Special type indicating an unconstrained type |
flytekit.tools.repo.CopyFileDetection |
Create a collection of name/value pairs |
flytekit.tools.repo.FastSerializationSettings |
This object hold information about settings necessary to serialize an object so that it can be fast-registered |
flytekit.tools.repo.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.tools.repo.FlyteRemote |
Main entrypoint for programmatically accessing a Flyte remote backend |
flytekit.tools.repo.Identifier |
None |
flytekit.tools.repo.ImageConfig |
We recommend you to use ImageConfig |
flytekit.tools.repo.NoSerializableEntitiesError |
Common base class for all non-exit exceptions |
flytekit.tools.repo.Options |
These are options that can be configured for a launchplan during registration or overridden during an execution |
flytekit.tools.repo.Path |
PurePath subclass that can make system calls |
flytekit.tools.repo.RegistrationSkipped |
RegistrationSkipped error is raised when trying to register an entity that is not registrable |
flytekit.tools.repo.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.tools.script_mode.CopyFileDetection |
Create a collection of name/value pairs |
flytekit.tools.script_mode.IgnoreGroup |
Groups multiple Ignores and checks a path against them |
flytekit.tools.script_mode.ModuleType |
Create a module object |
flytekit.tools.script_mode.Path |
PurePath subclass that can make system calls |
flytekit.tools.script_mode.datetime |
datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]]) |
flytekit.tools.script_mode.timezone |
Fixed offset from UTC implementation of tzinfo |
flytekit.tools.serialize_helpers.EagerAsyncPythonFunctionTask |
This is the base eager task (aka eager workflow) type |
flytekit.tools.serialize_helpers.LaunchPlan |
Launch Plans are one of the core constructs of Flyte |
flytekit.tools.serialize_helpers.Options |
These are options that can be configured for a launchplan during registration or overridden during an execution |
flytekit.tools.serialize_helpers.OrderedDict |
Dictionary that remembers insertion order |
flytekit.tools.serialize_helpers.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.tools.serialize_helpers.RemoteEntity |
Helper class that provides a standard way to create an ABC using |
flytekit.tools.serialize_helpers.TaskSpec |
None |
flytekit.tools.serialize_helpers.WorkflowBase |
None |
flytekit.tools.serialize_helpers.WorkflowSpec |
None |
flytekit.tools.translator.ApproveCondition |
None |
flytekit.tools.translator.ArrayNode |
None |
flytekit.tools.translator.ArrayNodeMapTask |
Base Class for all Tasks with a Python native Interface |
flytekit.tools.translator.ArrayNodeModel |
None |
flytekit.tools.translator.BranchNode |
None |
flytekit.tools.translator.BranchNodeModel |
None |
flytekit.tools.translator.ClassDecorator |
Abstract class for class decorators |
flytekit.tools.translator.ContainerTask |
This is an intermediate class that represents Flyte Tasks that run a container at execution time |
flytekit.tools.translator.EagerAsyncPythonFunctionTask |
This is the base eager task (aka eager workflow) type |
flytekit.tools.translator.Gate |
A node type that waits for user input before proceeding with a workflow |
flytekit.tools.translator.GateNode |
None |
flytekit.tools.translator.Image |
Image is a structured wrapper for task container images used in object serialization |
flytekit.tools.translator.ImageConfig |
We recommend you to use ImageConfig |
flytekit.tools.translator.ImageSpec |
This class is used to specify the docker image that will be used to run the task |
flytekit.tools.translator.LaunchPlan |
Launch Plans are one of the core constructs of Flyte |
flytekit.tools.translator.MapPythonTask |
A MapPythonTask defines a :py:class:`flytekit |
flytekit.tools.translator.Node |
This class will hold all the things necessary to make an SdkNode but we won’t make one until we know things like |
flytekit.tools.translator.Options |
These are options that can be configured for a launchplan during registration or overridden during an execution |
flytekit.tools.translator.OrderedDict |
Dictionary that remembers insertion order |
flytekit.tools.translator.PodTemplate |
Custom PodTemplate specification for a Task |
flytekit.tools.translator.PythonAutoContainerTask |
A Python AutoContainer task should be used as the base for all extensions that want the user’s code to be in the |
flytekit.tools.translator.PythonFunctionTask |
A Python Function task should be used as the base for all extensions that have a python function |
flytekit.tools.translator.PythonTask |
Base Class for all Tasks with a Python native Interface |
flytekit.tools.translator.ReferenceEntity |
None |
flytekit.tools.translator.ReferenceLaunchPlan |
A reference launch plan serves as a pointer to a Launch Plan that already exists on your Flyte installation |
flytekit.tools.translator.ReferenceSpec |
None |
flytekit.tools.translator.ReferenceTask |
This is a reference task, the body of the function passed in through the constructor will never be used, only the |
flytekit.tools.translator.ReferenceTemplate |
None |
flytekit.tools.translator.ReferenceWorkflow |
A reference workflow is a pointer to a workflow that already exists on your Flyte installation |
flytekit.tools.translator.SerializationSettings |
These settings are provided while serializing a workflow and task, before registration |
flytekit.tools.translator.SignalCondition |
None |
flytekit.tools.translator.SleepCondition |
None |
flytekit.tools.translator.SourceCode |
Link to source code used to define this task or workflow |
flytekit.tools.translator.TaskNodeOverrides |
None |
flytekit.tools.translator.TaskSpec |
None |
flytekit.tools.translator.TaskTemplate |
None |
flytekit.tools.translator.WorkflowBase |
None |
flytekit.tools.translator.WorkflowSpec |
None |
flytekit.types.directory.FlyteDirToMultipartBlobTransformer |
This transformer handles conversion between the Python native FlyteDirectory class defined above, and the Flyte |
flytekit.types.directory.FlyteDirectory |
None |
flytekit.types.directory.TFRecordsDirectory |
FlyteDirectory(path: ’typing |
flytekit.types.directory.TensorboardLogs |
FlyteDirectory(path: ’typing |
flytekit.types.directory.types.Any |
Special type indicating an unconstrained type |
flytekit.types.directory.types.AsyncTypeTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.directory.types.Binary |
None |
flytekit.types.directory.types.Blob |
None |
flytekit.types.directory.types.BlobMetadata |
This is metadata for the Blob literal |
flytekit.types.directory.types.BlobType |
This type represents offloaded data and is typically used for things like files |
flytekit.types.directory.types.DataClassJsonMixin |
DataClassJsonMixin is an ABC that functions as a Mixin |
flytekit.types.directory.types.FileExt |
Used for annotating file extension types of FlyteFile |
flytekit.types.directory.types.FlyteAssertion |
Assertion failed |
flytekit.types.directory.types.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.types.directory.types.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.types.directory.types.FlyteDirToMultipartBlobTransformer |
This transformer handles conversion between the Python native FlyteDirectory class defined above, and the Flyte |
flytekit.types.directory.types.FlyteDirectory |
None |
flytekit.types.directory.types.FlyteFile |
None |
flytekit.types.directory.types.Literal |
None |
flytekit.types.directory.types.LiteralType |
None |
flytekit.types.directory.types.Path |
PurePath subclass that can make system calls |
flytekit.types.directory.types.Scalar |
None |
flytekit.types.directory.types.SerializableType |
None |
flytekit.types.directory.types.Struct |
A ProtocolMessage |
flytekit.types.directory.types.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.types.directory.types.TypeTransformerFailedError |
Inappropriate argument type |
flytekit.types.directory.types.UUID |
Instances of the UUID class represent UUIDs as specified in RFC 4122 |
flytekit.types.directory.types.partial |
partial(func, *args, **keywords) - new function with partial application |
flytekit.types.error.FlyteError |
Special Task type that will be used in the failure node |
flytekit.types.error.error.DataClassJSONMixin |
None |
flytekit.types.error.error.Error |
None |
flytekit.types.error.error.ErrorTransformer |
Enables converting a python type FlyteError to LiteralType |
flytekit.types.error.error.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.types.error.error.FlyteError |
Special Task type that will be used in the failure node |
flytekit.types.error.error.Literal |
None |
flytekit.types.error.error.LiteralType |
None |
flytekit.types.error.error.Scalar |
None |
flytekit.types.error.error.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.types.error.error.TypeTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.error.error.TypeTransformerFailedError |
Inappropriate argument type |
flytekit.types.error.error.TypeVar |
Type variable |
flytekit.types.file.Annotated |
Add context-specific metadata to a type |
flytekit.types.file.CSVFile |
FlyteFile(path: ’typing |
flytekit.types.file.FileExt |
Used for annotating file extension types of FlyteFile |
flytekit.types.file.FlyteFile |
None |
flytekit.types.file.FlyteFilePathTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.file.HDF5EncodedFile |
FlyteFile(path: ’typing |
flytekit.types.file.HTMLPage |
FlyteFile(path: ’typing |
flytekit.types.file.JPEGImageFile |
FlyteFile(path: ’typing |
flytekit.types.file.JSONLFile |
FlyteFile(path: ’typing |
flytekit.types.file.JoblibSerializedFile |
FlyteFile(path: ’typing |
flytekit.types.file.ONNXFile |
FlyteFile(path: ’typing |
flytekit.types.file.PDFFile |
FlyteFile(path: ’typing |
flytekit.types.file.PNGImageFile |
FlyteFile(path: ’typing |
flytekit.types.file.PythonNotebook |
FlyteFile(path: ’typing |
flytekit.types.file.PythonPickledFile |
FlyteFile(path: ’typing |
flytekit.types.file.SVGImageFile |
FlyteFile(path: ’typing |
flytekit.types.file.TFRecordFile |
FlyteFile(path: ’typing |
flytekit.types.file.file.AsyncTypeTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.file.file.Binary |
None |
flytekit.types.file.file.Blob |
None |
flytekit.types.file.file.BlobMetadata |
This is metadata for the Blob literal |
flytekit.types.file.file.BlobType |
This type represents offloaded data and is typically used for things like files |
flytekit.types.file.file.DataClassJSONMixin |
None |
flytekit.types.file.file.FlyteAssertion |
Assertion failed |
flytekit.types.file.file.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.types.file.file.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.types.file.file.FlyteFile |
None |
flytekit.types.file.file.FlyteFilePathTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.file.file.FlytePickleTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.file.file.Literal |
None |
flytekit.types.file.file.LiteralType |
None |
flytekit.types.file.file.Scalar |
None |
flytekit.types.file.file.SerializableType |
None |
flytekit.types.file.file.Struct |
A ProtocolMessage |
flytekit.types.file.file.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.types.file.file.TypeTransformerFailedError |
Inappropriate argument type |
flytekit.types.file.file.partial |
partial(func, *args, **keywords) - new function with partial application |
flytekit.types.iterator.FlyteIterator |
None |
flytekit.types.iterator.iterator.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.types.iterator.iterator.FlyteIterator |
None |
flytekit.types.iterator.iterator.IteratorTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.iterator.iterator.Literal |
None |
flytekit.types.iterator.iterator.LiteralCollection |
None |
flytekit.types.iterator.iterator.LiteralType |
None |
flytekit.types.iterator.iterator.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.types.iterator.iterator.TypeTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.iterator.iterator.TypeTransformerFailedError |
Inappropriate argument type |
flytekit.types.iterator.json_iterator.Any |
Special type indicating an unconstrained type |
flytekit.types.iterator.json_iterator.AsyncTypeTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.iterator.json_iterator.Blob |
None |
flytekit.types.iterator.json_iterator.BlobMetadata |
This is metadata for the Blob literal |
flytekit.types.iterator.json_iterator.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.types.iterator.json_iterator.JSONIterator |
Abstract base class for generic types |
flytekit.types.iterator.json_iterator.JSONIteratorTransformer |
A JSON iterator that handles conversion between an iterator/generator and a JSONL file |
flytekit.types.iterator.json_iterator.Literal |
None |
flytekit.types.iterator.json_iterator.LiteralType |
None |
flytekit.types.iterator.json_iterator.Path |
PurePath subclass that can make system calls |
flytekit.types.iterator.json_iterator.Scalar |
None |
flytekit.types.iterator.json_iterator.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.types.iterator.json_iterator.TypeTransformerFailedError |
Inappropriate argument type |
flytekit.types.pickle.FlytePickle |
This type is only used by flytekit internally |
flytekit.types.pickle.pickle.AsyncTypeTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.pickle.pickle.Blob |
None |
flytekit.types.pickle.pickle.BlobMetadata |
This is metadata for the Blob literal |
flytekit.types.pickle.pickle.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.types.pickle.pickle.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.types.pickle.pickle.FlytePickle |
This type is only used by flytekit internally |
flytekit.types.pickle.pickle.FlytePickleTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.pickle.pickle.Literal |
None |
flytekit.types.pickle.pickle.LiteralType |
None |
flytekit.types.pickle.pickle.Scalar |
None |
flytekit.types.pickle.pickle.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.types.schema.FlyteSchema |
None |
flytekit.types.schema.FlyteSchemaTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.schema.LocalIOSchemaReader |
Base SchemaReader to handle any readers (that can manage their own IO or otherwise) |
flytekit.types.schema.LocalIOSchemaWriter |
Abstract base class for generic types |
flytekit.types.schema.SchemaEngine |
This is the core Engine that handles all schema sub-systems |
flytekit.types.schema.SchemaFormat |
Represents the schema storage format (at rest) |
flytekit.types.schema.SchemaHandler |
None |
flytekit.types.schema.SchemaOpenMode |
Create a collection of name/value pairs |
flytekit.types.schema.SchemaReader |
Base SchemaReader to handle any readers (that can manage their own IO or otherwise) |
flytekit.types.schema.SchemaWriter |
Abstract base class for generic types |
flytekit.types.schema.types.AsyncTypeTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.schema.types.Binary |
None |
flytekit.types.schema.types.DataClassJSONMixin |
None |
flytekit.types.schema.types.Enum |
Create a collection of name/value pairs |
flytekit.types.schema.types.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.types.schema.types.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.types.schema.types.FlyteSchema |
None |
flytekit.types.schema.types.FlyteSchemaTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.schema.types.Literal |
None |
flytekit.types.schema.types.LiteralType |
None |
flytekit.types.schema.types.LocalIOSchemaReader |
Base SchemaReader to handle any readers (that can manage their own IO or otherwise) |
flytekit.types.schema.types.LocalIOSchemaWriter |
Abstract base class for generic types |
flytekit.types.schema.types.Path |
PurePath subclass that can make system calls |
flytekit.types.schema.types.Scalar |
None |
flytekit.types.schema.types.Schema |
None |
flytekit.types.schema.types.SchemaEngine |
This is the core Engine that handles all schema sub-systems |
flytekit.types.schema.types.SchemaFormat |
Represents the schema storage format (at rest) |
flytekit.types.schema.types.SchemaHandler |
None |
flytekit.types.schema.types.SchemaOpenMode |
Create a collection of name/value pairs |
flytekit.types.schema.types.SchemaReader |
Base SchemaReader to handle any readers (that can manage their own IO or otherwise) |
flytekit.types.schema.types.SchemaType |
None |
flytekit.types.schema.types.SchemaWriter |
Abstract base class for generic types |
flytekit.types.schema.types.SerializableType |
None |
flytekit.types.schema.types.Struct |
A ProtocolMessage |
flytekit.types.schema.types.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.types.schema.types.TypeTransformerFailedError |
Inappropriate argument type |
flytekit.types.structured.ArrowRenderer |
Render an Arrow dataframe as an HTML table |
flytekit.types.structured.DuplicateHandlerError |
Inappropriate argument value (of correct type) |
flytekit.types.structured.StructuredDataset |
This is the user facing StructuredDataset class |
flytekit.types.structured.StructuredDatasetDecoder |
Helper class that provides a standard way to create an ABC using |
flytekit.types.structured.StructuredDatasetEncoder |
Helper class that provides a standard way to create an ABC using |
flytekit.types.structured.StructuredDatasetTransformerEngine |
Think of this transformer as a higher-level meta transformer that is used for all the dataframe types |
flytekit.types.structured.TopFrameRenderer |
Render a DataFrame as an HTML table |
flytekit.types.structured.basic_dfs.ArrowToParquetEncodingHandler |
Helper class that provides a standard way to create an ABC using |
flytekit.types.structured.basic_dfs.CSVToPandasDecodingHandler |
Helper class that provides a standard way to create an ABC using |
flytekit.types.structured.basic_dfs.DataConfig |
Any data storage specific configuration |
flytekit.types.structured.basic_dfs.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.types.structured.basic_dfs.NoCredentialsError |
No credentials could be found |
flytekit.types.structured.basic_dfs.PandasToCSVEncodingHandler |
Helper class that provides a standard way to create an ABC using |
flytekit.types.structured.basic_dfs.PandasToParquetEncodingHandler |
Helper class that provides a standard way to create an ABC using |
flytekit.types.structured.basic_dfs.ParquetToArrowDecodingHandler |
Helper class that provides a standard way to create an ABC using |
flytekit.types.structured.basic_dfs.ParquetToPandasDecodingHandler |
Helper class that provides a standard way to create an ABC using |
flytekit.types.structured.basic_dfs.Path |
PurePath subclass that can make system calls |
flytekit.types.structured.basic_dfs.StructuredDataset |
This is the user facing StructuredDataset class |
flytekit.types.structured.basic_dfs.StructuredDatasetDecoder |
Helper class that provides a standard way to create an ABC using |
flytekit.types.structured.basic_dfs.StructuredDatasetEncoder |
Helper class that provides a standard way to create an ABC using |
flytekit.types.structured.basic_dfs.StructuredDatasetMetadata |
None |
flytekit.types.structured.basic_dfs.StructuredDatasetType |
None |
flytekit.types.structured.basic_dfs.TypeVar |
Type variable |
flytekit.types.structured.structured_dataset.ABC |
Helper class that provides a standard way to create an ABC using |
flytekit.types.structured.structured_dataset.Annotated |
Add context-specific metadata to a type |
flytekit.types.structured.structured_dataset.AsyncTypeTransformer |
Base transformer type that should be implemented for every python native type that can be handled by flytekit |
flytekit.types.structured.structured_dataset.Binary |
None |
flytekit.types.structured.structured_dataset.DataClassJSONMixin |
None |
flytekit.types.structured.structured_dataset.DuplicateHandlerError |
Inappropriate argument value (of correct type) |
flytekit.types.structured.structured_dataset.FlyteContext |
This is an internal-facing context object, that most users will not have to deal with |
flytekit.types.structured.structured_dataset.FlyteContextManager |
FlyteContextManager manages the execution context within Flytekit |
flytekit.types.structured.structured_dataset.Generic |
Abstract base class for generic types |
flytekit.types.structured.structured_dataset.Literal |
None |
flytekit.types.structured.structured_dataset.LiteralType |
None |
flytekit.types.structured.structured_dataset.Renderable |
Base class for protocol classes |
flytekit.types.structured.structured_dataset.Scalar |
None |
flytekit.types.structured.structured_dataset.SchemaType |
None |
flytekit.types.structured.structured_dataset.SerializableType |
None |
flytekit.types.structured.structured_dataset.Struct |
A ProtocolMessage |
flytekit.types.structured.structured_dataset.StructuredDataset |
This is the user facing StructuredDataset class |
flytekit.types.structured.structured_dataset.StructuredDatasetDecoder |
Helper class that provides a standard way to create an ABC using |
flytekit.types.structured.structured_dataset.StructuredDatasetEncoder |
Helper class that provides a standard way to create an ABC using |
flytekit.types.structured.structured_dataset.StructuredDatasetFormat |
str(object=’’) -> str |
flytekit.types.structured.structured_dataset.StructuredDatasetMetadata |
None |
flytekit.types.structured.structured_dataset.StructuredDatasetTransformerEngine |
Think of this transformer as a higher-level meta transformer that is used for all the dataframe types |
flytekit.types.structured.structured_dataset.StructuredDatasetType |
None |
flytekit.types.structured.structured_dataset.TypeEngine |
Core Extensible TypeEngine of Flytekit |
flytekit.types.structured.structured_dataset.TypeTransformerFailedError |
Inappropriate argument type |
flytekit.utils.asyn.Any |
Special type indicating an unconstrained type |
flytekit.utils.asyn.ParamSpec |
Parameter specification |
flytekit.utils.asyn.TypeVar |
Type variable |
flytekit.utils.dict_formatter.Any |
Special type indicating an unconstrained type |
flytekit.utils.pbhash.Message |
Abstract base class for protocol messages |
flytekit.utils.rate_limiter.RateLimiter |
Rate limiter that allows up to a certain number of requests per minute |
flytekit.utils.rate_limiter.datetime |
datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]]) |
flytekit.utils.rate_limiter.deque |
deque([iterable[, maxlen]]) –> deque object |
flytekit.utils.rate_limiter.timedelta |
Difference between two datetime values |