Skip to content

Commit f4271d9

Browse files
glemaitreglemaitre
committed
DOC fix warning (#425)
1 parent 1097966 commit f4271d9

File tree

9 files changed

+181
-90
lines changed

9 files changed

+181
-90
lines changed

‎doc/whats_new.rst

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,3 @@ Release history
1111
.. include:: whats_new/v0.0.2.rst
1212

1313
.. include:: whats_new/v0.0.1.rst
14-
15-
.. _Guillaume Lemaitre: https://github.com/glemaitre
16-
.. _Christos Aridas: https://github.com/chkoar
17-
.. _Fernando Nogueira: https://github.com/fmfn
18-
.. _Dayvid Oliveira: https://github.com/dvro
19-
.. _Francois Magimel: https://github.com/Linkid
20-
.. _Aliaksei Halachkin: https://github.com/honeyext
21-
.. _Aleksandr Loskutov: https://github.com/loskutyan
22-
.. _Rafael Wampfler: https://github.com/Eichhof
23-
.. _Joan Massich: https://github.com/massich

‎doc/whats_new/v0.0.1.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ Changelog
99
API
1010
~~~
1111

12-
- First release of the stable API. By `Fernando Nogueira`_, `Guillaume Lemaitre`_, `Christos Aridas`_, and `Dayvid Oliveira`_.
12+
- First release of the stable API. By :user;`Fernando Nogueira <fmfn>`,
13+
:user:`Guillaume Lemaitre <glemaitre>`, :user:`Christos Aridas <chkoar>`,
14+
and :user:`Dayvid Oliveira <dvro>`.
1315

1416
New methods
1517
~~~~~~~~~~~

‎doc/whats_new/v0.0.2.rst

Lines changed: 121 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,51 +9,141 @@ Changelog
99
Bug fixes
1010
~~~~~~~~~
1111

12-
- Fixed a bug in :class:`under_sampling.NearMiss` which was not picking the right samples during under sampling for the method 3. By `Guillaume Lemaitre`_.
13-
- Fixed a bug in :class:`ensemble.EasyEnsemble`, correction of the `random_state` generation. By `Guillaume Lemaitre`_ and `Christos Aridas`_.
14-
- Fixed a bug in :class:`under_sampling.RepeatedEditedNearestNeighbours`, add additional stopping criterion to avoid that the minority class become a majority class or that a class disappear. By `Guillaume Lemaitre`_.
15-
- Fixed a bug in :class:`under_sampling.AllKNN`, add stopping criteria to avoid that the minority class become a majority class or that a class disappear. By `Guillaume Lemaitre`_.
16-
- Fixed a bug in :class:`under_sampling.CondensedNeareastNeigbour`, correction of the list of indices returned. By `Guillaume Lemaitre`_.
17-
- Fixed a bug in :class:`ensemble.BalanceCascade`, solve the issue to obtain a single array if desired. By `Guillaume Lemaitre`_.
18-
- Fixed a bug in :class:`pipeline.Pipeline`, solve to embed `Pipeline` in other `Pipeline`. :issue:`231` by `Christos Aridas`_ .
19-
- Fixed a bug in :class:`pipeline.Pipeline`, solve the issue to put to sampler in the same `Pipeline`. :issue:`188` by `Christos Aridas`_ .
20-
- Fixed a bug in :class:`under_sampling.CondensedNeareastNeigbour`, correction of the shape of `sel_x` when only one sample is selected. By `Aliaksei Halachkin`_.
21-
- Fixed a bug in :class:`under_sampling.NeighbourhoodCleaningRule`, selecting neighbours instead of minority class misclassified samples. :issue:`230` by `Aleksandr Loskutov`_.
22-
- Fixed a bug in :class:`over_sampling.ADASYN`, correction of the creation of a new sample so that the new sample lies between the minority sample and the nearest neighbour. :issue:`235` by `Rafael Wampfler`_.
12+
- Fixed a bug in :class:`under_sampling.NearMiss` which was not picking the
13+
right samples during under sampling for the method 3. By :user:`Guillaume
14+
Lemaitre <glemaitre>`.
15+
16+
- Fixed a bug in :class:`ensemble.EasyEnsemble`, correction of the
17+
`random_state` generation. By :user:`Guillaume Lemaitre <glemaitre>` and
18+
:user:`Christos Aridas <chkoar>`.
19+
20+
- Fixed a bug in :class:`under_sampling.RepeatedEditedNearestNeighbours`, add
21+
additional stopping criterion to avoid that the minority class become a
22+
majority class or that a class disappear. By :user:`Guillaume Lemaitre
23+
<glemaitre>`.
24+
25+
- Fixed a bug in :class:`under_sampling.AllKNN`, add stopping criteria to avoid
26+
that the minority class become a majority class or that a class disappear. By
27+
:user:`Guillaume Lemaitre <glemaitre>`.
28+
29+
- Fixed a bug in :class:`under_sampling.CondensedNeareastNeigbour`, correction
30+
of the list of indices returned. By :user:`Guillaume Lemaitre <glemaitre>`.
31+
32+
- Fixed a bug in :class:`ensemble.BalanceCascade`, solve the issue to obtain a
33+
single array if desired. By :user:`Guillaume Lemaitre <glemaitre>`.
34+
35+
- Fixed a bug in :class:`pipeline.Pipeline`, solve to embed `Pipeline` in other
36+
`Pipeline`. :issue:`231` by :user:`Christos Aridas <chkoar>`.
37+
38+
- Fixed a bug in :class:`pipeline.Pipeline`, solve the issue to put to sampler
39+
in the same `Pipeline`. :issue:`188` by :user:`Christos Aridas <chkoar>`.
40+
41+
- Fixed a bug in :class:`under_sampling.CondensedNeareastNeigbour`, correction
42+
of the shape of `sel_x` when only one sample is selected. By
43+
:user:`Aliaksei Halachkin <honeyext>`.
44+
45+
- Fixed a bug in :class:`under_sampling.NeighbourhoodCleaningRule`, selecting
46+
neighbours instead of minority class misclassified samples. :issue:`230` by
47+
:user:`Aleksandr Loskutov <loskutyan>`.
48+
49+
- Fixed a bug in :class:`over_sampling.ADASYN`, correction of the creation of a
50+
new sample so that the new sample lies between the minority sample and the
51+
nearest neighbour. :issue:`235` by :user:`Rafael Wampfler <Eichnof>`.
2352

2453
New features
2554
~~~~~~~~~~~~
2655

27-
- Added AllKNN under sampling technique. By `Dayvid Oliveira`_.
28-
- Added a module `metrics` implementing some specific scoring function for the problem of balancing. :issue:`204` by `Guillaume Lemaitre`_ and `Christos Aridas`_.
56+
- Added AllKNN under sampling technique. By :user:`Dayvid Oliveira <dvro>`.
57+
58+
- Added a module `metrics` implementing some specific scoring function for the
59+
problem of balancing. :issue:`204` by :user:`Guillaume Lemaitre <glemaitre>`
60+
and :user:`Christos Aridas <chkoar>`.
2961

3062
Enhancement
3163
~~~~~~~~~~~
3264

33-
- Added support for bumpversion. By `Guillaume Lemaitre`_.
34-
- Validate the type of target in binary samplers. A warning is raised for the moment. By `Guillaume Lemaitre`_ and `Christos Aridas`_.
65+
- Added support for bumpversion. By :user:`Guillaume Lemaitre <glemaitre>`.
66+
67+
- Validate the type of target in binary samplers. A warning is raised for the
68+
moment. By :user:`Guillaume Lemaitre <glemaitre>` and :user:`Christos Aridas
69+
<chkoar>`.
70+
3571
- Change from `cross_validation` module to `model_selection` module for
36-
`sklearn` deprecation cycle. By `Dayvid Oliveira`_ and `Christos Aridas`_.
72+
`sklearn` deprecation cycle. By :user:`Dayvid Oliveira <dvro>` and
73+
:user:`Christos Aridas <chkoar>`.
3774

3875
API changes summary
3976
~~~~~~~~~~~~~~~~~~~
4077

41-
- `size_ngh` has been deprecated in :class:`combine.SMOTEENN`. Use `n_neighbors` instead. By `Guillaume Lemaitre`_, `Christos Aridas`_, and `Dayvid Oliveira` .
42-
- `size_ngh` has been deprecated in :class:`under_sampling.EditedNearestNeighbors`. Use `n_neighbors` instead. By `Guillaume Lemaitre`_, `Christos Aridas`_, and `Dayvid Oliveira`_.
43-
- `size_ngh` has been deprecated in :class:`under_sampling.CondensedNeareastNeigbour`. Use `n_neighbors` instead. By `Guillaume Lemaitre`_, `Christos Aridas`_, and `Dayvid Oliveira`_.
44-
- `size_ngh` has been deprecated in :class:`under_sampling.OneSidedSelection`. Use `n_neighbors` instead. By `Guillaume Lemaitre`_, `Christos Aridas`_, and `Dayvid Oliveira`_.
45-
- `size_ngh` has been deprecated in :class:`under_sampling.NeighbourhoodCleaningRule`. Use `n_neighbors` instead. By `Guillaume Lemaitre`_, `Christos Aridas`_, and `Dayvid Oliveira`_.
46-
- `size_ngh` has been deprecated in :class:`under_sampling.RepeatedEditedNearestNeighbours`. Use `n_neighbors` instead. By `Guillaume Lemaitre`_, `Christos Aridas`_, and `Dayvid Oliveira`_.
47-
- `size_ngh` has been deprecated in :class:`under_sampling.AllKNN`. Use `n_neighbors` instead. By `Guillaume Lemaitre`_, `Christos Aridas`_, and `Dayvid Oliveira`_.
48-
- Two base classes :class:`BaseBinaryclassSampler` and :class:`BaseMulticlassSampler` have been created to handle the target type and raise warning in case of abnormality. By `Guillaume Lemaitre`_ and `Christos Aridas`_.
49-
- Move `random_state` to be assigned in the :class:`SamplerMixin` initialization. By `Guillaume Lemaitre`_.
50-
- Provide estimators instead of parameters in :class:`combine.SMOTEENN` and :class:`combine.SMOTETomek`. Therefore, the list of parameters have been deprecated. By `Guillaume Lemaitre`_ and `Christos Aridas`_.
51-
- `k` has been deprecated in :class:`over_sampling.ADASYN`. Use `n_neighbors` instead. :issue:`183` by `Guillaume Lemaitre`_.
52-
- `k` and `m` have been deprecated in :class:`over_sampling.SMOTE`. Use `k_neighbors` and `m_neighbors` instead. :issue:`182` by `Guillaume Lemaitre`_.
53-
- `n_neighbors` accept `KNeighborsMixin` based object for :class:`under_sampling.EditedNearestNeighbors`, :class:`under_sampling.CondensedNeareastNeigbour`, :class:`under_sampling.NeighbourhoodCleaningRule`, :class:`under_sampling.RepeatedEditedNearestNeighbours`, and :class:`under_sampling.AllKNN`. :issue:`109` by `Guillaume Lemaitre`_.
78+
- `size_ngh` has been deprecated in :class:`combine.SMOTEENN`. Use
79+
`n_neighbors` instead. By :user:`Guillaume Lemaitre <glemaitre>`,
80+
:user:`Christos Aridas <chkoar>`, and :user:`Dayvid Oliveira <dvro>`.
81+
82+
- `size_ngh` has been deprecated in
83+
:class:`under_sampling.EditedNearestNeighbors`. Use `n_neighbors` instead. By
84+
:user:`Guillaume Lemaitre <glemaitre>`, :user:`Christos Aridas <chkoar>`,
85+
and :user:`Dayvid Oliveira <dvro>`.
86+
87+
- `size_ngh` has been deprecated in
88+
:class:`under_sampling.CondensedNeareastNeigbour`. Use `n_neighbors`
89+
instead. By :user:`Guillaume Lemaitre <glemaitre>`,
90+
:user:`Christos Aridas <chkoar>`, and
91+
:user:`Dayvid Oliveira <dvro>`.
92+
93+
- `size_ngh` has been deprecated in
94+
:class:`under_sampling.OneSidedSelection`. Use `n_neighbors` instead. By
95+
:user:`Guillaume Lemaitre <glemaitre>`, :user:`Christos Aridas <chkoar>`,
96+
and :user:`Dayvid Oliveira <dvro>`.
97+
98+
- `size_ngh` has been deprecated in
99+
:class:`under_sampling.NeighbourhoodCleaningRule`. Use `n_neighbors`
100+
instead. By :user:`Guillaume Lemaitre <glemaitre>`,
101+
:user:`Christos Aridas <chkoar>`, and
102+
:user:`Dayvid Oliveira <dvro>`.
103+
104+
- `size_ngh` has been deprecated in
105+
:class:`under_sampling.RepeatedEditedNearestNeighbours`. Use `n_neighbors`
106+
instead. By :user:`Guillaume Lemaitre <glemaitre>`,
107+
:user:`Christos Aridas <chkoar>`, and
108+
:user:`Dayvid Oliveira <dvro>`.
109+
110+
- `size_ngh` has been deprecated in :class:`under_sampling.AllKNN`. Use
111+
`n_neighbors` instead. By :user:`Guillaume Lemaitre <glemaitre>`,
112+
:user:`Christos Aridas <chkoar>`, and :user:`Dayvid Oliveira <dvro>`.
113+
114+
- Two base classes :class:`BaseBinaryclassSampler` and
115+
:class:`BaseMulticlassSampler` have been created to handle the target type
116+
and raise warning in case of abnormality.
117+
By :user:`Guillaume Lemaitre <glemaitre>` and :user:`Christos Aridas <chkoar>`.
118+
119+
- Move `random_state` to be assigned in the :class:`SamplerMixin`
120+
initialization. By :user:`Guillaume Lemaitre <glemaitre>`.
121+
122+
- Provide estimators instead of parameters in :class:`combine.SMOTEENN` and
123+
:class:`combine.SMOTETomek`. Therefore, the list of parameters have been
124+
deprecated. By :user:`Guillaume Lemaitre <glemaitre>` and
125+
:user:`Christos Aridas <chkoar>`.
126+
127+
- `k` has been deprecated in :class:`over_sampling.ADASYN`. Use `n_neighbors`
128+
instead. :issue:`183` by :user:`Guillaume Lemaitre <glemaitre>`.
129+
130+
- `k` and `m` have been deprecated in :class:`over_sampling.SMOTE`. Use
131+
`k_neighbors` and `m_neighbors` instead. :issue:`182` by :user:`Guillaume
132+
Lemaitre <glemaitre>`.
133+
134+
- `n_neighbors` accept `KNeighborsMixin` based object for
135+
:class:`under_sampling.EditedNearestNeighbors`,
136+
:class:`under_sampling.CondensedNeareastNeigbour`,
137+
:class:`under_sampling.NeighbourhoodCleaningRule`,
138+
:class:`under_sampling.RepeatedEditedNearestNeighbours`, and
139+
:class:`under_sampling.AllKNN`. :issue:`109` by :user:`Guillaume Lemaitre
140+
<glemaitre>`.
54141

55142
Documentation changes
56143
~~~~~~~~~~~~~~~~~~~~~
57144

58-
- Replace some remaining `UnbalancedDataset` occurences. By `Francois Magimel`_.
59-
- Added doctest in the documentation. By `Guillaume Lemaitre`_.
145+
- Replace some remaining `UnbalancedDataset` occurences.
146+
By :user:`Francois Magimel <Linkid>`.
147+
148+
- Added doctest in the documentation. By :user:`Guillaume Lemaitre
149+
<glemaitre>`.

‎doc/whats_new/v0.0.3.rst

Lines changed: 38 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -8,85 +8,92 @@ Changelog
88

99
Testing
1010
~~~~~~~
11-
- Pytest is used instead of nosetests. :issue:`321` by `Joan Massich`_.
11+
- Pytest is used instead of nosetests. :issue:`321` by :user:`Joan Massich
12+
<massich>`.
1213

1314
Documentation
1415
~~~~~~~~~~~~~
1516

16-
- Added a User Guide and extended some examples. :issue:`295` by `Guillaume Lemaitre`_.
17+
- Added a User Guide and extended some examples. :issue:`295` by
18+
:user:`Guillaume Lemaitre <glemaitre>`.
1719

1820
Bug fixes
1921
~~~~~~~~~
2022

2123
- Fixed a bug in :func:`utils.check_ratio` such that an error is raised when
22-
the number of samples required is negative. :issue:`312` by `Guillaume Lemaitre`_.
24+
the number of samples required is negative. :issue:`312` by :user:`Guillaume
25+
Lemaitre <glemaitre>`.
2326

24-
- Fixed a bug in :class:`under_sampling.NearMiss` version 3. The
25-
indices returned were wrong. :issue:`312` by `Guillaume Lemaitre`_.
27+
- Fixed a bug in :class:`under_sampling.NearMiss` version 3. The indices
28+
returned were wrong. :issue:`312` by :user:`Guillaume Lemaitre <glemaitre>`.
2629

2730
- Fixed bug for :class:`ensemble.BalanceCascade` and :class:`combine.SMOTEENN`
28-
and :class:`SMOTETomek`. :issue:`295` by `Guillaume Lemaitre`_.`
31+
and :class:`SMOTETomek`. :issue:`295` by :user:`Guillaume Lemaitre
32+
<glemaitre>`.
2933

3034
- Fixed bug for `check_ratio` to be able to pass arguments when `ratio` is a
31-
callable. :issue:`307` by `Guillaume Lemaitre`_.`
35+
callable. :issue:`307` by :user:`Guillaume Lemaitre <glemaitre>`.
3236

3337
New features
3438
~~~~~~~~~~~~
3539

3640
- Turn off steps in :class:`pipeline.Pipeline` using the `None`
37-
object. By `Christos Aridas`_.
41+
object. By :user:`Christos Aridas <chkoar>`.
3842

3943
- Add a fetching function :func:`datasets.fetch_datasets` in order to get some
40-
imbalanced datasets useful for benchmarking. :issue:`249` by `Guillaume Lemaitre`_.
44+
imbalanced datasets useful for benchmarking. :issue:`249` by :user:`Guillaume
45+
Lemaitre <glemaitre>`.
4146

4247
Enhancement
4348
~~~~~~~~~~~
4449

45-
- All samplers accepts sparse matrices with defaulting on CSR type. :issue:`316` by
46-
`Guillaume Lemaitre`_.
50+
- All samplers accepts sparse matrices with defaulting on CSR
51+
type. :issue:`316` by :user:`Guillaume Lemaitre <glemaitre>`.
4752

4853
- :func:`datasets.make_imbalance` take a ratio similarly to other samplers. It
49-
supports multiclass. :issue:`312` by `Guillaume Lemaitre`_.
54+
supports multiclass. :issue:`312` by :user:`Guillaume Lemaitre <glemaitre>`.
5055

5156
- All the unit tests have been factorized and a :func:`utils.check_estimators`
52-
has been derived from scikit-learn. By `Guillaume Lemaitre`_.
57+
has been derived from scikit-learn. By :user:`Guillaume Lemaitre
58+
<glemaitre>`.
5359

5460
- Script for automatic build of conda packages and uploading. :issue:`242` by
55-
`Guillaume Lemaitre`_
61+
:user:`Guillaume Lemaitre <glemaitre>`
5662

57-
- Remove seaborn dependence and improve the examples. :issue:`264` by `Guillaume
58-
Lemaitre`_.
63+
- Remove seaborn dependence and improve the examples. :issue:`264` by
64+
:user:`Guillaume Lemaitre <glemaitre>`.
5965

60-
- adapt all classes to multi-class resampling. :issue:`290` by `Guillaume Lemaitre`_
66+
- adapt all classes to multi-class resampling. :issue:`290` by :user:`Guillaume
67+
Lemaitre <glemaitre>`
6168

6269
API changes summary
6370
~~~~~~~~~~~~~~~~~~~
6471

65-
- `__init__` has been removed from the :class:`base.SamplerMixin` to
66-
create a real mixin class. :issue:`242` by `Guillaume Lemaitre`_.
72+
- `__init__` has been removed from the :class:`base.SamplerMixin` to create a
73+
real mixin class. :issue:`242` by :user:`Guillaume Lemaitre <glemaitre>`.
6774

6875
- creation of a module :mod:`exceptions` to handle consistant raising of
69-
errors. :issue:`242` by `Guillaume Lemaitre`_.
76+
errors. :issue:`242` by :user:`Guillaume Lemaitre <glemaitre>`.
7077

71-
- creation of a module ``utils.validation`` to make checking of
72-
recurrent patterns. :issue:`242` by `Guillaume Lemaitre`_.
78+
- creation of a module ``utils.validation`` to make checking of recurrent
79+
patterns. :issue:`242` by :user:`Guillaume Lemaitre <glemaitre>`.
7380

7481
- move the under-sampling methods in ``prototype_selection`` and
75-
``prototype_generation`` submodule to make a clearer dinstinction. :issue:`277` by
76-
`Guillaume Lemaitre`_.
82+
``prototype_generation`` submodule to make a clearer
83+
dinstinction. :issue:`277` by :user:`Guillaume Lemaitre <glemaitre>`.
7784

78-
- change ``ratio`` such that it can adapt to multiple class problems. :issue:`290` by
79-
`Guillaume Lemaitre`_.
85+
- change ``ratio`` such that it can adapt to multiple class
86+
problems. :issue:`290` by :user:`Guillaume Lemaitre <glemaitre>`.
8087

8188
Deprecation
8289
~~~~~~~~~~~
8390

84-
- Deprecation of the use of ``min_c_`` in :func:`datasets.make_imbalance`. :issue:`312` by
85-
`Guillaume Lemaitre`_
91+
- Deprecation of the use of ``min_c_`` in
92+
:func:`datasets.make_imbalance`. :issue:`312` by :user:`Guillaume Lemaitre
93+
<glemaitre>`
8694

8795
- Deprecation of the use of float in :func:`datasets.make_imbalance` for the
88-
ratio parameter. :issue:`290` by `Guillaume Lemaitre`_.
96+
ratio parameter. :issue:`290` by :user:`Guillaume Lemaitre <glemaitre>`.
8997

9098
- deprecate the use of float as ratio in favor of dictionary, string, or
91-
callable. :issue:`290` by `Guillaume Lemaitre`_.
92-
99+
callable. :issue:`290` by :user:`Guillaume Lemaitre <glemaitre>`.

‎doc/whats_new/v0.0.4.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _changes_0_3:
1+
.. _changes_0_4:
22

33
Version 0.4 (under development)
44
===============================

0 commit comments

Comments
 (0)