tfx.v1.components.ExampleValidator

A TFX component to validate input examples.

Inherits From: BaseComponent, BaseNode

tfx.v1.components.ExampleValidator(
    statistics: tfx.v1.types.BaseChannel,
    schema: tfx.v1.types.BaseChannel,
    exclude_splits: Optional[List[str]] = None,
    custom_validation_config: Optional[custom_validation_config_pb2.CustomValidationConfig] = None
)

Used in the notebooks

Used in the tutorials
Licensed under the Apache License, Version 2.0 (the "License"); TFX Estimator Component Tutorial TFX Keras Component Tutorial Data validation using TFX Pipeline and TensorFlow Data Validation Feature Engineering using TFX Pipeline and TensorFlow Transform

The ExampleValidator component uses Tensorflow Data Validation to validate the statistics of some splits on input examples against a schema.

The ExampleValidator component identifies anomalies in training and serving data. The component can be configured to detect different classes of anomalies in the data. It can:

• perform validity checks by comparing data statistics against a schema that codifies expectations of the user.
• run custom validations based on an optional SQL-based config.

Schema Based Example Validation The ExampleValidator component identifies any anomalies in the example data by comparing data statistics computed by the StatisticsGen component against a schema. The schema codifies properties which the input data is expected to satisfy, and is provided and maintained by the user.

Example

# Performs anomaly detection based on statistics and data schema.
validate_stats = ExampleValidator(
    statistics=statistics_gen.outputs['statistics'],
    schema=infer_schema.outputs['schema'])

Component outputs contains:

• anomalies: Channel of type standard_artifacts.ExampleAnomalies.

See the ExampleValidator guide for more details.

Args
statistics	A BaseChannel of type standard_artifacts.ExampleStatistics.
schema	A BaseChannel of type standard_artifacts.Schema. required
exclude_splits	Names of splits that the example validator should not validate. Default behavior (when exclude_splits is set to None) is excluding no splits.
custom_validation_config	Optional configuration for specifying SQL-based custom validations.

Attributes
outputs	Component's output channel dict.

Methods

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