Missed TensorFlow Dev Summit? Check out the video playlist. Watch recordings

tfx.components.base.base_component.BaseComponent

View source on GitHub

Base class for a TFX pipeline component.

Inherits From: BaseNode

tfx.components.base.base_component.BaseComponent(
    spec, custom_executor_spec=None, instance_name=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.
  • 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.

Attributes:

  • 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).* component_id: DEPRECATED FUNCTION

  • component_type: DEPRECATED FUNCTION

  • downstream_nodes

  • exec_properties

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

    If instance name is available, node_id will be: . otherwise, node_id will be:

  • inputs

  • outputs

  • type

  • upstream_nodes

Child Classes

class DRIVER_CLASS

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
)

from_json_dict

View source

@classmethod
from_json_dict(
    cls, dict_data
)

Convert from dictionary data to an object.

get_id

View source

@classmethod
get_id(
    cls, instance_name=None
)

Gets the id of a node.

This can be used during pipeline authoring time. For example: from tfx.components import Trainer

resolver = ResolverNode(..., model=Channel( type=Model, producer_component_id=Trainer.get_id('my_trainer')))

Args:

  • instance_name: (Optional) instance name of a node. If given, the instance name will be taken into consideration when generating the id.

Returns:

an id for the node.

to_json_dict

View source

to_json_dict()

Convert from an object to a JSON serializable dictionary.