# Metrics


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

------------------------------------------------------------------------

<a
href="https://github.com/mustafaslanCoto/peshbeen/blob/main/peshbeen/metrics.py#L9"
target="_blank" style="float:right; font-size:smaller">source</a>

### MAPE

``` python

def MAPE(
    y_true:ArrayLike, # The actual values.
    y_pred:ArrayLike, # The predicted values.
)->float: # The MAPE value rounded to 2 decimal places.

```

*Calculate the Mean Absolute Percentage Error (MAPE) between actual and
predicted values.*

<table>
<colgroup>
<col style="width: 9%" />
<col style="width: 38%" />
<col style="width: 52%" />
</colgroup>
<thead>
<tr>
<th></th>
<th><strong>Type</strong></th>
<th><strong>Details</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>y_true</td>
<td>ArrayLike</td>
<td>The actual values.</td>
</tr>
<tr>
<td>y_pred</td>
<td>ArrayLike</td>
<td>The predicted values.</td>
</tr>
<tr>
<td><strong>Returns</strong></td>
<td><strong>float</strong></td>
<td><strong>The MAPE value rounded to 2 decimal places.</strong></td>
</tr>
</tbody>
</table>

------------------------------------------------------------------------

<a
href="https://github.com/mustafaslanCoto/peshbeen/blob/main/peshbeen/metrics.py#L40"
target="_blank" style="float:right; font-size:smaller">source</a>

### SMAPE

``` python

def SMAPE(
    y_true:ArrayLike, # The actual values.
    y_pred:ArrayLike, # The predicted values.
)->float: # The SMAPE value rounded to 2 decimal places.

```

*Calculate the Symmetric Mean Absolute Percentage Error (SMAPE) between
actual and predicted values.*

<table>
<colgroup>
<col style="width: 9%" />
<col style="width: 38%" />
<col style="width: 52%" />
</colgroup>
<thead>
<tr>
<th></th>
<th><strong>Type</strong></th>
<th><strong>Details</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>y_true</td>
<td>ArrayLike</td>
<td>The actual values.</td>
</tr>
<tr>
<td>y_pred</td>
<td>ArrayLike</td>
<td>The predicted values.</td>
</tr>
<tr>
<td><strong>Returns</strong></td>
<td><strong>float</strong></td>
<td><strong>The SMAPE value rounded to 2 decimal places.</strong></td>
</tr>
</tbody>
</table>

------------------------------------------------------------------------

<a
href="https://github.com/mustafaslanCoto/peshbeen/blob/main/peshbeen/metrics.py#L71"
target="_blank" style="float:right; font-size:smaller">source</a>

### WMAPE

``` python

def WMAPE(
    y_true:ArrayLike, # The actual values.
    y_pred:ArrayLike, # The predicted values.
)->float: # The WMAPE value.

```

*“* Calculate the Weighted Mean Absolute Percentage Error (WMAPE)
between actual and predicted values.

<table>
<thead>
<tr>
<th></th>
<th><strong>Type</strong></th>
<th><strong>Details</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>y_true</td>
<td>ArrayLike</td>
<td>The actual values.</td>
</tr>
<tr>
<td>y_pred</td>
<td>ArrayLike</td>
<td>The predicted values.</td>
</tr>
<tr>
<td><strong>Returns</strong></td>
<td><strong>float</strong></td>
<td><strong>The WMAPE value.</strong></td>
</tr>
</tbody>
</table>

------------------------------------------------------------------------

<a
href="https://github.com/mustafaslanCoto/peshbeen/blob/main/peshbeen/metrics.py#L99"
target="_blank" style="float:right; font-size:smaller">source</a>

### MAE

``` python

def MAE(
    y_true:ArrayLike, # The actual values.
    y_pred:ArrayLike, # The predicted values.
)->float: # The MAE value.

```

*Calculate mean absolute error (MAE).*

<table>
<thead>
<tr>
<th></th>
<th><strong>Type</strong></th>
<th><strong>Details</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>y_true</td>
<td>ArrayLike</td>
<td>The actual values.</td>
</tr>
<tr>
<td>y_pred</td>
<td>ArrayLike</td>
<td>The predicted values.</td>
</tr>
<tr>
<td><strong>Returns</strong></td>
<td><strong>float</strong></td>
<td><strong>The MAE value.</strong></td>
</tr>
</tbody>
</table>

------------------------------------------------------------------------

<a
href="https://github.com/mustafaslanCoto/peshbeen/blob/main/peshbeen/metrics.py#L126"
target="_blank" style="float:right; font-size:smaller">source</a>

### MSE

``` python

def MSE(
    y_true:ArrayLike, # The actual values.
    y_pred:ArrayLike, # The predicted values.
)->float: # The MSE value.

```

*Calculate mean squared error (MSE).*

<table>
<thead>
<tr>
<th></th>
<th><strong>Type</strong></th>
<th><strong>Details</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>y_true</td>
<td>ArrayLike</td>
<td>The actual values.</td>
</tr>
<tr>
<td>y_pred</td>
<td>ArrayLike</td>
<td>The predicted values.</td>
</tr>
<tr>
<td><strong>Returns</strong></td>
<td><strong>float</strong></td>
<td><strong>The MSE value.</strong></td>
</tr>
</tbody>
</table>

------------------------------------------------------------------------

<a
href="https://github.com/mustafaslanCoto/peshbeen/blob/main/peshbeen/metrics.py#L155"
target="_blank" style="float:right; font-size:smaller">source</a>

### RMSE

``` python

def RMSE(
    y_true:ArrayLike, # The actual values.
    y_pred:ArrayLike, # The predicted values.
)->float: # The RMSE value.

```

*Calculate Root Mean Square Error (RMSE).*

<table>
<thead>
<tr>
<th></th>
<th><strong>Type</strong></th>
<th><strong>Details</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>y_true</td>
<td>ArrayLike</td>
<td>The actual values.</td>
</tr>
<tr>
<td>y_pred</td>
<td>ArrayLike</td>
<td>The predicted values.</td>
</tr>
<tr>
<td><strong>Returns</strong></td>
<td><strong>float</strong></td>
<td><strong>The RMSE value.</strong></td>
</tr>
</tbody>
</table>

------------------------------------------------------------------------

<a
href="https://github.com/mustafaslanCoto/peshbeen/blob/main/peshbeen/metrics.py#L186"
target="_blank" style="float:right; font-size:smaller">source</a>

### SRMSE

``` python

def SRMSE(
    y_true:ArrayLike, # The actual values.
    y_pred:ArrayLike, # The predicted values.
    y_train:ArrayLike, # The training values used for scaling.
)->float: # The SRMSE value.

```

*Calculate Scaled Root Mean Square Error (SRMSE).*

<table>
<thead>
<tr>
<th></th>
<th><strong>Type</strong></th>
<th><strong>Details</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>y_true</td>
<td>ArrayLike</td>
<td>The actual values.</td>
</tr>
<tr>
<td>y_pred</td>
<td>ArrayLike</td>
<td>The predicted values.</td>
</tr>
<tr>
<td>y_train</td>
<td>ArrayLike</td>
<td>The training values used for scaling.</td>
</tr>
<tr>
<td><strong>Returns</strong></td>
<td><strong>float</strong></td>
<td><strong>The SRMSE value.</strong></td>
</tr>
</tbody>
</table>

------------------------------------------------------------------------

<a
href="https://github.com/mustafaslanCoto/peshbeen/blob/main/peshbeen/metrics.py#L222"
target="_blank" style="float:right; font-size:smaller">source</a>

### RMSSE

``` python

def RMSSE(
    y_true:ArrayLike, # The actual values.
    y_pred:ArrayLike, # The predicted values.
    y_train:ArrayLike, # The training values used for scaling.
)->float: # The RMSSE value.

```

*Calculate Root Mean Squared Scaled Error (RMSSE).*

<table>
<thead>
<tr>
<th></th>
<th><strong>Type</strong></th>
<th><strong>Details</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>y_true</td>
<td>ArrayLike</td>
<td>The actual values.</td>
</tr>
<tr>
<td>y_pred</td>
<td>ArrayLike</td>
<td>The predicted values.</td>
</tr>
<tr>
<td>y_train</td>
<td>ArrayLike</td>
<td>The training values used for scaling.</td>
</tr>
<tr>
<td><strong>Returns</strong></td>
<td><strong>float</strong></td>
<td><strong>The RMSSE value.</strong></td>
</tr>
</tbody>
</table>

------------------------------------------------------------------------

<a
href="https://github.com/mustafaslanCoto/peshbeen/blob/main/peshbeen/metrics.py#L258"
target="_blank" style="float:right; font-size:smaller">source</a>

### MASE

``` python

def MASE(
    y_true:ArrayLike, # The actual values.
    y_pred:ArrayLike, # The predicted values.
    y_train:ArrayLike, # The training values used for scaling.
)->float: # The MASE value.

```

*Calculate Mean Absolute Scaled Error (MASE)*

<table>
<thead>
<tr>
<th></th>
<th><strong>Type</strong></th>
<th><strong>Details</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>y_true</td>
<td>ArrayLike</td>
<td>The actual values.</td>
</tr>
<tr>
<td>y_pred</td>
<td>ArrayLike</td>
<td>The predicted values.</td>
</tr>
<tr>
<td>y_train</td>
<td>ArrayLike</td>
<td>The training values used for scaling.</td>
</tr>
<tr>
<td><strong>Returns</strong></td>
<td><strong>float</strong></td>
<td><strong>The MASE value.</strong></td>
</tr>
</tbody>
</table>

------------------------------------------------------------------------

<a
href="https://github.com/mustafaslanCoto/peshbeen/blob/main/peshbeen/metrics.py#L301"
target="_blank" style="float:right; font-size:smaller">source</a>

### CFE

``` python

def CFE(
    y_true:ArrayLike, # The actual values.
    y_pred:ArrayLike, # The predicted values.
)->float:

```

*Calculate Cumulative Forecast Error (CFE). It is the cumulative sum of
the differences between actual and predicted values.*

<table>
<thead>
<tr>
<th></th>
<th><strong>Type</strong></th>
<th><strong>Details</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>y_true</td>
<td>ArrayLike</td>
<td>The actual values.</td>
</tr>
<tr>
<td>y_pred</td>
<td>ArrayLike</td>
<td>The predicted values.</td>
</tr>
<tr>
<td><strong>Returns</strong></td>
<td><strong>float</strong></td>
<td></td>
</tr>
</tbody>
</table>

------------------------------------------------------------------------

<a
href="https://github.com/mustafaslanCoto/peshbeen/blob/main/peshbeen/metrics.py#L324"
target="_blank" style="float:right; font-size:smaller">source</a>

### CFE_ABS

``` python

def CFE_ABS(
    y_true:ArrayLike, # The actual values.
    y_pred:ArrayLike, # The predicted values.
)->float: # The absolute CFE value.

```

*Calculate Absolute Cumulative Forecast Error (CFE_ABS). It is the
absolute value of the cumulative sum of the differences between actual
and predicted values.*

<table>
<thead>
<tr>
<th></th>
<th><strong>Type</strong></th>
<th><strong>Details</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>y_true</td>
<td>ArrayLike</td>
<td>The actual values.</td>
</tr>
<tr>
<td>y_pred</td>
<td>ArrayLike</td>
<td>The predicted values.</td>
</tr>
<tr>
<td><strong>Returns</strong></td>
<td><strong>float</strong></td>
<td><strong>The absolute CFE value.</strong></td>
</tr>
</tbody>
</table>
