Expect the values in column A to match the predictions of a prophet model based on the timestamp in column B.
expect_column_pair_values_to_match_prophet_date_model
This expectation level is BETA
Contributors:
Tags:
Metrics:
Description
Expect the values in column A to match the predictions of a prophet model based on the timestamp in column B.
expect_column_pair_values_to_match_prophet_date_model is a ColumnPairMapExpectation
Args:
column_A (str):
The name of the timestamp column
column_B (str):
The name of the column containing time series values
model_json (str):
A string containing a JSON-serialized Prophet model
Keyword Args:
mostly (None or a float between 0 and 1):
Successful if at least mostly fraction of values match the expectation.
- For more detail, see mostly.
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.
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:
Exact fields vary depending on the values passed to result_format, include_config, catch_exceptions, and meta.
Notes:
-
-
Prophet is an open source forecasting library created at facebook. For more information, please see the project github page.
-
Want to make your own Expectation or an improvement to this one?
We've put together some great how to guides (including videos) on how to create your own expectations in a flash!
You can see those resources here: Contributor Resources