# evidently.metrics.regression\_performance ## Submodules ## abs\_perc\_error\_in\_time module ### class RegressionAbsPercentageErrorPlot() Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`RegressionAbsPercentageErrorPlotResults`] #### Methods: **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)** ### class RegressionAbsPercentageErrorPlotRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: RegressionAbsPercentageErrorPlot)** **render\_json(obj: RegressionAbsPercentageErrorPlot)** ### class RegressionAbsPercentageErrorPlotResults(current\_scatter: Dict\[str, pandas.core.series.Series], reference\_scatter: Optional\[Dict\[str, pandas.core.series.Series]], x\_name: str) Bases: `object` #### Attributes: **current\_scatter : Dict\[str, Series]** **reference\_scatter : Optional\[Dict\[str, Series]]** **x\_name : str** ## error\_bias\_table module ### class RegressionErrorBiasTable(columns: Optional\[List\[str]] = None, top\_error: Optional\[float] = None) Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`RegressionErrorBiasTableResults`] #### Attributes: **TOP\_ERROR\_DEFAULT = 0.05** **TOP\_ERROR\_MAX = 0.5** **TOP\_ERROR\_MIN = 0** **columns : Optional\[List\[str]]** **top\_error : float** #### Methods: **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)** ### class RegressionErrorBiasTableRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: RegressionErrorBiasTable)** **render\_json(obj: RegressionErrorBiasTable)** ### class RegressionErrorBiasTableResults(top\_error: float, current\_plot\_data: pandas.core.frame.DataFrame, reference\_plot\_data: Optional\[pandas.core.frame.DataFrame], target\_name: str, prediction\_name: str, num\_feature\_names: List\[str], cat\_feature\_names: List\[str], error\_bias: Optional\[dict] = None, columns: Optional\[List\[str]] = None) Bases: `object` #### Attributes: **cat\_feature\_names : List\[str]** **columns : Optional\[List\[str]] = None** **current\_plot\_data : DataFrame** **error\_bias : Optional\[dict] = None** **num\_feature\_names : List\[str]** **prediction\_name : str** **reference\_plot\_data : Optional\[DataFrame]** **target\_name : str** **top\_error : float** ## error\_distribution module ### class RegressionErrorDistribution() Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`RegressionErrorDistributionResults`] #### Methods: **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)** ### class RegressionErrorDistributionRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: RegressionErrorDistribution)** **render\_json(obj: RegressionErrorDistribution)** ### class RegressionErrorDistributionResults(current\_bins: pandas.core.frame.DataFrame, reference\_bins: Optional\[pandas.core.frame.DataFrame]) Bases: `object` #### Attributes: **current\_bins : DataFrame** **reference\_bins : Optional\[DataFrame]** ## error\_in\_time module ### class RegressionErrorPlot() Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`RegressionErrorPlotResults`] #### Methods: **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)** ### class RegressionErrorPlotRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: RegressionErrorPlot)** **render\_json(obj: RegressionErrorPlot)** ### class RegressionErrorPlotResults(current\_scatter: Dict\[str, pandas.core.series.Series], reference\_scatter: Optional\[Dict\[str, pandas.core.series.Series]], x\_name: str) Bases: `object` #### Attributes: **current\_scatter : Dict\[str, Series]** **reference\_scatter : Optional\[Dict\[str, Series]]** **x\_name : str** ## error\_normality module ### class RegressionErrorNormality() Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`RegressionErrorNormalityResults`] #### Methods: **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)** ### class RegressionErrorNormalityRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: RegressionErrorNormality)** **render\_json(obj: RegressionErrorNormality)** ### class RegressionErrorNormalityResults(current\_error: pandas.core.series.Series, reference\_error: Optional\[pandas.core.series.Series]) Bases: `object` #### Attributes: **current\_error : Series** **reference\_error : Optional\[Series]** ## predicted\_and\_actual\_in\_time module ### class RegressionPredictedVsActualPlot() Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`RegressionPredictedVsActualPlotResults`] #### Methods: **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)** ### class RegressionPredictedVsActualPlotRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: RegressionPredictedVsActualPlot)** **render\_json(obj: RegressionPredictedVsActualPlot)** ### class RegressionPredictedVsActualPlotResults(current\_scatter: Dict\[str, pandas.core.series.Series], reference\_scatter: Optional\[Dict\[str, pandas.core.series.Series]], x\_name: str) Bases: `object` #### Attributes: **current\_scatter : Dict\[str, Series]** **reference\_scatter : Optional\[Dict\[str, Series]]** **x\_name : str** ## predicted\_vs\_actual module ### class RegressionPredictedVsActualScatter() Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`RegressionPredictedVsActualScatterResults`] #### Methods: **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)** ### class RegressionPredictedVsActualScatterRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: RegressionPredictedVsActualScatter)** **render\_json(obj: RegressionPredictedVsActualScatter)** ### class RegressionPredictedVsActualScatterResults(current\_scatter: Dict\[str, pandas.core.series.Series], reference\_scatter: Optional\[Dict\[str, pandas.core.series.Series]]) Bases: `object` #### Attributes: **current\_scatter : Dict\[str, Series]** **reference\_scatter : Optional\[Dict\[str, Series]]** ## regression\_dummy\_metric module ### class RegressionDummyMetric() Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`RegressionDummyMetricResults`] #### Attributes: **quality\_metric : RegressionQualityMetric** #### Methods: **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)** ### class RegressionDummyMetricRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: RegressionDummyMetric)** **render\_json(obj: RegressionDummyMetric)** ### class RegressionDummyMetricResults(rmse\_default: float, mean\_abs\_error\_default: float, mean\_abs\_perc\_error\_default: float, abs\_error\_max\_default: float, mean\_abs\_error\_by\_ref: Optional\[float] = None, mean\_abs\_error: Optional\[float] = None, mean\_abs\_perc\_error\_by\_ref: Optional\[float] = None, mean\_abs\_perc\_error: Optional\[float] = None, rmse\_by\_ref: Optional\[float] = None, rmse: Optional\[float] = None, abs\_error\_max\_by\_ref: Optional\[float] = None, abs\_error\_max: Optional\[float] = None) Bases: `object` #### Attributes: **abs\_error\_max : Optional\[float] = None** **abs\_error\_max\_by\_ref : Optional\[float] = None** **abs\_error\_max\_default : float** **mean\_abs\_error : Optional\[float] = None** **mean\_abs\_error\_by\_ref : Optional\[float] = None** **mean\_abs\_error\_default : float** **mean\_abs\_perc\_error : Optional\[float] = None** **mean\_abs\_perc\_error\_by\_ref : Optional\[float] = None** **mean\_abs\_perc\_error\_default : float** **rmse : Optional\[float] = None** **rmse\_by\_ref : Optional\[float] = None** **rmse\_default : float** ## regression\_performance\_metrics module ### class RegressionPerformanceMetrics() Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`RegressionPerformanceMetricsResults`] #### Methods: **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)** **get\_parameters()** ### class RegressionPerformanceMetricsRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: RegressionPerformanceMetrics)** **render\_json(obj: RegressionPerformanceMetrics)** ### class RegressionPerformanceMetricsResults(columns: [DatasetColumns](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.data_operations.DatasetColumns), r2\_score: float, rmse: float, rmse\_default: float, mean\_error: float, me\_default\_sigma: float, me\_hist\_for\_plot: Dict\[str, Union\[pandas.core.series.Series, pandas.core.frame.DataFrame]], mean\_abs\_error: float, mean\_abs\_error\_default: float, mean\_abs\_perc\_error: float, mean\_abs\_perc\_error\_default: float, abs\_error\_max: float, abs\_error\_max\_default: float, error\_std: float, abs\_error\_std: float, abs\_perc\_error\_std: float, error\_normality: dict, underperformance: dict, hist\_for\_plot: Dict\[str, pandas.core.series.Series], vals\_for\_plots: Dict\[str, Dict\[str, pandas.core.series.Series]], error\_bias: Optional\[dict] = None, mean\_error\_ref: Optional\[float] = None, mean\_abs\_error\_ref: Optional\[float] = None, mean\_abs\_perc\_error\_ref: Optional\[float] = None, rmse\_ref: Optional\[float] = None, r2\_score\_ref: Optional\[float] = None, abs\_error\_max\_ref: Optional\[float] = None, underperformance\_ref: Optional\[dict] = None) Bases: `object` #### Attributes: **abs\_error\_max : float** **abs\_error\_max\_default : float** **abs\_error\_max\_ref : Optional\[float] = None** **abs\_error\_std : float** **abs\_perc\_error\_std : float** **columns :** [**DatasetColumns**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.data_operations.DatasetColumns) **error\_bias : Optional\[dict] = None** **error\_normality : dict** **error\_std : float** **hist\_for\_plot : Dict\[str, Series]** **me\_default\_sigma : float** **me\_hist\_for\_plot : Dict\[str, Union\[Series, DataFrame]]** **mean\_abs\_error : float** **mean\_abs\_error\_default : float** **mean\_abs\_error\_ref : Optional\[float] = None** **mean\_abs\_perc\_error : float** **mean\_abs\_perc\_error\_default : float** **mean\_abs\_perc\_error\_ref : Optional\[float] = None** **mean\_error : float** **mean\_error\_ref : Optional\[float] = None** **r2\_score : float** **r2\_score\_ref : Optional\[float] = None** **rmse : float** **rmse\_default : float** **rmse\_ref : Optional\[float] = None** **underperformance : dict** **underperformance\_ref : Optional\[dict] = None** **vals\_for\_plots : Dict\[str, Dict\[str, Series]]** ## regression\_quality module ### class RegressionQualityMetric() Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`RegressionQualityMetricResults`] #### Methods: **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)** ### class RegressionQualityMetricRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: RegressionQualityMetric)** **render\_json(obj: RegressionQualityMetric)** ### class RegressionQualityMetricResults(columns: [DatasetColumns](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.data_operations.DatasetColumns), r2\_score: float, rmse: float, rmse\_default: float, mean\_error: float, me\_default\_sigma: float, me\_hist\_for\_plot: Dict\[str, pandas.core.series.Series], mean\_abs\_error: float, mean\_abs\_error\_default: float, mean\_abs\_perc\_error: float, mean\_abs\_perc\_error\_default: float, abs\_error\_max: float, abs\_error\_max\_default: float, error\_std: float, abs\_error\_std: float, abs\_perc\_error\_std: float, error\_normality: dict, underperformance: dict, hist\_for\_plot: Dict\[str, pandas.core.series.Series], vals\_for\_plots: Dict\[str, Dict\[str, pandas.core.series.Series]], error\_bias: Optional\[dict] = None, mean\_error\_ref: Optional\[float] = None, mean\_abs\_error\_ref: Optional\[float] = None, mean\_abs\_perc\_error\_ref: Optional\[float] = None, rmse\_ref: Optional\[float] = None, r2\_score\_ref: Optional\[float] = None, abs\_error\_max\_ref: Optional\[float] = None, underperformance\_ref: Optional\[dict] = None, error\_std\_ref: Optional\[float] = None, abs\_error\_std\_ref: Optional\[float] = None, abs\_perc\_error\_std\_ref: Optional\[float] = None) Bases: `object` #### Attributes: **abs\_error\_max : float** **abs\_error\_max\_default : float** **abs\_error\_max\_ref : Optional\[float] = None** **abs\_error\_std : float** **abs\_error\_std\_ref : Optional\[float] = None** **abs\_perc\_error\_std : float** **abs\_perc\_error\_std\_ref : Optional\[float] = None** **columns :** [**DatasetColumns**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.utils#evidently.utils.data_operations.DatasetColumns) **error\_bias : Optional\[dict] = None** **error\_normality : dict** **error\_std : float** **error\_std\_ref : Optional\[float] = None** **hist\_for\_plot : Dict\[str, Series]** **me\_default\_sigma : float** **me\_hist\_for\_plot : Dict\[str, Series]** **mean\_abs\_error : float** **mean\_abs\_error\_default : float** **mean\_abs\_error\_ref : Optional\[float] = None** **mean\_abs\_perc\_error : float** **mean\_abs\_perc\_error\_default : float** **mean\_abs\_perc\_error\_ref : Optional\[float] = None** **mean\_error : float** **mean\_error\_ref : Optional\[float] = None** **r2\_score : float** **r2\_score\_ref : Optional\[float] = None** **rmse : float** **rmse\_default : float** **rmse\_ref : Optional\[float] = None** **underperformance : dict** **underperformance\_ref : Optional\[dict] = None** **vals\_for\_plots : Dict\[str, Dict\[str, Series]]** ## top\_error module ### class RegressionTopErrorMetric() Bases: [`Metric`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.Metric)\[`RegressionTopErrorMetricResults`] #### Methods: **calculate(data:** [**InputData**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/api-reference/evidently.metrics/..#evidently.metrics.base_metric.InputData)**)** ### class RegressionTopErrorMetricRenderer(color\_options: Optional\[[ColorOptions](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions)] = None) Bases: [`MetricRenderer`](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.renderers#evidently.renderers.base_renderer.MetricRenderer) #### Attributes: **color\_options :** [**ColorOptions**](https://francesco.gitbook.io/docs.evidentlyai.com/reference/evidently.options#evidently.options.color_scheme.ColorOptions) #### Methods: **render\_html(obj: RegressionTopErrorMetric)** **render\_json(obj: RegressionTopErrorMetric)** ### class RegressionTopErrorMetricResults(curr\_mean\_err\_per\_group: Dict\[str, Dict\[str, float]], curr\_scatter: Dict\[str, Dict\[str, pandas.core.series.Series]], ref\_mean\_err\_per\_group: Optional\[Dict\[str, Dict\[str, float]]], ref\_scatter: Optional\[Dict\[str, Dict\[str, pandas.core.series.Series]]]) Bases: `object` #### Attributes: **curr\_mean\_err\_per\_group : Dict\[str, Dict\[str, float]]** **curr\_scatter : Dict\[str, Dict\[str, Series]]** **ref\_mean\_err\_per\_group : Optional\[Dict\[str, Dict\[str, float]]]** **ref\_scatter : Optional\[Dict\[str, Dict\[str, Series]]]**