Merge branch 'realese/v0.4.1'

maks-sh · Jun 17, 2022 · e549140 · e549140 · github-actions · Jun 17, 2022
2 parents c9dd56a + 70140ee
commit e549140
Show file tree

Hide file tree

Showing 13 changed files with 2,470 additions and 41 deletions.
diff --git a/docs/api/datasets/fetch_criteo.rst b/docs/api/datasets/fetch_criteo.rst
@@ -6,4 +6,16 @@
 
 .. autofunction:: sklift.datasets.datasets.fetch_criteo
 
-.. include:: ../../../sklift/datasets/descr/criteo.rst
+.. include:: ../../../sklift/datasets/descr/criteo.rst
+
+About Criteo
+##################
+
+.. figure:: https://upload.wikimedia.org/wikipedia/commons/d/d2/Criteo_logo21.svg
+
+`Criteo <https://en.wikipedia.org/wiki/Criteo>`__ is an advertising company that provides online display advertisements.
+The company was founded and is headquartered in Paris, France. Criteo's product is a form of display advertising,
+which displays interactive banner advertisements, generated based on the online browsing preferences and behaviour for each customer.
+The solution operates on a pay per click/cost per click (CPC) basis.
+
+Link to the company's website: https://www.criteo.com/
diff --git a/docs/api/datasets/fetch_hillstrom.rst b/docs/api/datasets/fetch_hillstrom.rst
@@ -6,4 +6,12 @@
 
 .. autofunction:: sklift.datasets.datasets.fetch_hillstrom
 
-.. include:: ../../../sklift/datasets/descr/hillstrom.rst
+.. include:: ../../../sklift/datasets/descr/hillstrom.rst
+
+About Hillstrom
+##################
+
+The dataset was provided by Kevin Hillstorm.
+Kevin is President of MineThatData, a consultancy that helps CEOs understand the complex relationship between Customers, Advertising, Products, Brands, and Channels.
+
+Link to the blog: https://blog.minethatdata.com/
diff --git a/docs/api/datasets/fetch_lenta.rst b/docs/api/datasets/fetch_lenta.rst
@@ -6,4 +6,14 @@
 
 .. autofunction:: sklift.datasets.datasets.fetch_lenta
 
-.. include:: ../../../sklift/datasets/descr/lenta.rst
+.. include:: ../../../sklift/datasets/descr/lenta.rst
+
+About Lenta
+##################
+
+.. figure:: https://upload.wikimedia.org/wikipedia/commons/7/73/Lenta_logo.svg
+
+`Lenta (Russian: Лентa) <https://en.wikipedia.org/wiki/Lenta_(retail)>`__  is a Russian super - and hypermarket chain. With 149 locations across the country,
+it is one of Russia's largest retail chains in addition to being the country's second largest hypermarket chain.
+
+Link to the company's website: https://www.lenta.com/
diff --git a/docs/api/datasets/fetch_megafon.rst b/docs/api/datasets/fetch_megafon.rst
@@ -6,4 +6,14 @@
 
 .. autofunction:: sklift.datasets.datasets.fetch_megafon
 
-.. include:: ../../../sklift/datasets/descr/megafon.rst
+.. include:: ../../../sklift/datasets/descr/megafon.rst
+
+About MegaFon
+##################
+
+.. figure:: https://upload.wikimedia.org/wikipedia/commons/9/9e/MegaFon_logo.svg
+
+`MegaFon (Russian: МегаФон) <https://en.wikipedia.org/wiki/MegaFon>`__  , previously known as North-West GSM, is the second largest mobile phone operator and the third largest telecom operator in Russia.
+It works in the GSM, UMTS and LTE standard. As of June 2012, the company serves 62.1 million subscribers in Russia and 1.6 million in Tajikistan. It is headquartered in Moscow.
+
+Link to the company's website: https://megafon.ru/
diff --git a/docs/api/datasets/fetch_x5.rst b/docs/api/datasets/fetch_x5.rst
@@ -6,4 +6,16 @@
 
 .. autofunction:: sklift.datasets.datasets.fetch_x5
 
-.. include:: ../../../sklift/datasets/descr/x5.rst
+.. include:: ../../../sklift/datasets/descr/x5.rst
+
+About X5
+##################
+
+.. figure:: https://upload.wikimedia.org/wikipedia/en/8/83/X5_Retail_Group_logo_2015.png
+
+`X5 Group <https://en.wikipedia.org/wiki/X5_Retail_Group>`__  is a leading Russian food retailer.
+The Company operates several retail formats: proximity stores under the Pyaterochka brand, 
+supermarkets under the Perekrestok brand and hypermarkets under the Karusel brand, as well as the Perekrestok.ru online market, 
+the 5Post parcel and Dostavka.Pyaterochka and Perekrestok. Bystro food delivery services.
+
+Link to the company's website: https://www.x5.ru/
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -8,6 +8,13 @@
 * 🔨 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.1
+
+### [sklift.datasets](https://www.uplift-modeling.com/en/v0.4.0/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)
File	Stmts	Miss	Cover	Missing
sklift/datasets
datasets.py	147	33	78%	55, 80–85, 95, 109, 265–304, 397
sklift/metrics
metrics.py	264	12	95%	64–68, 442–449, 453–454, 466
sklift/models
models.py	162	5	97%	99, 414, 434, 464, 482
sklift/utils
utils.py	4	0	100%
sklift/viz
base.py	182	4	98%	133–135, 372
TOTAL	759	54	93%