Skip to content

Commit de12f8f

Browse files
authored
DOC mention which parameters is associated to which version of SMOTE (scikit-learn-contrib#269)
1 parent 1419016 commit de12f8f

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

imblearn/over_sampling/smote.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,20 +48,21 @@ class SMOTE(BaseBinarySampler):
4848
4949
m : int, optional (default=None)
5050
Number of nearest neighbours to use to determine if a minority sample
51-
is in danger.
51+
is in danger. Used with kind={'borderline1', 'borderline2', 'svm'}.
5252
5353
NOTE: `m` is deprecated from 0.2 and will be replaced in 0.4
5454
Use ``m_neighbors`` instead.
5555
5656
m_neighbors : int int or object, optional (default=10)
5757
If int, number of nearest neighbours to use to determine if a minority
58-
sample is in danger.
58+
sample is in danger. Used with kind={'borderline1', 'borderline2',
59+
'svm'}.
5960
If object, an estimator that inherits from
6061
`sklearn.neighbors.base.KNeighborsMixin` that will be used to find
6162
the k_neighbors.
6263
6364
out_step : float, optional (default=0.5)
64-
Step size when extrapolating.
65+
Step size when extrapolating. Used with kind='svm'.
6566
6667
kind : str, optional (default='regular')
6768
The type of SMOTE algorithm to use one of the following options:

0 commit comments

Comments
 (0)