RegressionErrorDistribution#
- class RegressionErrorDistribution[source]#
Check for systematic error and abnormal shape in the regression error distribution.
The check shows the distribution of the regression error, and enables to set conditions on two of the distribution parameters: Systematic error and Kurtosis value. Kurtosis is a measure of the shape of the distribution, helping us understand if the distribution is significantly “wider” from a normal distribution. Systematic error, otherwise known as the error bias, is the mean prediction error of the model.
- Parameters
- n_top_samplesint , default: 3
amount of samples to show which have the largest under / over estimation errors.
- n_binsint , default: 40
number of bins to use for the histogram.
- n_samplesint , default: 1_000_000
number of samples to use for this check.
- random_stateint, default: 42
random seed for all check internals.
- __init__(n_top_samples: int = 3, n_bins: int = 40, n_samples: int = 1000000, random_state: int = 42, **kwargs)[source]#
- __new__(*args, **kwargs)#
Methods
Add new condition function to the check. |
|
|
Add condition - require kurtosis value to be greater than the provided threshold. |
|
Add condition - require systematic error (mean error) lower than (max_ratio * RMSE). |
Remove all conditions from this check instance. |
|
Run conditions on given result. |
|
Return check configuration (conditions' configuration not yet supported). |
|
Return check object from a CheckConfig object. |
|
Deserialize check instance from JSON string. |
|
Return check metadata. |
|
Name of class in split camel case. |
|
Return parameters to show when printing the check. |
|
Remove given condition by index. |
|
|
Run check. |
Run check. |
|
|
Serialize check instance to JSON string. |
