Skip to content

Commit 68610bf

Browse files
authored
🚀 Add changelog (#71)
1 parent 161c1b7 commit 68610bf

File tree

1 file changed

+60
-38
lines changed

1 file changed

+60
-38
lines changed

docs/changelog.md

Lines changed: 60 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -8,68 +8,90 @@
88
* 🔨 something that previously didn’t work as documentated – or according to reasonable expectations – should now work.
99
* ❗️ you will need to change your code to have the same effect in the future; or a feature will be removed in the future.
1010

11+
## Version 0.3.0
12+
13+
### [sklift.datasets](https://www.uplift-modeling.com/en/latest/en/latest/api/datasets/index.html)
14+
15+
* 🔥 Add [sklift.datasets](https://www.uplift-modeling.com/en/latest/en/latest/user_guide/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)
16+
17+
### [sklift.models](https://www.uplift-modeling.com/en/latest/en/latest/api/models.html)
18+
19+
* 📝 Add different checkers by [@ElisovaIra](https://github.com/ElisovaIra)
20+
21+
### [sklift.metrics](https://www.uplift-modeling.com/en/latest/en/latest/api/metrics.html)
22+
23+
* 📝 Add different checkers by [@ElisovaIra](https://github.com/ElisovaIra)
24+
25+
### [sklift.viz](https://www.uplift-modeling.com/en/latest/en/latest/api/viz.html)
26+
27+
* 📝 Fix conflicting and duplicating default values by [@denniskorablev](https://github.com/denniskorablev)
28+
29+
### [User Guide](https://www.uplift-modeling.com/en/latest/en/latest/user_guide/index.html)
30+
31+
* 📝 Fix typos
32+
1133
## Version 0.2.0
1234

13-
### [User Guide](https://scikit-uplift.readthedocs.io/en/latest/user_guide/index.html)
35+
### [User Guide](https://www.uplift-modeling.com/en/latest/en/latest/user_guide/index.html)
1436

15-
* 🔥 Add [User Guide](https://scikit-uplift.readthedocs.io/en/latest/user_guide/index.html)
37+
* 🔥 Add [User Guide](https://www.uplift-modeling.com/en/latest/en/latest/user_guide/index.html)
1638

17-
### [sklift.models](https://scikit-uplift.readthedocs.io/en/latest/api/models.html)
39+
### [sklift.models](https://www.uplift-modeling.com/en/latest/en/latest/api/models.html)
1840

19-
* 💥 Add `treatment interaction` method to [SoloModel](https://scikit-uplift.readthedocs.io/en/latest/api/models/SoloModel.html) approach by [@AdiVarma27](https://github.com/AdiVarma27).
41+
* 💥 Add `treatment interaction` method to [SoloModel](https://www.uplift-modeling.com/en/latest/en/latest/api/models/SoloModel.html) approach by [@AdiVarma27](https://github.com/AdiVarma27).
2042

21-
### [sklift.metrics](https://scikit-uplift.readthedocs.io/en/latest/api/metrics.html)
43+
### [sklift.metrics](https://www.uplift-modeling.com/en/latest/en/latest/api/metrics.html)
2244

23-
* 💥 Add [uplift_by_percentile](https://scikit-uplift.readthedocs.io/en/latest/api/metrics/uplift_by_percentile.html) function by [@ElisovaIra](https://github.com/ElisovaIra).
24-
* 💥 Add [weighted_average_uplift](https://scikit-uplift.readthedocs.io/en/latest/api/metrics/weighted_average_uplift.html) function by [@ElisovaIra](https://github.com/ElisovaIra).
25-
* 💥 Add [perfect_uplift_curve](https://scikit-uplift.readthedocs.io/en/latest/api/metrics/perfect_uplift_curve.html) function.
26-
* 💥 Add [perfect_qini_curve](https://scikit-uplift.readthedocs.io/en/latest/api/metrics/perfect_qini_curve.html) function.
27-
* 🔨 Add normalization in [uplift_auc_score](https://scikit-uplift.readthedocs.io/en/latest/api/metrics/uplift_auc_score.html) and [qini_auc_score](https://scikit-uplift.readthedocs.io/en/latest/api/metrics/qini_auc_score.html) functions.
28-
* ❗ Remove metrics `auuc` and `auqc`. In exchange for them use respectively [uplift_auc_score](https://scikit-uplift.readthedocs.io/en/latest/api/metrics/uplift_auc_score.html) and [qini_auc_score](https://scikit-uplift.readthedocs.io/en/latest/api/metrics/qini_auc_score.html)
45+
* 💥 Add [uplift_by_percentile](https://www.uplift-modeling.com/en/latest/en/latest/api/metrics/uplift_by_percentile.html) function by [@ElisovaIra](https://github.com/ElisovaIra).
46+
* 💥 Add [weighted_average_uplift](https://www.uplift-modeling.com/en/latest/en/latest/api/metrics/weighted_average_uplift.html) function by [@ElisovaIra](https://github.com/ElisovaIra).
47+
* 💥 Add [perfect_uplift_curve](https://www.uplift-modeling.com/en/latest/en/latest/api/metrics/perfect_uplift_curve.html) function.
48+
* 💥 Add [perfect_qini_curve](https://www.uplift-modeling.com/en/latest/en/latest/api/metrics/perfect_qini_curve.html) function.
49+
* 🔨 Add normalization in [uplift_auc_score](https://www.uplift-modeling.com/en/latest/en/latest/api/metrics/uplift_auc_score.html) and [qini_auc_score](https://www.uplift-modeling.com/en/latest/en/latest/api/metrics/qini_auc_score.html) functions.
50+
* ❗ Remove metrics `auuc` and `auqc`. In exchange for them use respectively [uplift_auc_score](https://www.uplift-modeling.com/en/latest/en/latest/api/metrics/uplift_auc_score.html) and [qini_auc_score](https://www.uplift-modeling.com/en/latest/en/latest/api/metrics/qini_auc_score.html)
2951

30-
### [sklift.viz](https://scikit-uplift.readthedocs.io/en/latest/api/viz.html)
52+
### [sklift.viz](https://www.uplift-modeling.com/en/latest/en/latest/api/viz.html)
3153

32-
* 💥 Add [plot_uplift_curve](https://scikit-uplift.readthedocs.io/en/latest/api/viz/plot_uplift_curve.html) function.
33-
* 💥 Add [plot_qini_curve](https://scikit-uplift.readthedocs.io/en/latest/api/viz/plot_qini_curve.html) function.
54+
* 💥 Add [plot_uplift_curve](https://www.uplift-modeling.com/en/latest/en/latest/api/viz/plot_uplift_curve.html) function.
55+
* 💥 Add [plot_qini_curve](https://www.uplift-modeling.com/en/latest/en/latest/api/viz/plot_qini_curve.html) function.
3456
* ❗ Remove `plot_uplift_qini_curves`.
3557

3658
### Miscellaneous
3759

3860
* 💥 Add contributors in main Readme and in main page of docs.
39-
* 💥 Add [contributing guide](https://scikit-uplift.readthedocs.io/en/latest/contributing.html).
61+
* 💥 Add [contributing guide](https://www.uplift-modeling.com/en/latest/en/latest/contributing.html).
4062
* 💥 Add [code of conduct](https://github.com/maks-sh/scikit-uplift/blob/master/.github/CODE_OF_CONDUCT.md).
41-
* 📝 Reformat [Tutorials](https://scikit-uplift.readthedocs.io/en/latest/tutorials.html) page.
63+
* 📝 Reformat [Tutorials](https://www.uplift-modeling.com/en/latest/en/latest/tutorials.html) page.
4264
* 📝 Add github buttons in docs.
4365
* 📝 Add logo compatibility with pypi.
4466

4567
## Version 0.1.2
4668

47-
### [sklift.models](https://scikit-uplift.readthedocs.io/en/v0.1.2/api/models.html)
69+
### [sklift.models](https://www.uplift-modeling.com/en/latest/en/v0.1.2/api/models.html)
4870

49-
* 🔨 Fix bugs in [TwoModels](https://scikit-uplift.readthedocs.io/en/v0.1.2/api/models.html#sklift.models.models.TwoModels) for regression problem.
71+
* 🔨 Fix bugs in [TwoModels](https://www.uplift-modeling.com/en/latest/en/v0.1.2/api/models.html#sklift.models.models.TwoModels) for regression problem.
5072
* 📝 Minor code refactoring.
5173

52-
### [sklift.metrics](https://scikit-uplift.readthedocs.io/en/v0.1.2/api/metrics.html)
74+
### [sklift.metrics](https://www.uplift-modeling.com/en/latest/en/v0.1.2/api/metrics.html)
5375

5476
* 📝 Minor code refactoring.
5577

56-
### [sklift.viz](https://scikit-uplift.readthedocs.io/en/v0.1.2/api/viz.html)
78+
### [sklift.viz](https://www.uplift-modeling.com/en/latest/en/v0.1.2/api/viz.html)
5779

58-
* 💥 Add bar plot in [plot_uplift_by_percentile](https://scikit-uplift.readthedocs.io/en/v0.1.2/api/viz.html#sklift.viz.base.plot_uplift_by_percentile) by [@ElisovaIra](https://github.com/ElisovaIra).
59-
* 🔨 Fix bug in [plot_uplift_by_percentile](https://scikit-uplift.readthedocs.io/en/v0.1.2/api/viz.html#sklift.viz.base.plot_uplift_by_percentile).
80+
* 💥 Add bar plot in [plot_uplift_by_percentile](https://www.uplift-modeling.com/en/latest/en/v0.1.2/api/viz.html#sklift.viz.base.plot_uplift_by_percentile) by [@ElisovaIra](https://github.com/ElisovaIra).
81+
* 🔨 Fix bug in [plot_uplift_by_percentile](https://www.uplift-modeling.com/en/latest/en/v0.1.2/api/viz.html#sklift.viz.base.plot_uplift_by_percentile).
6082
* 📝 Minor code refactoring.
6183

6284
## Version 0.1.1
6385

64-
### [sklift.viz](https://scikit-uplift.readthedocs.io/en/v0.1.1/api/viz.html)
86+
### [sklift.viz](https://www.uplift-modeling.com/en/latest/en/v0.1.1/api/viz.html)
6587

66-
* 💥 Add [plot_uplift_by_percentile](https://scikit-uplift.readthedocs.io/en/v0.1.1/api/viz.html#sklift.viz.base.plot_uplift_by_percentile) by [@ElisovaIra](https://github.com/ElisovaIra).
67-
* 🔨 Fix bug with import [plot_treatment_balance_curve](https://scikit-uplift.readthedocs.io/en/v0.1.1/api/viz.html#sklift.viz.base.plot_treatment_balance_curve).
88+
* 💥 Add [plot_uplift_by_percentile](https://www.uplift-modeling.com/en/latest/en/v0.1.1/api/viz.html#sklift.viz.base.plot_uplift_by_percentile) by [@ElisovaIra](https://github.com/ElisovaIra).
89+
* 🔨 Fix bug with import [plot_treatment_balance_curve](https://www.uplift-modeling.com/en/latest/en/v0.1.1/api/viz.html#sklift.viz.base.plot_treatment_balance_curve).
6890

69-
### [sklift.metrics](https://scikit-uplift.readthedocs.io/en/v0.1.1/api/metrics.html)
91+
### [sklift.metrics](https://www.uplift-modeling.com/en/latest/en/v0.1.1/api/metrics.html)
7092

71-
* 💥 Add [response_rate_by_percentile](https://scikit-uplift.readthedocs.io/en/v0.1.1/api/viz.html#sklift.metrics.metrics.response_rate_by_percentile) by [@ElisovaIra](https://github.com/ElisovaIra).
72-
* 🔨 Fix bug with import [uplift_auc_score](https://scikit-uplift.readthedocs.io/en/v0.1.1/api/metrics.html#sklift.metrics.metrics.uplift_auc_score) and [qini_auc_score](https://scikit-uplift.readthedocs.io/en/v0.1.1/metrics.html#sklift.metrics.metrics.qini_auc_score).
93+
* 💥 Add [response_rate_by_percentile](https://www.uplift-modeling.com/en/latest/en/v0.1.1/api/viz.html#sklift.metrics.metrics.response_rate_by_percentile) by [@ElisovaIra](https://github.com/ElisovaIra).
94+
* 🔨 Fix bug with import [uplift_auc_score](https://www.uplift-modeling.com/en/latest/en/v0.1.1/api/metrics.html#sklift.metrics.metrics.uplift_auc_score) and [qini_auc_score](https://www.uplift-modeling.com/en/latest/en/v0.1.1/metrics.html#sklift.metrics.metrics.qini_auc_score).
7395
* 📝 Fix typos in docstrings.
7496

7597
### Miscellaneous
@@ -79,25 +101,25 @@
79101

80102
## Version 0.1.0
81103

82-
### [sklift.models](https://scikit-uplift.readthedocs.io/en/v0.1.0/api/models.html)
104+
### [sklift.models](https://www.uplift-modeling.com/en/latest/en/v0.1.0/api/models.html)
83105

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

87-
### [sklift.metrics](https://scikit-uplift.readthedocs.io/en/v0.1.0/api/metrics.html)
109+
### [sklift.metrics](https://www.uplift-modeling.com/en/latest/en/v0.1.0/api/metrics.html)
88110

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

93-
### [sklift.viz](https://scikit-uplift.readthedocs.io/en/v0.1.0/api/viz.html)
115+
### [sklift.viz](https://www.uplift-modeling.com/en/latest/en/v0.1.0/api/viz.html)
94116

95-
* 💥 Add [plot_treatment_balance_curve](https://scikit-uplift.readthedocs.io/en/v0.1.0/api/viz.html#sklift.viz.base.plot_treatment_balance_curve) by [@spiaz](https://github.com/spiaz).
96-
* 📝 fix typo in [plot_uplift_qini_curves](https://scikit-uplift.readthedocs.io/en/v0.1.0/api/viz.html#sklift.viz.base.plot_uplift_qini_curves) by [@spiaz](https://github.com/spiaz).
117+
* 💥 Add [plot_treatment_balance_curve](https://www.uplift-modeling.com/en/latest/en/v0.1.0/api/viz.html#sklift.viz.base.plot_treatment_balance_curve) by [@spiaz](https://github.com/spiaz).
118+
* 📝 fix typo in [plot_uplift_qini_curves](https://www.uplift-modeling.com/en/latest/en/v0.1.0/api/viz.html#sklift.viz.base.plot_uplift_qini_curves) by [@spiaz](https://github.com/spiaz).
97119

98120
### Miscellaneous
99121

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

0 commit comments

Comments
 (0)