Join the SIG TFX-Addons community and help make TFX even better!

tfx.types.Artifact

TFX artifact used for orchestration.

tfx.types.Artifact(
    mlmd_artifact_type: Optional[metadata_store_pb2.ArtifactType] = None
)

Used in the notebooks

Used in the tutorials

This is used for type-checking and inter-component communication. Currently, it wraps a tuple of (ml_metadata.proto.Artifact, ml_metadata.proto.ArtifactType) with additional property accessors for internal state.

A user may create a subclass of Artifact and override the TYPE_NAME property with the type for this artifact subclass. Users of the subclass may then omit the "type_name" field when construction the object.

A user may specify artifact type-specific properties for an Artifact subclass by overriding the PROPERTIES dictionary, as detailed below.

mlmd_artifact_type Proto message defining the underlying ArtifactType. Optional and intended for internal use.

artifact_type

id Id of underlying artifact.
mlmd_artifact

name Name of the underlying artifact.
pipeline_name Name of the pipeline that produce the artifact.
producer_component Producer component of the artifact.
state State of the underlying artifact.
type

type_id Id of underlying artifact type.
type_name

uri Artifact URI.

Methods

copy_from

View source

copy_from(
    other: "Artifact"
)

Set uri, properties and custom properties from a given Artifact.

from_json_dict

View source

@classmethod
from_json_dict(
    dict_data: Dict[Text, Any]
) -> Any

Convert from dictionary data to an object.

get_float_custom_property

View source

get_float_custom_property(
    key: str
) -> float

Gets a custom property of float type.

get_int_custom_property

View source

get_int_custom_property(
    key: Text
) -> int

Get a custom property of int type.

get_string_custom_property

View source

get_string_custom_property(
    key: Text
) -> Text

Get a custom property of string type.

has_custom_property

View source

has_custom_property(
    key: Text
) -> bool

set_float_custom_property

View source

set_float_custom_property(
    key: str,
    value: float
)

Sets a custom property of float type.

set_int_custom_property

View source

set_int_custom_property(
    key: Text,
    value: int
)

Set a custom property of int type.

set_mlmd_artifact

View source

set_mlmd_artifact(
    artifact: metadata_store_pb2.Artifact
)

Replace the MLMD artifact object on this artifact.

set_mlmd_artifact_type

View source

set_mlmd_artifact_type(
    artifact_type: metadata_store_pb2.ArtifactType
)

Set entire ArtifactType in this object.

set_string_custom_property

View source

set_string_custom_property(
    key: Text,
    value: Text
)

Set a custom property of string type.

to_json_dict

View source

to_json_dict() -> Dict[Text, Any]

Convert from an object to a JSON serializable dictionary.

PROPERTIES None
TYPE_NAME None