diff --git a/Readme.rst b/Readme.rst index 352b386..aab5992 100644 --- a/Readme.rst +++ b/Readme.rst @@ -106,6 +106,8 @@ See the **RetailHero tutorial notebook** (`EN `__. + .. code-block:: python # import approaches @@ -130,6 +132,8 @@ See the **RetailHero tutorial notebook** (`EN `__. + .. code-block:: python # import metrics to evaluate your model @@ -153,6 +157,8 @@ See the **RetailHero tutorial notebook** (`EN `__. + .. code-block:: python # import vizualisation tools diff --git a/docs/changelog.md b/docs/changelog.md index cb5d7af..5d9a6a8 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -8,6 +8,20 @@ * 🔨 something that previously didn’t work as documentated – 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.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) diff --git a/docs/tutorials.rst b/docs/tutorials.rst index adbd775..61ee43e 100644 --- a/docs/tutorials.rst +++ b/docs/tutorials.rst @@ -35,6 +35,19 @@ It is better to start scikit-uplift from the basic tutorials. - `nbviewer `__ - `github `__ +`Uplift modeling metrics`_ +---------------------------------------------------------------------------------- + +.. list-table:: + :align: center + :widths: 12 15 10 8 + + * - In English 🇬🇧 + - |Open In Colab1| + - `nbviewer `__ + - `github `__ + + `Example of usage model from sklift.models in sklearn.pipeline`_ ---------------------------------------------------------------------------------- diff --git a/notebooks/Readme.rst b/notebooks/Readme.rst index adbd775..b2090ab 100644 --- a/notebooks/Readme.rst +++ b/notebooks/Readme.rst @@ -35,6 +35,18 @@ It is better to start scikit-uplift from the basic tutorials. - `nbviewer `__ - `github `__ +`Uplift modeling metrics`_ +---------------------------------------------------------------------------------- + +.. list-table:: + :align: center + :widths: 12 15 10 8 + + * - In English 🇬🇧 + - |Open In Colab1| + - `nbviewer `__ + - `github `__ + `Example of usage model from sklift.models in sklearn.pipeline`_ ---------------------------------------------------------------------------------- diff --git a/notebooks/pipeline_usage_RU.ipynb b/notebooks/pipeline_usage_RU.ipynb index 16892f5..01552cf 100644 --- a/notebooks/pipeline_usage_RU.ipynb +++ b/notebooks/pipeline_usage_RU.ipynb @@ -51,7 +51,7 @@ }, "outputs": [], "source": [ - "# !pip install scikit-uplift xgboost==1.0.2 category_encoders==2.1.0 -U" + "# pip install scikit-uplift xgboost==1.0.2 category_encoders==2.1.0 -U" ] }, { @@ -395,8 +395,17 @@ "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.6.1" + }, + "pycharm": { + "stem_cell": { + "cell_type": "raw", + "source": [], + "metadata": { + "collapsed": false + } + } } }, "nbformat": 4, "nbformat_minor": 2 -} +} \ No newline at end of file diff --git a/notebooks/uplift_metrics_tutorial.ipynb b/notebooks/uplift_metrics_tutorial.ipynb index baa6d90..3b78ef2 100644 --- a/notebooks/uplift_metrics_tutorial.ipynb +++ b/notebooks/uplift_metrics_tutorial.ipynb @@ -4,7 +4,19 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "# 🎯 Uplift modeling `metrics`" + "# 🎯 Uplift modeling `metrics`\n", + "\n", + "
\n", + "
\n", + " \n", + " \n", + " \n", + "
\n", + " SCIKIT-UPLIFT REPO | \n", + " SCIKIT-UPLIFT DOCS | \n", + " USER GUIDE\n", + "
\n", + "
" ] }, { @@ -1508,8 +1520,17 @@ "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.7.1" + }, + "pycharm": { + "stem_cell": { + "cell_type": "raw", + "source": [], + "metadata": { + "collapsed": false + } + } } }, "nbformat": 4, "nbformat_minor": 4 -} +} \ No newline at end of file