0.1.dev2184+g1e0cbe7.d20250401

flytekit.models.documentation

Directory

Classes

Class Description
Description Full user description with formatting preserved.
Documentation DescriptionEntity contains detailed description for the task/workflow/launch plan.
SourceCode Link to source code used to define this task or workflow.

flytekit.models.documentation.Description

Full user description with formatting preserved. This can be rendered by clients, such as the console or command line tools with in-tact formatting.

class Description(
    value: typing.Optional[str],
    uri: typing.Optional[str],
    icon_link: typing.Optional[str],
    format: <enum 'DescriptionFormat'>,
)
Parameter Type
value typing.Optional[str]
uri typing.Optional[str]
icon_link typing.Optional[str]
format <enum 'DescriptionFormat'>

Methods

Method Description
from_flyte_idl()
serialize_to_string()
short_string() :rtype: Text.
to_flyte_idl()
verbose_string() :rtype: Text.

from_flyte_idl()

def from_flyte_idl(
    pb2_object: flyteidl.admin.description_entity_pb2.Description,
) -> Description
Parameter Type
pb2_object flyteidl.admin.description_entity_pb2.Description

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
is_empty

flytekit.models.documentation.Documentation

DescriptionEntity contains detailed description for the task/workflow/launch plan. Documentation could provide insight into the algorithms, business use case, etc.

class Documentation(
    short_description: typing.Optional[str],
    long_description: typing.Optional[flytekit.models.documentation.Description],
    source_code: typing.Optional[flytekit.models.documentation.SourceCode],
)
Parameter Type
short_description typing.Optional[str]
long_description typing.Optional[flytekit.models.documentation.Description]
source_code typing.Optional[flytekit.models.documentation.SourceCode]

Methods

Method Description
from_flyte_idl()
serialize_to_string()
short_string() :rtype: Text.
to_flyte_idl()
verbose_string() :rtype: Text.

from_flyte_idl()

def from_flyte_idl(
    pb2_object: flyteidl.admin.description_entity_pb2.DescriptionEntity,
) -> Documentation
Parameter Type
pb2_object flyteidl.admin.description_entity_pb2.DescriptionEntity

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
is_empty

flytekit.models.documentation.SourceCode

Link to source code used to define this task or workflow.

class SourceCode(
    link: typing.Optional[str],
)
Parameter Type
link typing.Optional[str]

Methods

Method Description
from_flyte_idl()
serialize_to_string()
short_string() :rtype: Text.
to_flyte_idl()
verbose_string() :rtype: Text.

from_flyte_idl()

def from_flyte_idl(
    pb2_object: flyteidl.admin.description_entity_pb2.SourceCode,
) -> SourceCode
Parameter Type
pb2_object flyteidl.admin.description_entity_pb2.SourceCode

serialize_to_string()

def serialize_to_string()

short_string()

def short_string()

:rtype: Text

to_flyte_idl()

def to_flyte_idl()

verbose_string()

def verbose_string()

:rtype: Text

Properties

Property Type Description
is_empty