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

tfx.extensions.google_cloud_big_query.example_gen.executor.Executor

Generic TFX BigQueryExampleGen executor.

Inherits From: BaseExampleGenExecutor, BaseBeamExecutor, BaseExecutor

tfx.extensions.google_cloud_big_query.example_gen.executor.Executor(
    context: Optional[tfx.dsl.components.base.base_executor.BaseExecutor.Context] = None
)

Child Classes

class Context

Methods

Do

View source

Do(
    input_dict: Dict[Text, List[types.Artifact]],
    output_dict: Dict[Text, List[types.Artifact]],
    exec_properties: Dict[Text, Any]
) -> None

Take input data source and generates serialized data splits.

The output is intended to be serialized tf.train.Examples or tf.train.SequenceExamples protocol buffer in gzipped TFRecord format, but subclasses can choose to override to write to any serialized records payload into gzipped TFRecord as specified, so long as downstream component can consume it. The format of payload is added to payload_format custom property of the output Example artifact.

Args
input_dict Input dict from input key to a list of Artifacts. Depends on detailed example gen implementation.
output_dict Output dict from output key to a list of Artifacts.

  • examples: splits of serialized records.
exec_properties A dict of execution properties. Depends on detailed example gen implementation.
  • input_base: an external directory containing the data files.
  • input_config: JSON string of example_gen_pb2.Input instance, providing input configuration.
  • output_config: JSON string of example_gen_pb2.Output instance, providing output configuration.
  • output_data_format: Payload format of generated data in output artifact, one of example_gen_pb2.PayloadFormat enum.

    • Returns
    None

    GenerateExamplesByBeam

    View source

    GenerateExamplesByBeam(
    pipeline: beam.Pipeline,
    exec_properties: Dict[Text, Any]
) -> Dict[Text, beam.pvalue.PCollection]

    Converts input source to serialized record splits based on configs.

    Custom ExampleGen executor should provide GetInputSourceToExamplePTransform for converting input split to serialized records. Overriding this 'GenerateExamplesByBeam' method instead if complex logic is need, e.g., custom spliting logic.

    Args
    pipeline Beam pipeline.
    exec_properties A dict of execution properties. Depends on detailed example gen implementation.

    • input_base: an external directory containing the data files.
    • input_config: JSON string of example_gen_pb2.Input instance, providing input configuration.
    • output_config: JSON string of example_gen_pb2.Output instance, providing output configuration.
    • output_data_format: Payload format of generated data in output artifact, one of example_gen_pb2.PayloadFormat enum.

    Returns
    Dict of beam PCollection with split name as key, each PCollection is a single output split that contains serialized records.

    GetInputSourceToExamplePTransform

    View source

    GetInputSourceToExamplePTransform() -> beam.PTransform

    Returns PTransform for BigQuery to TF examples.