tfx.v1.dsl.Artifact

TFX artifact used for orchestration.

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

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 Type of the underlying mlmd artifact.
id Id of the underlying mlmd artifact.
is_external Returns true if the artifact is external.
mlmd_artifact Underlying mlmd artifact.
pipeline_name Name of the pipeline that produce the artifact.
state State of the underlying mlmd artifact.
type Type of the artifact.
type_id Type id of the underlying mlmd artifact.
type_name Type name of the underlying mlmd artifact.
uri Artifact URI.

Methods

get_bool_custom_property

get_bool_custom_property(
    key: str
) -> bool

Get a custom property of bool type.

get_custom_property

get_custom_property(
    key: str
) -> Optional[Union[int, float, str, bool, JsonValueType]]

Gets a custom property with key. Return None if not found.

get_float_custom_property

get_float_custom_property(
    key: str
) -> float

Gets a custom property of float type.

get_int_custom_property

get_int_custom_property(
    key: str
) -> int

Get a custom property of int type.

get_string_custom_property

get_string_custom_property(
    key: str
) -> str

Get a custom property of string type.

has_custom_property

has_custom_property(
    key: str
) -> bool

has_property

has_property(
    key: str
) -> bool

set_bool_custom_property

set_bool_custom_property(
    key: str, value: bool
)

Sets a custom property of bool type.

set_float_custom_property

set_float_custom_property(
    key: str, value: float
)

Sets a custom property of float type.

set_int_custom_property

set_int_custom_property(
    key: str, value: int
)

Set a custom property of int type.

set_string_custom_property

set_string_custom_property(
    key: str, value: str
)

Set a custom property of string type.

PROPERTIES None
TYPE_ANNOTATION None
TYPE_NAME None