tfx.components.base.base_component.BaseComponent

View source on GitHub

Class BaseComponent

Base class for a TFX pipeline component.

An instance of a subclass of BaseComponent represents the parameters for a single execution of that TFX pipeline component.

All subclasses of BaseComponent must override the SPEC_CLASS field with the ComponentSpec subclass that defines the interface of this component.

Attributes:

  • COMPONENT_NAME: the name of this component, as a string (optional). If not specified, the name of the component class will be used.
  • SPEC_CLASS: a subclass of types.ComponentSpec used by this component (required).
  • EXECUTOR_SPEC: an instance of executor_spec.ExecutorSpec which describes how to execute this component (required).
  • DRIVER_CLASS: a subclass of base_driver.BaseDriver as a custom driver for this component (optional, defaults to base_driver.BaseDriver).

__init__

View source

__init__(
    spec,
    custom_executor_spec=None,
    instance_name=None
)

Initialize a component.

Args:

  • spec: types.ComponentSpec object for this component instance.
  • custom_executor_spec: Optional custom executor spec overriding the default executor specified in the component attribute.
  • instance_name: Optional unique identifying name for this instance of the component in the pipeline. Required if two instances of the same component is used in the pipeline.

Child Classes

class DRIVER_CLASS

Properties

component_id

Component id, unique across all component instances in a pipeline.

If unique name is available, component_id will be: . otherwise, component_id will be:

Returns:

component id.

component_type

downstream_nodes

exec_properties

inputs

outputs

upstream_nodes

Methods

EXECUTOR_SPEC

View source

EXECUTOR_SPEC()

SPEC_CLASS

View source

SPEC_CLASS()

add_downstream_node

View source

add_downstream_node(downstream_node)

add_upstream_node

View source

add_upstream_node(upstream_node)