flytekit.models.documentation
| 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. |
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] = None,
uri: typing.Optional[str] = None,
icon_link: typing.Optional[str] = None,
format: <enum 'DescriptionFormat'> = DescriptionFormat.RST,
)
| Parameter |
Type |
Description |
value |
typing.Optional[str] |
|
uri |
typing.Optional[str] |
|
icon_link |
typing.Optional[str] |
|
format |
<enum 'DescriptionFormat'> |
|
| Property |
Type |
Description |
is_empty |
None |
|
def from_flyte_idl(
pb2_object: flyteidl.admin.description_entity_pb2.Description,
) -> Description
| Parameter |
Type |
Description |
pb2_object |
flyteidl.admin.description_entity_pb2.Description |
|
def serialize_to_string()
Returns: Text
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] = None,
long_description: typing.Optional[flytekit.models.documentation.Description] = None,
source_code: typing.Optional[flytekit.models.documentation.SourceCode] = None,
)
| Parameter |
Type |
Description |
short_description |
typing.Optional[str] |
One-liner overview of the entity. |
long_description |
typing.Optional[flytekit.models.documentation.Description] |
Full user description with formatting preserved. |
source_code |
typing.Optional[flytekit.models.documentation.SourceCode] |
link to source code used to define this entity |
| Property |
Type |
Description |
is_empty |
None |
|
def from_flyte_idl(
pb2_object: flyteidl.admin.description_entity_pb2.DescriptionEntity,
) -> Documentation
| Parameter |
Type |
Description |
pb2_object |
flyteidl.admin.description_entity_pb2.DescriptionEntity |
|
def serialize_to_string()
Returns: Text
Link to source code used to define this task or workflow.
class SourceCode(
link: typing.Optional[str] = None,
)
| Parameter |
Type |
Description |
link |
typing.Optional[str] |
|
| Property |
Type |
Description |
is_empty |
None |
|
def from_flyte_idl(
pb2_object: flyteidl.admin.description_entity_pb2.SourceCode,
) -> SourceCode
| Parameter |
Type |
Description |
pb2_object |
flyteidl.admin.description_entity_pb2.SourceCode |
|
def serialize_to_string()
Returns: Text
