tfx.v1.components.ImportExampleGen

Official TFX ImportExampleGen component.

Inherits From: BaseBeamComponent, BaseComponent, BaseNode

tfx.v1.components.ImportExampleGen(
    input_base: Optional[str] = None,
    input_config: Optional[Union[tfx.v1.proto.Input, tfx.v1.dsl.experimental.RuntimeParameter]] = None,
    output_config: Optional[Union[tfx.v1.proto.Output, tfx.v1.dsl.experimental.RuntimeParameter]] = None,
    range_config: Optional[Union[tfx.v1.proto.RangeConfig, tfx.v1.dsl.experimental.RuntimeParameter]] = None,
    payload_format: Optional[int] = example_gen_pb2.FORMAT_TF_EXAMPLE
)

The ImportExampleGen component takes TFRecord files with TF Example data format, and generates train and eval examples for downstream components. This component provides consistent and configurable partition, and it also shuffle the dataset for ML best practice.

Component outputs contains:

• examples: Channel of type standard_artifacts.Examples for output train and eval examples.

Args
input_base	an external directory containing the TFRecord files.
input_config	An example_gen_pb2.Input instance, providing input configuration. If unset, the files under input_base will be treated as a single split.
output_config	An example_gen_pb2.Output instance, providing output configuration. If unset, default splits will be 'train' and 'eval' with size 2:1.
range_config	An optional range_config_pb2.RangeConfig instance, specifying the range of span values to consider. If unset, driver will default to searching for latest span with no restrictions.
payload_format	Payload format of input data. Should be one of example_gen_pb2.PayloadFormat enum. Note that payload format of output data is the same as input.

Attributes
outputs	Component's output channel dict.

Methods

with_beam_pipeline_args

with_beam_pipeline_args(
    beam_pipeline_args: Iterable[Union[str, placeholder.Placeholder]]
) -> 'BaseBeamComponent'

Add per component Beam pipeline args.

Args
beam_pipeline_args	List of Beam pipeline args to be added to the Beam executor spec.

Returns
the same component itself.

with_node_execution_options

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

Class Variables
POST_EXECUTABLE_SPEC	None
PRE_EXECUTABLE_SPEC	None