Metadata-Version: 2.3
Name: regression-bias-corrector
Version: 0.0.2
Summary: Bias correction of regression ML models
Project-URL: Homepage, https://github.com/mike-live/regression-bias-corrector
Project-URL: Bug Tracker, https://github.com/mike-live/regression-bias-corrector/issues
Author-email: Mikhail Krivonosov <krivonosov@itmm.unn.ru>
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: numpy>=1.15.0
Requires-Dist: pyyaml
Requires-Dist: scikit-learn
Description-Content-Type: text/markdown

# Regression bias corrector

Package is aimed to correct regression fit by any machine learning model that underestimate high values and overestimate low values of outcome variable (1D case). The problem usually arises in case when metrics like MSE and MAE shows better results in biased predictions.

# Algorithm

Now is implemeneted only linear correction for 1D case by the Linear Regression approach.

The idea is to linearly transform the `y_pred` to change the coefficient of linear regression between `y_true` and `y_pred` to 1. It is corresponds to the diagonal on plane `y_true` and `y_pred` that means equal pace of increasing `y_pred` with increasing `y_true`. 
- `y_true` - actual values
- `y_pred` - predicted values


# How to install
```bash
git clone https://github.com/mike-live/regression-bias-corrector.git
pip install .
```

# How to use
```python
# Import Linear Bias corrector
from regression-bias-corrector import LinearBiasCorrector

# Create instance of corrector
corrector = LinearBiasCorrector()

# Fit corrector on actual outcome variable and on predicted values of the model for train dataset
# y_train - actual values
# y_train_pred - predicted values
corrector.fit(y_train, y_train_pred)

# correct predicted values on test dataset
# y_test_pred - predicted values by model on test dataset
y_test_pred_unbiased = corrector.predict(y_test_pred)

# y_test_pred_unbiased - unbiased predicted values on test
```

# Authors
Lobachevsky University

1. Krivonosov Mikhail
2. Khabarova Tatiana
