tfx.components.ResolverNode

Definition for TFX ResolverNode.

Inherits From: BaseNode

View aliases

Main aliases

tfx.components.common_nodes.resolver_node.ResolverNode

tfx.components.ResolverNode(
    instance_name: Text,
    resolver_class: Type[tfx.dsl.resolvers.base_resolver.BaseResolver],
    resolver_configs: Dict[Text, json_utils.JsonableType] = None,
    **kwargs
)

Used in the notebooks

Used in the tutorials
TFX Estimator Component Tutorial TFX Keras Component Tutorial

ResolverNode is a special TFX node which handles special artifact resolution logics that will be used as inputs for downstream nodes.

To use ResolverNode, pass the followings to the ResolverNode constructor: a. name of the ResolverNode instance g. a subclass of BaseResolver c. the configs that will be used to construct an instance of (a) d. channels to resolve with their tag, in the form of kwargs Here is an example:

... example_gen = ImportExampleGen(...) latest_five_examples_resolver = ResolverNode( instance_name='latest_five_examples_resolver', resolver_class=latest_artifacts_resolver.LatestArtifactsResolver, resolver_config={'desired_num_of_artifacts' : 5}, examples=example_gen.outputs['examples']) trainer = MyTrainer( examples=latest_model_resolver.outputs['examples'], user_module=...) ...

Args
instance_name	the name of the ResolverNode instance.
resolver_class	a BaseResolver subclass which contains the artifact resolution logic.
resolver_configs	a dict of key to Jsonable type representing configs that will be used to construct the resolver.
**kwargs	a key -> Channel dict, describing what are the Channels to be resolved. This is set by user through keyword args.

Attributes
_resolver_class	the class of the resolver.
_resolver_configs	the configs that will be used to construct an instance of _resolver_class.
component_id	DEPRECATED FUNCTION Warning: THIS FUNCTION IS DEPRECATED. It will be removed in a future version. Instructions for updating: component_id is deprecated, use id instead
component_type	DEPRECATED FUNCTION Warning: THIS FUNCTION IS DEPRECATED. It will be removed in a future version. Instructions for updating: component_type is deprecated, use type instead
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

Methods

add_downstream_node

View source

add_downstream_node(
    downstream_node
)

Experimental: Add another component that must run after this one.

This method enables task-based dependencies by enforcing execution order for synchronous pipelines on supported platforms. Currently, the supported platforms are Airflow, Beam, and Kubeflow Pipelines.

Note that this API call should be considered experimental, and may not work with asynchronous pipelines, sub-pipelines and pipelines with conditional nodes. We also recommend relying on data for capturing dependencies where possible to ensure data lineage is fully captured within MLMD.

It is symmetric with add_upstream_node.

Args
downstream_node	a component that must run after this node.

add_upstream_node

View source

add_upstream_node(
    upstream_node
)

Experimental: Add another component that must run before this one.

This method enables task-based dependencies by enforcing execution order for synchronous pipelines on supported platforms. Currently, the supported platforms are Airflow, Beam, and Kubeflow Pipelines.

Note that this API call should be considered experimental, and may not work with asynchronous pipelines, sub-pipelines and pipelines with conditional nodes. We also recommend relying on data for capturing dependencies where possible to ensure data lineage is fully captured within MLMD.

It is symmetric with add_downstream_node.

Args
upstream_node	a component that must run before this node.

from_json_dict

View source

@classmethod
from_json_dict(
    dict_data: Dict[Text, Any]
) -> Any

Convert from dictionary data to an object.

get_id

View source

@classmethod
get_id(
    instance_name: Optional[Text] = 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() -> Dict[Text, Any]

Convert from an object to a JSON serializable dictionary.