tfx.v1.types.BaseComponent

Base class for a TFX pipeline component.

Inherits From: BaseNode

tfx.v1.types.BaseComponent(
    spec: types.ComponentSpec,
    custom_executor_spec: Optional[executor_spec.ExecutorSpec] = None
)

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.

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.

Attributes
`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.
`PRE_EXECUTABLE_SPEC`	an optional PythonClassExecutableSpec of pre-execution hook. POST_EXECUTABLE_SPEC an optional PythonClassExecutableSpec of post-execution hook.
`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.
`type_annotation`

Child Classes

EXECUTOR_SPEC()

SPEC_CLASS()

with_node_execution_options(
    node_execution_options: utils.NodeExecutionOptions
) -> typing_extensions.Self

with_platform_config(
    config: message.Message
) -> typing_extensions.Self

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.

Class Variables
POST_EXECUTABLE_SPEC	`None`
PRE_EXECUTABLE_SPEC	`None`