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.4.0

sklift.metrics

• 🔥 Add make_uplift_scorer function for interacting with the module sklearn.model_selection by @wrapper228.

• 🔥 Add new metric average_squared_deviation function by @Mogby.

sklift.viz

• 🔥 Added the ability to draw multiple plot on the same graph of plot_uplift_curve function and plot_qini_curve function by @flashlight101.

sklift.datasets

• 💥 Add new dataset fetch_megafon function by @ezhdi.

• 📝 Improve documentation of sklift.datasets by @flashlight101 and @ezhdi.

Miscellaneous

• 💥 Add new tutorial Example of usage model from sklift.models in sklearn.model_selection by @wrapper228.

• 💥 Increased test coverage from 30% to 82% by @flashlight101 and @Ksyula

• 📝 Add EDA of available datasets on Tutorials page by @lyutov89, @ezhdi, @patpanda94 and @Ksyula.

• 📝 Imporve “RetailHero tutorial” by @Ksyula.

Version 0.3.2

sklift.datasets

• 🔨 Fix bug in fetch_x5 function by @Muhamob.

sklift.metrics

• 📝 Fix docstring in uplift_by_percentile function by @ElisovaIra.

sklift.viz

• 🔨 Fix bug in plot_uplift_preds function by @bwbelljr.

Miscellaneous

• 📝 Change some images in “RetailHero tutorial”.

Version 0.3.1

sklift.datasets

• 🔨 Fix bugs in sklift.datasets

sklift.metrics

• 📝 Imporve uplift_by_percentile function by @ElisovaIra.

Miscellaneous

• 💥 Add tutorial “Uplift modeling metrics” by @ElisovaIra.

Version 0.3.0

sklift.datasets

• 🔥 Add sklift.datasets by @ElisovaIra, @RobbStarkk, @acssar, @tankudo, @flashlight101, @semenova-pd, @timfex

sklift.models

• 📝 Add different checkers by @ElisovaIra

sklift.metrics

• 📝 Add different checkers by @ElisovaIra

sklift.viz

• 📝 Fix conflicting and duplicating default values by @denniskorablev

User Guide

• 📝 Fix typos

Version 0.2.0

User Guide

• 🔥 Add User Guide

sklift.models

• 💥 Add treatment interaction method to SoloModel approach by @AdiVarma27.

sklift.metrics

• 💥 Add uplift_by_percentile function by @ElisovaIra.

• 💥 Add weighted_average_uplift function by @ElisovaIra.

• 💥 Add perfect_uplift_curve function.

• 💥 Add perfect_qini_curve function.

• 🔨 Add normalization in uplift_auc_score and qini_auc_score functions.

• ❗ Remove metrics auuc and auqc. In exchange for them use respectively uplift_auc_score and qini_auc_score

sklift.viz

• 💥 Add plot_uplift_curve function.

• 💥 Add plot_qini_curve function.

• ❗ Remove plot_uplift_qini_curves.

Miscellaneous

• 💥 Add contributors in main Readme and in main page of docs.

• 💥 Add contributing guide.

• 💥 Add code of conduct.

• 📝 Reformat Tutorials page.

• 📝 Add github buttons in docs.

• 📝 Add logo compatibility with pypi.

Version 0.1.2

sklift.models

• 🔨 Fix bugs in TwoModels for regression problem.

• 📝 Minor code refactoring.

sklift.metrics

• 📝 Minor code refactoring.

sklift.viz

• 💥 Add bar plot in plot_uplift_by_percentile by @ElisovaIra.

• 🔨 Fix bug in plot_uplift_by_percentile.

• 📝 Minor code refactoring.

Version 0.1.1

sklift.viz

• 💥 Add plot_uplift_by_percentile by @ElisovaIra.

• 🔨 Fix bug with import plot_treatment_balance_curve.

sklift.metrics

• 💥 Add response_rate_by_percentile by @ElisovaIra.

• 🔨 Fix bug with import uplift_auc_score and qini_auc_score.

• 📝 Fix typos in docstrings.

Miscellaneous

• 💥 Add tutorial “Example of usage model from sklift.models in sklearn.pipeline”.

• 📝 Add link to Release History in main Readme.md.

Version 0.1.0

sklift.models

• 📝 Fix typo in TwoModels docstring by @spiaz.

• 📝 Improve docstrings and add references to all approaches.

sklift.metrics

• 💥 Add treatment_balance_curve by @spiaz.

• ❗️ The metrics auuc and auqc are now respectively renamed to uplift_auc_score and qini_auc_score. So, auuc and auqc will be removed in 0.2.0.

• ❗️ Add a new parameter startegy in uplift_at_k.

sklift.viz

• 💥 Add plot_treatment_balance_curve by @spiaz.

• 📝 fix typo in plot_uplift_qini_curves by @spiaz.

Miscellaneous

• ❗️ Remove sklift.preprocess submodule.

• 💥 Add compatibility of tutorials with colab and add colab buttons by @ElMaxuno.

• 💥 Add Changelog.

• 📝 Change the documentation structure. Add next pages: Tutorials, Release History and Hall of fame.