Skip to content

[MRG] DOC mention the multi-class scheme used #311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 3, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion imblearn/combine/smote_enn.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,8 @@ class SMOTEENN(SamplerMixin):
-----
The method is presented in [1]_.

Supports mutli-class resampling.
Supports mutli-class resampling. Refer to SMOTE and ENN regarding the
scheme which used.

Examples
--------
Expand Down
3 changes: 2 additions & 1 deletion imblearn/combine/smote_tomek.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,8 @@ class SMOTETomek(SamplerMixin):
-----
The methos is presented in [1]_.

Supports mutli-class resampling.
Supports mutli-class resampling. Refer to SMOTE and TomekLinks regarding
the scheme which used.

Examples
--------
Expand Down
3 changes: 2 additions & 1 deletion imblearn/ensemble/balance_cascade.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ class BalanceCascade(BaseEnsembleSampler):
-----
The method is described in [1]_.

Supports mutli-class resampling.
Supports mutli-class resampling. A one-vs.-rest scheme is used as
originally proposed in [1]_.

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion imblearn/ensemble/easy_ensemble.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ class EasyEnsemble(BaseEnsembleSampler):
-----
The method is described in [1]_.

Supports mutli-class resampling.
Supports mutli-class resampling by sampling each class independently.

Examples
--------
Expand Down
4 changes: 2 additions & 2 deletions imblearn/over_sampling/adasyn.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,10 @@ class ADASYN(BaseOverSampler):

Notes
-----
Supports mutli-class resampling.

The implementation is based on [1]_.

Supports mutli-class resampling. A one-vs.-rest scheme is used.

Examples
--------

Expand Down
2 changes: 1 addition & 1 deletion imblearn/over_sampling/random_over_sampler.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ class RandomOverSampler(BaseOverSampler):

Notes
-----
Supports mutli-class resampling.
Supports mutli-class resampling by sampling each class independently.

Examples
--------
Expand Down
3 changes: 2 additions & 1 deletion imblearn/over_sampling/smote.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,8 @@ class SMOTE(BaseOverSampler):
-----
See the original papers: [1]_, [2]_, [3]_ for more details.

Supports mutli-class resampling.
Supports mutli-class resampling. A one-vs.-rest scheme is used as
originally proposed in [1]_.

Examples
--------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ class ClusterCentroids(BaseUnderSampler):

Notes
-----
Supports mutli-class resampling.
Supports mutli-class resampling by sampling each class independently.

Examples
--------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@ class CondensedNearestNeighbour(BaseCleaningSampler):
-----
The method is based on [1]_.

Supports mutli-class resampling.
Supports mutli-class resampling. A one-vs.-rest scheme is used when
sampling a class as proposed in [1]_.

Examples
--------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@ class EditedNearestNeighbours(BaseCleaningSampler):
-----
The method is based on [1]_.

Supports mutli-class resampling.
Supports mutli-class resampling. A one-vs.-rest scheme is used when
sampling a class as proposed in [1]_.

Examples
--------
Expand Down Expand Up @@ -272,7 +273,8 @@ class RepeatedEditedNearestNeighbours(BaseCleaningSampler):

Notes
-----
The method is based on [1]_.
The method is based on [1]_. A one-vs.-rest scheme is used when
sampling a class as proposed in [1]_.

Supports mutli-class resampling.

Expand Down Expand Up @@ -482,7 +484,8 @@ class AllKNN(BaseCleaningSampler):
-----
The method is based on [1]_.

Supports mutli-class resampling.
Supports mutli-class resampling. A one-vs.-rest scheme is used when
sampling a class as proposed in [1]_.

Examples
--------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,8 @@ class InstanceHardnessThreshold(BaseCleaningSampler):
-----
The method is based on [1]_.

Supports mutli-class resampling.
Supports mutli-class resampling. A one-vs.-rest scheme is used when
sampling a class as proposed in [1]_.

Examples
--------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,10 @@ class NeighbourhoodCleaningRule(BaseCleaningSampler):

Notes
-----
Supports mutli-class resampling.
See the original paper: [1]_.

Supports mutli-class resampling. A one-vs.-rest scheme is used when
sampling a class as proposed in [1]_.

Examples
--------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@ class OneSidedSelection(BaseCleaningSampler):
-----
The method is based on [1]_.

Supports mutli-class resampling.
Supports mutli-class resampling. A one-vs.-one scheme is used when sampling
a class as proposed in [1]_. For each class to be sampled, all samples of
this class and the minority class are used during the sampling procedure.

Examples
--------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ class RandomUnderSampler(BaseUnderSampler):

Notes
-----
Supports mutli-class resampling.
Supports mutli-class resampling by sampling each class independently.

Examples
--------
Expand Down
3 changes: 2 additions & 1 deletion imblearn/under_sampling/prototype_selection/tomek_links.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ class TomekLinks(BaseCleaningSampler):
-----
This method is based on [1]_.

Supports mutli-class resampling.
Supports mutli-class resampling. A one-vs.-rest scheme is used as
originally proposed in [1]_.

Examples
--------
Expand Down