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

tfx.dsl.components.base.base_component.BaseComponent

Base class for a TFX pipeline component.

Inherits From: BaseNode

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.

spec types.ComponentSpec object for this component instance.
custom_executor_spec Optional custom executor spec overriding the default executor specified in the component attribute.

SPEC_CLASS a subclass of types.ComponentSpec used by this component (required). This is a class level value.
EXECUTOR_SPEC an instance of executor_spec.ExecutorSpec which describes how to execute this component (required). This is a class level value.
DRIVER_CLASS a subclass of base_driver.BaseDriver as a custom driver for this component (optional, defaults to base_driver.BaseDriver). This is a class level value.
spec an instance of SPEC_CLASS. See types.ComponentSpec for more details.
platform_config a protobuf message representing platform config for a component instance.
exec_properties

inputs

outputs Component's output channel dict.

Child Classes

class DRIVER_CLASS

Methods

EXECUTOR_SPEC

View source

SPEC_CLASS

View source

with_platform_config

View source

Attaches a proto-form platform config to a component.

The config will be a per-node platform-specific config.

Args
config platform config to attach to the component.

Returns
the same component itself.