Contents Menu Expand
Flyte Docs
Logo
Flyte Docs
  • Getting Started
  • Tutorials
  • API Reference
    • Flytekit Python
    • Flytekit Java
    • FlyteIDL
    • Flytectl
    • FlytePropeller
    • FlyteAdmin
    • FlytePlugins
    • DataCatalog
  • Community

Flytekit SDK

  • Flytekit Python
  • Overview
    • Model Files
    • Authoring Structure
    • Control Plane Objects
    • Execution Time Support
    • Command Line Interfaces and Clients

APIs

  • Core Flytekit
    • flytekit.task
    • flytekit.workflow
    • flytekit.kwtypes
    • flytekit.current_context
    • flytekit.ExecutionParameters
    • flytekit.FlyteContext
    • flytekit.conditional
    • flytekit.TaskMetadata
    • flytekit.Resources
    • flytekit.WorkflowFailurePolicy
    • flytekit.dynamic
    • flytekit.CronSchedule
    • flytekit.FixedRate
    • flytekit.Email
    • flytekit.PagerDuty
    • flytekit.Slack
    • flytekit.get_reference_entity
    • flytekit.LaunchPlanReference
    • flytekit.TaskReference
    • flytekit.WorkflowReference
    • flytekit.reference_task
    • flytekit.reference_workflow
    • flytekit.SQLTask
    • flytekit.ContainerTask
    • flytekit.PythonFunctionTask
    • flytekit.PythonInstanceTask
    • flytekit.LaunchPlan
    • flytekit.Secret
    • flytekit.SecurityContext
    • flytekit.core.dynamic_workflow_task
    • flytekit.core.notification
    • flytekit.core.schedule
  • Unit Testing
    • flytekit.testing.patch
    • flytekit.testing.task_mock
  • Extending Flytekit
    • flytekit.extend.get_serializable
    • flytekit.extend.context_manager
    • flytekit.extend.SQLTask
    • flytekit.extend.IgnoreOutputs
    • flytekit.extend.PythonTask
    • flytekit.extend.ExecutionState
    • flytekit.extend.Image
    • flytekit.extend.ImageConfig
    • flytekit.extend.SerializationSettings
    • flytekit.extend.Interface
    • flytekit.extend.Promise
    • flytekit.extend.TaskPlugins
    • flytekit.extend.DictTransformer
    • flytekit.extend.T
    • flytekit.extend.TypeEngine
    • flytekit.extend.TypeTransformer

Contributing

  • Contributor Guide
  • Build your custom task types
  • Extend Type System
    • Flytekit Schema Type (flytekit.types.schema)
      • flytekit.types.schema.SchemaFormat
      • flytekit.types.schema.FlyteSchema
      • flytekit.types.schema.FlyteSchema.open
    • Flytekit File Type (flytekit.types.file)
      • flytekit.types.file.FlyteFile
      • flytekit.types.file.HDF5EncodedFile
      • flytekit.types.file.HTMLPage
      • flytekit.types.file.JoblibSerializedFile
      • flytekit.types.file.JPEGImageFile
      • flytekit.types.file.PDFFile
      • flytekit.types.file.PNGImageFile
      • flytekit.types.file.PythonPickledFile
      • flytekit.types.file.PythonNotebook
      • flytekit.types.file.SVGImageFile
    • Flytekit Directory Type (flytekit.types.directory)
      • flytekit.types.directory.FlyteDirectory
      • flytekit.types.directory.TensorboardLogs

Extend Type SystemΒΆ

Flytekit ships with an extensible type system, which makes it easy for anyone to extend and add new types. Feel free to follow the pattern of the built-in types.

  • Flytekit Schema Type (flytekit.types.schema)
  • Flytekit File Type (flytekit.types.file)
  • Flytekit Directory Type (flytekit.types.directory)
Next
Flytekit Schema Type (flytekit.types.schema)
Previous
Build your custom task types
Copyright © 2021, Flyte | Built with Sphinx and @pradyunsg's Furo theme. | Show Source