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

tfx.components.pusher.executor.Executor

TFX Pusher executor to push the new TF model to a filesystem target.

Inherits From: BaseExecutor

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

The Pusher component is used to deploy a validated model to a filesystem target or serving environment using tf.serving. Pusher depends on the outputs of ModelValidator to determine if a model is ready to push. A model is considered to be safe to push only if ModelValidator has marked it as BLESSED. A push action delivers the model exports produced by Trainer to the destination defined in the push_destination of the component config.

To include Pusher in a TFX pipeline, configure your pipeline similar to https://github.com/tensorflow/tfx/blob/master/tfx/examples/chicago_taxi_pipeline/taxi_pipeline_simple.py#L104

For more details on tf.serving itself, please refer to https://tensorflow.org/tfx/guide/pusher For a tutuorial on TF Serving, please refer to https://www.tensorflow.org/tfx/guide/serving

Child Classes

class Context

Methods

CheckBlessing

View source

CheckBlessing(
    input_dict: Dict[Text, List[types.Artifact]]
) -> bool

Check that model is blessed by upstream validators.

Args
input_dict Input dict from input key to a list of artifacts:

  • model_blessing: A ModelBlessing artifact from model validator or evaluator. Pusher looks for a custom property blessed in the artifact to check it is safe to push.
  • infra_blessing: An InfraBlessing artifact from infra validator. Pusher looks for a custom proeprty blessed in the artifact to determine whether the model is mechanically servable from the model server to which Pusher is going to push.

Returns
True if the model is blessed by validator.

Do

View source

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

Push model to target directory if blessed.

Args
input_dict Input dict from input key to a list of artifacts, including:

  • model: exported model from trainer.
  • model_blessing: model blessing path from model_validator. A push action delivers the model exports produced by Trainer to the destination defined in component config.
output_dict Output dict from key to a list of artifacts, including:
  • pushed_model: A list of 'ModelPushPath' artifact of size one. It will include the model in this push execution if the model was pushed.
    • exec_properties A dict of execution properties, including:
  • push_destination: JSON string of pusher_pb2.PushDestination instance, providing instruction of destination to push model.

    • Returns
    None

    GetModelPath

    View source

    GetModelPath(
    input_dict: Dict[Text, List[types.Artifact]]
) -> str

    Get input model path to push.

    Pusher can push various types of artifacts if it contains the model. This method decides which artifact type is given to the Pusher and extracts the real model path. Subclass of Pusher Executor should use this method to acquire the source model path.

    Args
    input_dict A dictionary of artifacts that is given as the fisrt argument to the Executor.Do() method.

    Returns
    A resolved input model path.

    Raises
    RuntimeError If no model path is found from input_dict.