tfx.v1.types.BaseNode

Base class for a node in TFX pipeline.

tfx.v1.types.BaseNode(
    executor_spec: Optional[executor_spec_module.ExecutorSpec] = None,
    driver_class: Optional[Type[base_driver.BaseDriver]] = None
)

executor_spec Optional instance of executor_spec.ExecutorSpec which describes how to execute this node (optional, defaults to an empty executor indicates no-op.
driver_class Optional subclass of base_driver.BaseDriver as a custom driver for this node (optional, defaults to base_driver.BaseDriver). Nodes usually use the default driver class, but may override it.

component_id

component_type

downstream_nodes

exec_properties

id Node id, unique across all TFX nodes in a pipeline.

If id is set by the user, return it directly. Otherwise, return .

inputs

node_execution_options

outputs

type

upstream_nodes

Methods

add_downstream_node

add_downstream_node(
    downstream_node
)

This method enables task-based dependencies by enforcing execution order for synchronous pipelines on supported platforms. Currently, the supported platforms are Airflow, Beam, and Kubeflow Pipelines.

Note that this API call should be considered experimental, and may not work with asynchronous pipelines, sub-pipelines and pipelines with conditional nodes. We also recommend relying on data for capturing dependencies where possible to ensure data lineage is fully captured within MLMD.

It is symmetric with add_upstream_node.

Args
downstream_node a component that must run after this node.

add_downstream_nodes

add_downstream_nodes(
    downstream_nodes
)

This method enables task-based dependencies by enforcing execution order for synchronous pipelines on supported platforms. Currently, the supported platforms are Airflow, Beam, and Kubeflow Pipelines.

Note that this API call should be considered experimental, and may not work with asynchronous pipelines, sub-pipelines and pipelines with conditional nodes. We also recommend relying on data for capturing dependencies where possible to ensure data lineage is fully captured within MLMD.

It is symmetric with add_upstream_nodes.

Args
downstream_nodes a list of components that must run after this node.

add_upstream_node

add_upstream_node(
    upstream_node
)

This method enables task-based dependencies by enforcing execution order for synchronous pipelines on supported platforms. Currently, the supported platforms are Airflow, Beam, and Kubeflow Pipelines.

Note that this API call should be considered experimental, and may not work with asynchronous pipelines, sub-pipelines and pipelines with conditional nodes. We also recommend relying on data for capturing dependencies where possible to ensure data lineage is fully captured within MLMD.

It is symmetric with add_downstream_node.

Args
upstream_node a component that must run before this node.

add_upstream_nodes

add_upstream_nodes(
    upstream_nodes
)

This method enables task-based dependencies by enforcing execution order for synchronous pipelines on supported platforms. Currently, the supported platforms are Airflow, Beam, and Kubeflow Pipelines.

Note that this API call should be considered experimental, and may not work with asynchronous pipelines, sub-pipelines and pipelines with conditional nodes. We also recommend relying on data for capturing dependencies where possible to ensure data lineage is fully captured within MLMD.

Args
upstream_nodes a list of components that must run before this node.

get_class_type

@classmethod
get_class_type() -> str

remove_downstream_node

remove_downstream_node(
    downstream_node
)

remove_upstream_node

remove_upstream_node(
    upstream_node
)

with_id

with_id(
    id: str
) -> 'BaseNode'