great_expectations.expectations.core.expect_column_value_z_scores_to_be_less_than
¶
Module Contents¶
Classes¶
|
Expect the Z-scores of a columns values to be less than a given threshold |
-
class
great_expectations.expectations.core.expect_column_value_z_scores_to_be_less_than.
ExpectColumnValueZScoresToBeLessThan
(configuration: Optional[ExpectationConfiguration] = None)¶ Bases:
great_expectations.expectations.expectation.ColumnMapExpectation
Expect the Z-scores of a columns values to be less than a given threshold
expect_column_values_to_be_of_type is a
column_map_expectation
for typed-column backends, and also for PandasExecutionEngine where the column dtype and provided type_ are unambiguous constraints (any dtype except ‘object’ or dtype of ‘object’ with type_ specified as ‘object’).- Args:
column (str): The column name of a numerical column. threshold (number): A maximum Z-score threshold. All column Z-scores that are lower than this threshold will evaluate
successfully.
- Keyword Args:
mostly (None or a float between 0 and 1): Return “success”: True if at least mostly fraction of values match the expectation. For more detail, see mostly. double_sided (boolean): A True of False value indicating whether to evaluate double sidedly.
Example: double_sided = True, threshold = 2 -> Z scores in non-inclusive interval(-2,2) double_sided = False, threshold = 2 -> Z scores in non-inclusive interval (-infinity,2)
- Other Parameters:
- result_format (str or None): Which output mode to use: BOOLEAN_ONLY, BASIC, COMPLETE, or SUMMARY.
For more detail, see result_format.
include_config (boolean): If True, then include the Expectation config as part of the result object. For more detail, see include_config. catch_exceptions (boolean or None): If True, then catch exceptions and include them as part of the result object. For more detail, see catch_exceptions. meta (dict or None): A JSON-serializable dictionary (nesting allowed) that will be included in the output without modification. For more detail, see meta.
- Returns:
An ExpectationSuiteValidationResult
Exact fields vary depending on the values passed to result_format and include_config, catch_exceptions, and meta.
-
library_metadata
¶
-
map_metric
= column_values.z_score.under_threshold¶
-
success_keys
= ['threshold', 'double_sided', 'mostly']¶
-
default_kwarg_values
¶
-
args_keys
= ['column', 'threshold']¶
-
validate_configuration
(self, configuration: Optional[ExpectationConfiguration])¶ Validates that a configuration has been set, and sets a configuration if it has yet to be set. Ensures that necessary configuration arguments have been provided for the validation of the expectation.
- Parameters
configuration (OPTIONAL[ExpectationConfiguration]) – An optional Expectation Configuration entry that will be used to configure the expectation
- Returns
True if the configuration has been validated successfully. Otherwise, raises an exception