# Release History

## Legend for changelogs

* 🔥 something big that you couldn’t do before.
* 💥 something that you couldn’t do before.
* 📝 a miscellaneous minor improvement.
* 🔨 something that previously didn’t work as documented – or according to reasonable expectations – should now work.
* ❗️ you will need to change your code to have the same effect in the future; or a feature will be removed in the future.

## Version 0.5.1

### [sklift.models](https://www.uplift-modeling.com/en/v0.5.1/api/models/index.html)

* 📝 Add docs page for [ClassTransformationReg](https://www.uplift-modeling.com/en/v0.5.1/api/models/ClassTransformationReg.html) model. 

### [sklift.datasets](https://www.uplift-modeling.com/en/v0.5.1/api/datasets/index.html)

* 🔨 Fix bug in [fetch_x5](https://www.uplift-modeling.com/en/v0.5.1/api/datasets/fetch_x5.html) func.

### [User Guide](https://www.uplift-modeling.com/en/v0.5.1/user_guide/index.html)

* 📝 Add page for [Transformed Outcome](https://www.uplift-modeling.com/en/v0.5.1/user_guide/models/transformed_outcome.html) approach. 


## Version 0.5.0

### [sklift.models](https://www.uplift-modeling.com/en/v0.5.0/api/models/index.html)

* 🔥 Add ClassTransformationReg model by [@mcullan](https://github.com/mcullan) and [@ElisovaIra](https://github.com/ElisovaIra).
* 🔨 Add the ability to process a series with different indexes in the [TwoModels](https://www.uplift-modeling.com/en/v0.5.0/api/models.html#sklift.models.models.TwoModels) by [@flashlight101](https://github.com/flashlight101).

### [sklift.metrics](https://www.uplift-modeling.com/en/v0.5.0/api/index/metrics.html)

* 🔥 Add new metric [Maximum profit uplift measure](https://www.uplift-modeling.com/en/v0.5.0/api/metrics/max_prof_uplift.html) by [@rooti123](https://github.com/rooti123).

### [sklift.datasets](https://www.uplift-modeling.com/en/v0.5.0/api/datasets/index.html)

* 💥 Add checker based on hash for all datasets by [@flashlight101](https://github.com/flashlight101)
* 📝 Add [scheme](https://www.uplift-modeling.com/en/v0.5.0/api/datasets/fetch_x5.html) of x5 dataframes.

### Miscellaneous
* 📝 Improve Chinese tags by [@00helloworld](https://github.com/00helloworld)

## Version 0.4.1

### [sklift.datasets](https://www.uplift-modeling.com/en/v0.4.1/api/datasets/index.html)

* 🔨 Fix bug in dataset links.
* 📝 Add about a company section

## Version 0.4.0

### [sklift.metrics](https://www.uplift-modeling.com/en/v0.4.0/api/index/metrics.html)

* 🔥 Add [make_uplift_scorer](https://www.uplift-modeling.com/en/v0.4.0/api/metrics/make_uplift_scorer.html) function for interacting with the module ``sklearn.model_selection``  by [@wrapper228](https://github.com/wrapper228).
* 🔥 Add new metric [average_squared_deviation](https://www.uplift-modeling.com/en/v0.4.0/api/metrics/average_squared_deviation.html) function by [@Mogby](https://github.com/Mogby).

### [sklift.viz](https://www.uplift-modeling.com/en/v0.4.0/api/viz/index.html)

* 🔥 Added the ability to draw multiple plot on the same graph of [plot_uplift_curve](https://www.uplift-modeling.com/en/v0.4.0/api/viz/plot_uplift_curve.html) function and [plot_qini_curve](https://www.uplift-modeling.com/en/v0.4.0/api/viz/plot_qini_curve.html) function by [@flashlight101](https://github.com/flashlight101).

### [sklift.datasets](https://www.uplift-modeling.com/en/v0.4.0/api/datasets/index.html)

* 💥 Add new dataset [fetch_megafon](https://www.uplift-modeling.com/en/v0.4.0/api/datasets/fetch_megafon.html) function by [@ezhdi](https://github.com/ezhdi).
* 📝 Improve documentation of [sklift.datasets](https://www.uplift-modeling.com/en/v0.4.0/api/datasets/index.html) by [@flashlight101](https://github.com/flashlight101) and [@ezhdi](https://github.com/ezhdi).


### Miscellaneous

* 💥 Add new tutorial [Example of usage model from sklift.models in sklearn.model_selection](https://nbviewer.jupyter.org/github/maks-sh/scikit-uplift/blob/master/notebooks/uplift_model_selection_tutorial.ipynb) by [@wrapper228](https://github.com/wrapper228).
* 💥 Increased test coverage from 30% to 82% by [@flashlight101](https://github.com/flashlight101) and [@Ksyula](https://github.com/Ksyula)
* 📝 Add EDA of available datasets on [Tutorials](https://www.uplift-modeling.com/en/v0.4.0/tutorials.html) page by [@lyutov89](https://github.com/lyutov89), [@ezhdi](https://github.com/ezhdi), [@patpanda94](https://github.com/patpanda94) and [@Ksyula](https://github.com/Ksyula).
* 📝 Imporve ["RetailHero tutorial"](https://nbviewer.jupyter.org/github/maks-sh/scikit-uplift/blob/master/notebooks/RetailHero_EN.ipynb) by [@Ksyula](https://github.com/Ksyula).

## Version 0.3.2

### [sklift.datasets](https://www.uplift-modeling.com/en/v0.3.2/api/datasets/index.html)

* 🔨 Fix bug in [fetch_x5](https://www.uplift-modeling.com/en/v0.3.2/api/datasets/fetch_x5.html) function by [@Muhamob](https://github.com/Muhamob).

### [sklift.metrics](https://www.uplift-modeling.com/en/v0.3.2/api/index/metrics.html)

* 📝 Fix docstring in [uplift_by_percentile](https://www.uplift-modeling.com/en/v0.3.2/api/metrics/uplift_by_percentile.html) function by [@ElisovaIra](https://github.com/ElisovaIra).

### [sklift.viz](https://www.uplift-modeling.com/en/v0.3.2/api/viz/index.html)

* 🔨 Fix bug in [plot_uplift_preds](https://www.uplift-modeling.com/en/v0.3.2/api/viz/plot_uplift_preds.html) function by [@bwbelljr](https://github.com/bwbelljr).

### Miscellaneous

* 📝 Change some images in ["RetailHero tutorial"](https://nbviewer.jupyter.org/github/maks-sh/scikit-uplift/blob/master/notebooks/RetailHero_EN.ipynb).

## Version 0.3.1

### [sklift.datasets](https://www.uplift-modeling.com/en/v0.3.1/api/datasets/index.html)

* 🔨 Fix bugs in [sklift.datasets](https://www.uplift-modeling.com/en/v0.3.1/api/datasets/index.html) 

### [sklift.metrics](https://www.uplift-modeling.com/en/v0.3.1/api/index/metrics.html)

* 📝 Imporve [uplift_by_percentile](https://www.uplift-modeling.com/en/v0.3.1/api/metrics/uplift_by_percentile.html) function by [@ElisovaIra](https://github.com/ElisovaIra).

### Miscellaneous

* 💥 Add tutorial ["Uplift modeling metrics"](https://nbviewer.jupyter.org/github/maks-sh/scikit-uplift/blob/master/notebooks/uplift_metrics_tutorial.ipynb) by [@ElisovaIra](https://github.com/ElisovaIra).

## Version 0.3.0

### [sklift.datasets](https://www.uplift-modeling.com/en/v0.3.0/api/datasets/index.html)

* 🔥 Add [sklift.datasets](https://www.uplift-modeling.com/en/v0.3.0/api/datasets/index.html)  by [@ElisovaIra](https://github.com/ElisovaIra), [@RobbStarkk](https://github.com/RobbStarkk), [@acssar](https://github.com/acssar), [@tankudo](https://github.com/tankudo), [@flashlight101](https://github.com/flashlight101), [@semenova-pd](https://github.com/semenova-pd), [@timfex](https://github.com/timfex)

### [sklift.models](https://www.uplift-modeling.com/en/v0.3.0/api/models/index.html)

* 📝 Add different checkers by [@ElisovaIra](https://github.com/ElisovaIra)

### [sklift.metrics](https://www.uplift-modeling.com/en/v0.3.0/api/metrics/index.html)

* 📝 Add different checkers by [@ElisovaIra](https://github.com/ElisovaIra)

### [sklift.viz](https://www.uplift-modeling.com/en/v0.3.0/api/viz/index.html)

* 📝 Fix conflicting and duplicating default values by [@denniskorablev](https://github.com/denniskorablev)

### [User Guide](https://www.uplift-modeling.com/en/v0.3.0/user_guide/index.html)

* 📝 Fix typos

## Version 0.2.0

### [User Guide](https://www.uplift-modeling.com/en/v0.2.0/user_guide/index.html)

* 🔥 Add [User Guide](https://www.uplift-modeling.com/en/v0.2.0/user_guide/index.html)

### [sklift.models](https://www.uplift-modeling.com/en/v0.2.0/api/models/index.html)

* 💥 Add `treatment interaction` method to [SoloModel](https://www.uplift-modeling.com/en/v0.2.0/api/models/SoloModel.html) approach by [@AdiVarma27](https://github.com/AdiVarma27).

### [sklift.metrics](https://www.uplift-modeling.com/en/v0.2.0/api/index/metrics.html)

* 💥 Add [uplift_by_percentile](https://www.uplift-modeling.com/en/v0.2.0/api/metrics/uplift_by_percentile.html) function by [@ElisovaIra](https://github.com/ElisovaIra).
* 💥 Add [weighted_average_uplift](https://www.uplift-modeling.com/en/v0.2.0/api/metrics/weighted_average_uplift.html) function by [@ElisovaIra](https://github.com/ElisovaIra).
* 💥 Add [perfect_uplift_curve](https://www.uplift-modeling.com/en/v0.2.0/api/metrics/perfect_uplift_curve.html) function.
* 💥 Add [perfect_qini_curve](https://www.uplift-modeling.com/en/v0.2.0/api/metrics/perfect_qini_curve.html) function.
* 🔨 Add normalization in [uplift_auc_score](https://www.uplift-modeling.com/en/v0.2.0/api/metrics/uplift_auc_score.html) and [qini_auc_score](https://www.uplift-modeling.com/en/v0.2.0/api/metrics/qini_auc_score.html) functions.
* ❗ Remove metrics `auuc` and `auqc`. In exchange for them use respectively [uplift_auc_score](https://www.uplift-modeling.com/en/v0.2.0/api/metrics/uplift_auc_score.html) and [qini_auc_score](https://www.uplift-modeling.com/en/v0.2.0/api/metrics/qini_auc_score.html)

### [sklift.viz](https://www.uplift-modeling.com/en/v0.2.0/api/viz/index.html)

* 💥 Add [plot_uplift_curve](https://www.uplift-modeling.com/en/v0.2.0/api/viz/plot_uplift_curve.html) function.
* 💥 Add [plot_qini_curve](https://www.uplift-modeling.com/en/v0.2.0/api/viz/plot_qini_curve.html) function.
* ❗ Remove `plot_uplift_qini_curves`.

### Miscellaneous

* 💥 Add contributors in main Readme and in main page of docs.
* 💥 Add [contributing guide](https://www.uplift-modeling.com/en/v0.2.0/contributing.html).
* 💥 Add [code of conduct](https://github.com/maks-sh/scikit-uplift/blob/master/.github/CODE_OF_CONDUCT.md).
* 📝 Reformat [Tutorials](https://www.uplift-modeling.com/en/v0.2.0/tutorials.html) page.
* 📝 Add github buttons in docs.
* 📝 Add logo compatibility with pypi.

## Version 0.1.2

### [sklift.models](https://www.uplift-modeling.com/en/v0.1.2/api/models.html)

* 🔨 Fix bugs in [TwoModels](https://www.uplift-modeling.com/en/v0.1.2/api/models.html#sklift.models.models.TwoModels) for regression problem.
* 📝 Minor code refactoring.

### [sklift.metrics](https://www.uplift-modeling.com/en/v0.1.2/api/metrics.html)

* 📝 Minor code refactoring.

### [sklift.viz](https://www.uplift-modeling.com/en/v0.1.2/api/viz.html)

* 💥 Add bar plot in [plot_uplift_by_percentile](https://www.uplift-modeling.com/en/v0.1.2/api/viz.html#sklift.viz.base.plot_uplift_by_percentile) by [@ElisovaIra](https://github.com/ElisovaIra).
* 🔨 Fix bug in [plot_uplift_by_percentile](https://www.uplift-modeling.com/en/v0.1.2/api/viz.html#sklift.viz.base.plot_uplift_by_percentile).
* 📝 Minor code refactoring.

## Version 0.1.1

### [sklift.viz](https://www.uplift-modeling.com/en/v0.1.1/api/viz.html)

* 💥 Add [plot_uplift_by_percentile](https://www.uplift-modeling.com/en/v0.1.1/api/viz.html#sklift.viz.base.plot_uplift_by_percentile) by [@ElisovaIra](https://github.com/ElisovaIra).
* 🔨 Fix bug with import [plot_treatment_balance_curve](https://www.uplift-modeling.com/en/v0.1.1/api/viz.html#sklift.viz.base.plot_treatment_balance_curve).

### [sklift.metrics](https://www.uplift-modeling.com/en/v0.1.1/api/metrics.html)

* 💥 Add [response_rate_by_percentile](https://www.uplift-modeling.com/en/v0.1.1/api/viz.html#sklift.metrics.metrics.response_rate_by_percentile) by [@ElisovaIra](https://github.com/ElisovaIra).
* 🔨 Fix bug with import [uplift_auc_score](https://www.uplift-modeling.com/en/v0.1.1/api/metrics.html#sklift.metrics.metrics.uplift_auc_score) and [qini_auc_score](https://www.uplift-modeling.com/en/v0.1.1/metrics.html#sklift.metrics.metrics.qini_auc_score).
* 📝 Fix typos in docstrings.

### Miscellaneous

* 💥 Add tutorial ["Example of usage model from sklift.models in sklearn.pipeline"](https://nbviewer.jupyter.org/github/maks-sh/scikit-uplift/blob/master/notebooks/pipeline_usage_EN.ipynb).
* 📝 Add link to Release History in main Readme.md.

## Version 0.1.0

### [sklift.models](https://www.uplift-modeling.com/en/v0.1.0/api/models.html)

* 📝 Fix typo in [TwoModels](https://www.uplift-modeling.com/en/v0.1.0/api/models.html#sklift.models.models.TwoModels) docstring by [@spiaz](https://github.com/spiaz).
* 📝 Improve docstrings and add references to all approaches.

### [sklift.metrics](https://www.uplift-modeling.com/en/v0.1.0/api/metrics.html)

* 💥 Add [treatment_balance_curve](https://www.uplift-modeling.com/en/v0.1.0/api/metrics.html#sklift.metrics.metrics.treatment_balance_curve) by [@spiaz](https://github.com/spiaz).
* ❗️ The metrics `auuc` and `auqc` are now respectively renamed to [uplift_auc_score](https://www.uplift-modeling.com/en/v0.1.0/api/metrics.html#sklift.metrics.metrics.uplift_auc_score) and [qini_auc_score](https://www.uplift-modeling.com/en/v0.1.0/metrics.html#sklift.metrics.metrics.qini_auc_score). So, `auuc` and `auqc` will be removed in 0.2.0.
* ❗️ Add a new parameter `startegy` in [uplift_at_k](https://www.uplift-modeling.com/en/v0.1.0/metrics.html#sklift.metrics.metrics.uplift_at_k).

### [sklift.viz](https://www.uplift-modeling.com/en/v0.1.0/api/viz.html)

* 💥 Add [plot_treatment_balance_curve](https://www.uplift-modeling.com/en/v0.1.0/api/viz.html#sklift.viz.base.plot_treatment_balance_curve) by [@spiaz](https://github.com/spiaz).
* 📝 fix typo in [plot_uplift_qini_curves](https://www.uplift-modeling.com/en/v0.1.0/api/viz.html#sklift.viz.base.plot_uplift_qini_curves) by [@spiaz](https://github.com/spiaz).

### Miscellaneous

* ❗️ Remove sklift.preprocess submodule.
* 💥 Add compatibility of tutorials with colab and add colab buttons by [@ElMaxuno](https://github.com/ElMaxuno).
* 💥 Add Changelog.
* 📝 Change the documentation structure. Add next pages: [Tutorials](https://www.uplift-modeling.com/en/v0.1.0/tutorials.html), [Release History](https://www.uplift-modeling.com/en/v0.1.0/changelog.html) and [Hall of fame](https://www.uplift-modeling.com/en/v0.1.0/hall_of_fame.html).