tfx.orchestration.experimental.core.pipeline_state.PipelineState

Class for dealing with pipeline state. Can be used as a context manager.

tfx.orchestration.experimental.core.pipeline_state.PipelineState(
    mlmd_handle: tfx.orchestration.metadata.Metadata,
    pipeline_uid: tfx.orchestration.experimental.core.task.PipelineUid,
    context: metadata_store_pb2.Context,
    execution: metadata_store_pb2.Execution,
    commit: bool = False
)

Attributes
`pipeline`

Attributes

pipeline

Methods

`commit`

View source

commit() -> None

Commits pipeline state to MLMD if there are any mutations.

`initiate_node_start`

View source

initiate_node_start(
    node_uid: tfx.orchestration.experimental.core.task.NodeUid
) -> None

Updates pipeline state to signal that a node should be started.

`initiate_node_stop`

View source

initiate_node_stop(
    node_uid: tfx.orchestration.experimental.core.task.NodeUid,
    status: tfx.orchestration.experimental.core.status.Status
) -> None

Updates pipeline state to signal that a node should be stopped.

`initiate_stop`

View source

initiate_stop(
    status: tfx.orchestration.experimental.core.status.Status
) -> None

Updates pipeline state to signal stopping pipeline execution.

`load`

View source

@classmethod
load(
    mlmd_handle: tfx.orchestration.metadata.Metadata,
    pipeline_uid: tfx.orchestration.experimental.core.task.PipelineUid
) -> "PipelineState"

Loads pipeline state from MLMD.

Args
`mlmd_handle`	A handle to the MLMD db.
`pipeline_uid`	Uid of the pipeline state to load.

Returns
A `PipelineState` object.

Raises
`status_lib.StatusNotOkError`	With code=NOT_FOUND if no active pipeline with the given pipeline uid exists in MLMD. With code=INTERNAL if more than 1 active execution exists for given pipeline uid.

`load_from_orchestrator_context`

View source

@classmethod
load_from_orchestrator_context(
    mlmd_handle: tfx.orchestration.metadata.Metadata,
    context: metadata_store_pb2.Context
) -> "PipelineState"

Loads pipeline state for active pipeline under given orchestrator context.

Args
`mlmd_handle`	A handle to the MLMD db.
`context`	Pipeline context under which to find the pipeline execution.

Returns
A `PipelineState` object.

Raises
`status_lib.StatusNotOkError`	With code=NOT_FOUND if no active pipeline exists for the given context in MLMD. With code=INTERNAL if more than 1 active execution exists for given pipeline uid.

`new`

View source

@classmethod
new(
    mlmd_handle: tfx.orchestration.metadata.Metadata,
    pipeline: pipeline_pb2.Pipeline
) -> "PipelineState"

Creates a PipelineState object for a new pipeline.

No active pipeline with the same pipeline uid should exist for the call to be successful.

Args
`mlmd_handle`	A handle to the MLMD db.
`pipeline`	IR of the pipeline.

Returns
A `PipelineState` object.

Raises
`status_lib.StatusNotOkError`	If a pipeline with same UID already exists.

`node_stop_initiated_reason`

View source

node_stop_initiated_reason(
    node_uid: tfx.orchestration.experimental.core.task.NodeUid
) -> Optional[tfx.orchestration.experimental.core.status.Status]

Returns status object if node stop initiated, None otherwise.

`remove_property`

View source

remove_property(
    property_key: str
) -> None

Removes a custom property of the pipeline execution if exists.

`save_property`

View source

save_property(
    property_key: str,
    property_value: str
) -> None

Saves a custom property to the pipeline execution.

`stop_initiated_reason`

View source

stop_initiated_reason() -> Optional[tfx.orchestration.experimental.core.status.Status]

Returns status object if stop initiated, None otherwise.

`update_pipeline_execution_state`

View source

update_pipeline_execution_state(
    status: tfx.orchestration.experimental.core.status.Status
) -> None

`enter`

View source

__enter__() -> "PipelineState"

`exit`

View source

__exit__(
    exc_type, exc_val, exc_tb
)