📗 Fix docs (#83)

* 📗 Add links in Readme

* 📁 Small fixes in notebooks

* 📗 Add links in tutorial page

* 📗 Fix changelog

Author: maks-sh

Readme.rst

@@ -106,6 +106,8 @@ See the **RetailHero tutorial notebook** (`EN <https://nbviewer.jupyter.org/gith
 
 **Train and predict uplift model**
 
+Use the intuitive python API to train uplift models with `sklift.models  <https://www.uplift-modeling.com/en/latest/api/models/index.html>`__.
+
 .. code-block:: python
 
     # import approaches
@@ -130,6 +132,8 @@ See the **RetailHero tutorial notebook** (`EN <https://nbviewer.jupyter.org/gith
 
 **Evaluate your uplift model**
 
+Uplift model evaluation metrics are available in `sklift.metrics  <https://www.uplift-modeling.com/en/latest/api/metrics/index.html>`__.
+
 .. code-block:: python
 
     # import metrics to evaluate your model
@@ -153,6 +157,8 @@ See the **RetailHero tutorial notebook** (`EN <https://nbviewer.jupyter.org/gith
 
 **Vizualize the results**
 
+Visualize performance metrics with `sklift.viz  <https://www.uplift-modeling.com/en/latest/api/viz/index.html>`__.
+
 .. code-block:: python
 
     # import vizualisation tools

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)

docs/tutorials.rst

@@ -35,6 +35,19 @@ It is better to start scikit-uplift from the basic tutorials.
       - `nbviewer <https://nbviewer.jupyter.org/github/maks-sh/scikit-uplift/blob/master/notebooks/RetailHero.ipynb>`__
       - `github <https://github.com/maks-sh/scikit-uplift/blob/master/notebooks/RetailHero.ipynb>`__
 
+`Uplift modeling metrics`_
+----------------------------------------------------------------------------------
+
+.. list-table::
+    :align: center
+    :widths: 12 15 10 8
+
+    * - In English 🇬🇧
+      - |Open In Colab1|
+      - `nbviewer <https://nbviewer.jupyter.org/github/maks-sh/scikit-uplift/blob/master/notebooks/uplift_metrics_tutorial.ipynb>`__
+      - `github <https://github.com/maks-sh/scikit-uplift/blob/master/notebooks/uplift_metrics_tutorial.ipynb>`__
+
+
 `Example of usage model from sklift.models in sklearn.pipeline`_
 ----------------------------------------------------------------------------------
 

notebooks/Readme.rst

@@ -35,6 +35,18 @@ It is better to start scikit-uplift from the basic tutorials.
       - `nbviewer <https://nbviewer.jupyter.org/github/maks-sh/scikit-uplift/blob/master/notebooks/RetailHero.ipynb>`__
       - `github <https://github.com/maks-sh/scikit-uplift/blob/master/notebooks/RetailHero.ipynb>`__
 
+`Uplift modeling metrics`_
+----------------------------------------------------------------------------------
+
+.. list-table::
+    :align: center
+    :widths: 12 15 10 8
+
+    * - In English 🇬🇧
+      - |Open In Colab1|
+      - `nbviewer <https://nbviewer.jupyter.org/github/maks-sh/scikit-uplift/blob/master/notebooks/uplift_metrics_tutorial.ipynb>`__
+      - `github <https://github.com/maks-sh/scikit-uplift/blob/master/notebooks/uplift_metrics_tutorial.ipynb>`__
+
 `Example of usage model from sklift.models in sklearn.pipeline`_
 ----------------------------------------------------------------------------------
 

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
-}
+}

notebooks/uplift_metrics_tutorial.ipynb

@@ -4,7 +4,19 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 🎯 Uplift modeling `metrics`"
+    "# 🎯 Uplift modeling `metrics`\n",
+    "\n",
+    "<br>\n",
+    "<center>\n",
+    "    <a href=\"https://colab.research.google.com/github/maks-sh/scikit-uplift/blob/master/notebooks/uplift_metrics_tutorial.ipynb\">\n",
+    "        <img src=\"https://colab.research.google.com/assets/colab-badge.svg\">\n",
+    "    </a>\n",
+    "    <br>\n",
+    "    <b><a href=\"https://github.com/maks-sh/scikit-uplift/\">SCIKIT-UPLIFT REPO</a> | </b>\n",
+    "    <b><a href=\"https://scikit-uplift.readthedocs.io/en/latest/\">SCIKIT-UPLIFT DOCS</a> | </b>\n",
+    "    <b><a href=\"https://scikit-uplift.readthedocs.io/en/latest/user_guide/index.html\">USER GUIDE</a></b>\n",
+    "    <br>\n",
+    "</center>"
    ]
   },
   {
@@ -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
-}
+}