Skip to main content

FlyteAnnotation

A core object to add arbitrary annotations to flyte types. This metadata is ingested as a python dictionary and will be serialized into fields on the flyteidl type literals. This data is not accessible at runtime but rather can be retrieved from flyteadmin for custom presentation of typed parameters.

Attributes

AttributeTypeDescription
dataDict[str, Any]A dictionary of arbitrary metadata that is serialized into Flyte IDL type literals for custom presentation in FlyteAdmin.

Constructor

Signature

def FlyteAnnotation(self, data: Dict[str, Any]): ...

Parameters

NameTypeDescription
dataDict[str, Any]A dictionary containing arbitrary metadata to be serialized into flyteidl type literals.

Signature

def FlyteAnnotation(self, data: Dict[str, Any]): ...

Parameters

NameTypeDescription
dataDict[str, Any]A dictionary containing arbitrary metadata to be serialized into Flyte type literals for external retrieval.

Methods


data()

@property
def data(self): ...

Returns the underlying dictionary of metadata associated with this annotation.

Returns

TypeDescription
Dict[str, Any]The raw dictionary of annotation data used for custom presentation of typed parameters in Flyteadmin.