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

tfx.orchestration.portable.execution_publish_utils.register_execution

Registers a new execution in MLMD.

tfx.orchestration.portable.execution_publish_utils.register_execution(
    metadata_handler: tfx.orchestration.metadata.Metadata,
    execution_type: metadata_store_pb2.ExecutionType,
    contexts: Sequence[metadata_store_pb2.Context],
    input_artifacts: Optional[MutableMapping[str, Sequence[types.Artifact]]] = None,
    exec_properties: Optional[Mapping[str, types.Property]] = None
) -> metadata_store_pb2.Execution

Along with the execution:

  • the input artifacts will be linked to the execution.
  • the contexts will be linked to both the execution and its input artifacts.

metadata_handler A handler to access MLMD.
execution_type The type of the execution.
contexts MLMD contexts to associated with the execution.
input_artifacts Input artifacts of the execution. Each artifact will be linked with the execution through an event.
exec_properties Execution properties. Will be attached to the execution.

An MLMD execution that is registered in MLMD, with id populated.