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. |
Enum |
Create a collection of name/value pairs. |
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.
def 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() |
None |
serialize_to_string() |
None |
short_string() |
|
to_flyte_idl() |
None |
verbose_string() |
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.admin.description_entity_pb2.Description,
):
Parameter | Type |
---|---|
pb2_object |
flyteidl.admin.description_entity_pb2.Description |
serialize_to_string()
def serialize_to_string()
short_string()
def short_string()
to_flyte_idl()
def to_flyte_idl()
verbose_string()
def verbose_string()
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.
def 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() |
None |
serialize_to_string() |
None |
short_string() |
|
to_flyte_idl() |
None |
verbose_string() |
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.admin.description_entity_pb2.DescriptionEntity,
):
Parameter | Type |
---|---|
pb2_object |
flyteidl.admin.description_entity_pb2.DescriptionEntity |
serialize_to_string()
def serialize_to_string()
short_string()
def short_string()
to_flyte_idl()
def to_flyte_idl()
verbose_string()
def verbose_string()
Properties
Property | Type | Description |
---|---|---|
is_empty |
flytekit.models.documentation.Enum
Create a collection of name/value pairs.
Example enumeration:
class Color(Enum): … RED = 1 … BLUE = 2 … GREEN = 3
Access them by:
- attribute access:
Color.RED <Color.RED: 1>
- value lookup:
Color(1) <Color.RED: 1>
- name lookup:
Color[‘RED’] <Color.RED: 1>
Enumerations can be iterated over, and know how many members they have:
len(Color) 3
list(Color) [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.
flytekit.models.documentation.SourceCode
Link to source code used to define this task or workflow.
def SourceCode(
link: typing.Optional[str],
):
Parameter | Type |
---|---|
link |
typing.Optional[str] |
Methods
Method | Description |
---|---|
from_flyte_idl() |
None |
serialize_to_string() |
None |
short_string() |
|
to_flyte_idl() |
None |
verbose_string() |
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.admin.description_entity_pb2.SourceCode,
):
Parameter | Type |
---|---|
pb2_object |
flyteidl.admin.description_entity_pb2.SourceCode |
serialize_to_string()
def serialize_to_string()
short_string()
def short_string()
to_flyte_idl()
def to_flyte_idl()
verbose_string()
def verbose_string()
Properties
Property | Type | Description |
---|---|---|
is_empty |