The page you navigated to () does not exist, so we brought you to the closest page to it.
You have switched from the to the variant of this site. There is no equivalent of . We have taken you to the closest page in the variant.
1.16.16
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.
Parameters
class Description(
value: typing.Optional[str],
uri: typing.Optional[str],
icon_link: typing.Optional[str],
format: <enum 'DescriptionFormat'>,
)| Parameter | Type | Description |
|---|---|---|
value |
typing.Optional[str] |
|
uri |
typing.Optional[str] |
|
icon_link |
typing.Optional[str] |
|
format |
<enum 'DescriptionFormat'> |
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.admin.description_entity_pb2.Description,
) -> Description| Parameter | Type | Description |
|---|---|---|
pb2_object |
flyteidl.admin.description_entity_pb2.Description |
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()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.
Parameters
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 | 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 |
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.admin.description_entity_pb2.DescriptionEntity,
) -> Documentation| Parameter | Type | Description |
|---|---|---|
pb2_object |
flyteidl.admin.description_entity_pb2.DescriptionEntity |
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()flytekit.models.documentation.SourceCode
Link to source code used to define this task or workflow.
Parameters
class SourceCode(
link: typing.Optional[str],
)| Parameter | Type | Description |
|---|---|---|
link |
typing.Optional[str] |
Properties
| Property | Type | Description |
|---|---|---|
is_empty |
None |
Methods
| Method | Description |
|---|---|
from_flyte_idl() |
|
serialize_to_string() |
|
short_string() |
|
to_flyte_idl() |
from_flyte_idl()
def from_flyte_idl(
pb2_object: flyteidl.admin.description_entity_pb2.SourceCode,
) -> SourceCode| Parameter | Type | Description |
|---|---|---|
pb2_object |
flyteidl.admin.description_entity_pb2.SourceCode |
serialize_to_string()
def serialize_to_string()short_string()
def short_string()Returns: Text
to_flyte_idl()
def to_flyte_idl()