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

tfx.dsl.components.base.executor_spec.BeamExecutorSpec

A specification of Beam executor.

Inherits From: ExecutorClassSpec, ExecutorSpec

executor_class a subclass of base_executor.BaseExecutor used to execute this component (required).
extra_flags extra flags to be set in the Python base executor.
beam_pipeline_args arguments for Beam powered Components.
class_path Fully qualified class name for the executor class.

.

Methods

add_beam_pipeline_args

View source

add_extra_flags

View source

copy

View source

Makes a copy of the ExecutorSpec.

An abstract method to implement to make a copy of the ExecutorSpec instance. Deepcopy is preferred in the implementation. But if for any reason a deepcopy is not able to be made because of some fields are not deepcopyable, it is OK to make a shallow copy as long as the subfield is consider globally immutable.

Returns
A copy of ExecutorSpec.

encode

View source

Encodes ExecutorSpec into an IR proto for compiling.

This method will be used by DSL compiler to generate the corresponding IR.

Args
component_spec Optional. The ComponentSpec to help with the encoding.

Returns
An executor spec proto.