sklearn.py 45.6 KB
Newer Older
wxchan's avatar
wxchan committed
1
# coding: utf-8
2
"""Scikit-learn wrapper interface for LightGBM."""
wxchan's avatar
wxchan committed
3
from __future__ import absolute_import
4

5
6
import warnings

wxchan's avatar
wxchan committed
7
import numpy as np
8

9
from .basic import Dataset, LightGBMError, _ConfigAliases
10
from .compat import (SKLEARN_INSTALLED, SKLEARN_VERSION, _LGBMClassifierBase,
11
12
                     LGBMNotFittedError, _LGBMLabelEncoder, _LGBMModelBase,
                     _LGBMRegressorBase, _LGBMCheckXY, _LGBMCheckArray, _LGBMCheckConsistentLength,
13
                     _LGBMAssertAllFinite, _LGBMCheckClassificationTargets, _LGBMComputeSampleWeight,
14
                     argc_, range_, zip_, string_type, DataFrame, DataTable)
wxchan's avatar
wxchan committed
15
from .engine import train
16

wxchan's avatar
wxchan committed
17

18
19
class _ObjectiveFunctionWrapper(object):
    """Proxy class for objective function."""
20

21
22
    def __init__(self, func):
        """Construct a proxy class.
23

24
25
        This class transforms objective function to match objective function with signature ``new_func(preds, dataset)``
        as expected by ``lightgbm.engine.train``.
26

27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
        Parameters
        ----------
        func : callable
            Expects a callable with signature ``func(y_true, y_pred)`` or ``func(y_true, y_pred, group)
            and returns (grad, hess):

                y_true : array-like of shape = [n_samples]
                    The target values.
                y_pred : array-like of shape = [n_samples] or shape = [n_samples * n_classes] (for multi-class task)
                    The predicted values.
                group : array-like
                    Group/query data, used for ranking task.
                grad : array-like of shape = [n_samples] or shape = [n_samples * n_classes] (for multi-class task)
                    The value of the first order derivative (gradient) for each sample point.
                hess : array-like of shape = [n_samples] or shape = [n_samples * n_classes] (for multi-class task)
                    The value of the second order derivative (Hessian) for each sample point.
wxchan's avatar
wxchan committed
43

Nikita Titov's avatar
Nikita Titov committed
44
45
46
47
48
        .. note::

            For multi-class task, the y_pred is group by class_id first, then group by row_id.
            If you want to get i-th row y_pred in j-th class, the access way is y_pred[j * num_data + i]
            and you should group grad and hess in this way as well.
49
50
        """
        self.func = func
wxchan's avatar
wxchan committed
51

52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
    def __call__(self, preds, dataset):
        """Call passed function with appropriate arguments.

        Parameters
        ----------
        preds : array-like of shape = [n_samples] or shape = [n_samples * n_classes] (for multi-class task)
            The predicted values.
        dataset : Dataset
            The training dataset.

        Returns
        -------
        grad : array-like of shape = [n_samples] or shape = [n_samples * n_classes] (for multi-class task)
            The value of the first order derivative (gradient) for each sample point.
        hess : array-like of shape = [n_samples] or shape = [n_samples * n_classes] (for multi-class task)
            The value of the second order derivative (Hessian) for each sample point.
        """
wxchan's avatar
wxchan committed
69
        labels = dataset.get_label()
70
        argc = argc_(self.func)
71
        if argc == 2:
72
            grad, hess = self.func(labels, preds)
73
        elif argc == 3:
74
            grad, hess = self.func(labels, preds, dataset.get_group())
75
        else:
wxchan's avatar
wxchan committed
76
            raise TypeError("Self-defined objective function should have 2 or 3 arguments, got %d" % argc)
wxchan's avatar
wxchan committed
77
78
79
80
81
82
83
84
85
86
87
        """weighted for objective"""
        weight = dataset.get_weight()
        if weight is not None:
            """only one class"""
            if len(weight) == len(grad):
                grad = np.multiply(grad, weight)
                hess = np.multiply(hess, weight)
            else:
                num_data = len(weight)
                num_class = len(grad) // num_data
                if num_class * num_data != len(grad):
88
                    raise ValueError("Length of grad and hess should equal to num_class * num_data")
wxchan's avatar
wxchan committed
89
90
                for k in range_(num_class):
                    for i in range_(num_data):
wxchan's avatar
wxchan committed
91
92
93
94
95
                        idx = k * num_data + i
                        grad[idx] *= weight[i]
                        hess[idx] *= weight[i]
        return grad, hess

wxchan's avatar
wxchan committed
96

97
98
class _EvalFunctionWrapper(object):
    """Proxy class for evaluation function."""
99

100
101
    def __init__(self, func):
        """Construct a proxy class.
102

103
104
        This class transforms evaluation function to match evaluation function with signature ``new_func(preds, dataset)``
        as expected by ``lightgbm.engine.train``.
105

106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
        Parameters
        ----------
        func : callable
            Expects a callable with following signatures:
            ``func(y_true, y_pred)``,
            ``func(y_true, y_pred, weight)``
            or ``func(y_true, y_pred, weight, group)``
            and returns (eval_name, eval_result, is_higher_better) or
            list of (eval_name, eval_result, is_higher_better):

                y_true : array-like of shape = [n_samples]
                    The target values.
                y_pred : array-like of shape = [n_samples] or shape = [n_samples * n_classes] (for multi-class task)
                    The predicted values.
                weight : array-like of shape = [n_samples]
                    The weight of samples.
                group : array-like
                    Group/query data, used for ranking task.
                eval_name : string
125
                    The name of evaluation function (without whitespaces).
126
127
128
129
130
                eval_result : float
                    The eval result.
                is_higher_better : bool
                    Is eval result higher better, e.g. AUC is ``is_higher_better``.

Nikita Titov's avatar
Nikita Titov committed
131
132
133
134
        .. note::

            For multi-class task, the y_pred is group by class_id first, then group by row_id.
            If you want to get i-th row y_pred in j-th class, the access way is y_pred[j * num_data + i].
135
136
        """
        self.func = func
137

138
139
    def __call__(self, preds, dataset):
        """Call passed function with appropriate arguments.
140

141
142
143
144
145
146
147
148
149
150
        Parameters
        ----------
        preds : array-like of shape = [n_samples] or shape = [n_samples * n_classes] (for multi-class task)
            The predicted values.
        dataset : Dataset
            The training dataset.

        Returns
        -------
        eval_name : string
151
            The name of evaluation function (without whitespaces).
152
153
154
155
156
        eval_result : float
            The eval result.
        is_higher_better : bool
            Is eval result higher better, e.g. AUC is ``is_higher_better``.
        """
157
        labels = dataset.get_label()
158
        argc = argc_(self.func)
159
        if argc == 2:
160
            return self.func(labels, preds)
161
        elif argc == 3:
162
            return self.func(labels, preds, dataset.get_weight())
163
        elif argc == 4:
164
            return self.func(labels, preds, dataset.get_weight(), dataset.get_group())
165
        else:
wxchan's avatar
wxchan committed
166
            raise TypeError("Self-defined eval function should have 2, 3 or 4 arguments, got %d" % argc)
167

wxchan's avatar
wxchan committed
168

169
170
class LGBMModel(_LGBMModelBase):
    """Implementation of the scikit-learn API for LightGBM."""
wxchan's avatar
wxchan committed
171

172
    def __init__(self, boosting_type='gbdt', num_leaves=31, max_depth=-1,
173
                 learning_rate=0.1, n_estimators=100,
174
                 subsample_for_bin=200000, objective=None, class_weight=None,
175
                 min_split_gain=0., min_child_weight=1e-3, min_child_samples=20,
176
                 subsample=1., subsample_freq=0, colsample_bytree=1.,
177
                 reg_alpha=0., reg_lambda=0., random_state=None,
178
                 n_jobs=-1, silent=True, importance_type='split', **kwargs):
179
        r"""Construct a gradient boosting model.
wxchan's avatar
wxchan committed
180
181
182

        Parameters
        ----------
183
        boosting_type : string, optional (default='gbdt')
184
185
186
187
188
            'gbdt', traditional Gradient Boosting Decision Tree.
            'dart', Dropouts meet Multiple Additive Regression Trees.
            'goss', Gradient-based One-Side Sampling.
            'rf', Random Forest.
        num_leaves : int, optional (default=31)
wxchan's avatar
wxchan committed
189
            Maximum tree leaves for base learners.
190
        max_depth : int, optional (default=-1)
191
            Maximum tree depth for base learners, <=0 means no limit.
192
        learning_rate : float, optional (default=0.1)
193
            Boosting learning rate.
194
195
196
            You can use ``callbacks`` parameter of ``fit`` method to shrink/adapt learning rate
            in training using ``reset_parameter`` callback.
            Note, that this will ignore the ``learning_rate`` argument in training.
197
        n_estimators : int, optional (default=100)
wxchan's avatar
wxchan committed
198
            Number of boosted trees to fit.
199
        subsample_for_bin : int, optional (default=200000)
wxchan's avatar
wxchan committed
200
            Number of samples for constructing bins.
201
        objective : string, callable or None, optional (default=None)
wxchan's avatar
wxchan committed
202
203
            Specify the learning task and the corresponding learning objective or
            a custom objective function to be used (see note below).
204
            Default: 'regression' for LGBMRegressor, 'binary' or 'multiclass' for LGBMClassifier, 'lambdarank' for LGBMRanker.
205
206
207
208
        class_weight : dict, 'balanced' or None, optional (default=None)
            Weights associated with classes in the form ``{class_label: weight}``.
            Use this parameter only for multi-class classification task;
            for binary classification task you may use ``is_unbalance`` or ``scale_pos_weight`` parameters.
209
210
211
            Note, that the usage of all these parameters will result in poor estimates of the individual class probabilities.
            You may want to consider performing probability calibration
            (https://scikit-learn.org/stable/modules/calibration.html) of your model.
212
213
214
            The 'balanced' mode uses the values of y to automatically adjust weights
            inversely proportional to class frequencies in the input data as ``n_samples / (n_classes * np.bincount(y))``.
            If None, all classes are supposed to have weight one.
215
            Note, that these weights will be multiplied with ``sample_weight`` (passed through the ``fit`` method)
216
            if ``sample_weight`` is specified.
217
        min_split_gain : float, optional (default=0.)
wxchan's avatar
wxchan committed
218
            Minimum loss reduction required to make a further partition on a leaf node of the tree.
219
        min_child_weight : float, optional (default=1e-3)
220
            Minimum sum of instance weight (hessian) needed in a child (leaf).
221
        min_child_samples : int, optional (default=20)
222
            Minimum number of data needed in a child (leaf).
223
        subsample : float, optional (default=1.)
wxchan's avatar
wxchan committed
224
            Subsample ratio of the training instance.
225
        subsample_freq : int, optional (default=0)
226
227
            Frequence of subsample, <=0 means no enable.
        colsample_bytree : float, optional (default=1.)
wxchan's avatar
wxchan committed
228
            Subsample ratio of columns when constructing each tree.
229
        reg_alpha : float, optional (default=0.)
230
            L1 regularization term on weights.
231
        reg_lambda : float, optional (default=0.)
232
            L2 regularization term on weights.
233
        random_state : int or None, optional (default=None)
wxchan's avatar
wxchan committed
234
            Random number seed.
235
            If None, default seeds in C++ code will be used.
236
        n_jobs : int, optional (default=-1)
237
            Number of parallel threads.
238
        silent : bool, optional (default=True)
wxchan's avatar
wxchan committed
239
            Whether to print messages while running boosting.
240
        importance_type : string, optional (default='split')
241
            The type of feature importance to be filled into ``feature_importances_``.
242
243
244
245
            If 'split', result contains numbers of times the feature is used in a model.
            If 'gain', result contains total gains of splits which use the feature.
        **kwargs
            Other parameters for the model.
wxchan's avatar
wxchan committed
246
            Check http://lightgbm.readthedocs.io/en/latest/Parameters.html for more parameters.
247

Nikita Titov's avatar
Nikita Titov committed
248
249
250
            .. warning::

                \*\*kwargs is not supported in sklearn, it may cause unexpected issues.
wxchan's avatar
wxchan committed
251

252
253
254
255
256
257
258
259
260
        Attributes
        ----------
        n_features_ : int
            The number of features of fitted model.
        classes_ : array of shape = [n_classes]
            The class label array (only for classification problem).
        n_classes_ : int
            The number of classes (only for classification problem).
        best_score_ : dict or None
261
            The best score of fitted model.
262
        best_iteration_ : int or None
263
            The best iteration of fitted model if ``early_stopping_rounds`` has been specified.
264
265
266
267
268
        objective_ : string or callable
            The concrete objective used while fitting this model.
        booster_ : Booster
            The underlying Booster of this model.
        evals_result_ : dict or None
269
            The evaluation results if ``early_stopping_rounds`` has been specified.
270
271
        feature_importances_ : array of shape = [n_features]
            The feature importances (the higher, the more important the feature).
272
273
        feature_name_ : array of shape = [n_features]
            The names of features.
274

wxchan's avatar
wxchan committed
275
276
        Note
        ----
277
278
        A custom objective function can be provided for the ``objective`` parameter.
        In this case, it should have the signature
279
280
        ``objective(y_true, y_pred) -> grad, hess`` or
        ``objective(y_true, y_pred, group) -> grad, hess``:
wxchan's avatar
wxchan committed
281

Nikita Titov's avatar
Nikita Titov committed
282
            y_true : array-like of shape = [n_samples]
283
                The target values.
Nikita Titov's avatar
Nikita Titov committed
284
            y_pred : array-like of shape = [n_samples] or shape = [n_samples * n_classes] (for multi-class task)
285
                The predicted values.
Nikita Titov's avatar
Nikita Titov committed
286
            group : array-like
287
                Group/query data, used for ranking task.
Nikita Titov's avatar
Nikita Titov committed
288
            grad : array-like of shape = [n_samples] or shape = [n_samples * n_classes] (for multi-class task)
289
                The value of the first order derivative (gradient) for each sample point.
Nikita Titov's avatar
Nikita Titov committed
290
            hess : array-like of shape = [n_samples] or shape = [n_samples * n_classes] (for multi-class task)
291
                The value of the second order derivative (Hessian) for each sample point.
wxchan's avatar
wxchan committed
292

293
294
295
        For multi-class task, the y_pred is group by class_id first, then group by row_id.
        If you want to get i-th row y_pred in j-th class, the access way is y_pred[j * num_data + i]
        and you should group grad and hess in this way as well.
wxchan's avatar
wxchan committed
296
        """
wxchan's avatar
wxchan committed
297
        if not SKLEARN_INSTALLED:
298
            raise LightGBMError('Scikit-learn is required for this module')
299
300
301
        elif SKLEARN_VERSION > '0.21.3':
            raise RuntimeError("The last supported version of scikit-learn is 0.21.3.\n"
                               "Found version: {0}.".format(SKLEARN_VERSION))
wxchan's avatar
wxchan committed
302

303
        self.boosting_type = boosting_type
304
        self.objective = objective
wxchan's avatar
wxchan committed
305
306
307
308
        self.num_leaves = num_leaves
        self.max_depth = max_depth
        self.learning_rate = learning_rate
        self.n_estimators = n_estimators
wxchan's avatar
wxchan committed
309
        self.subsample_for_bin = subsample_for_bin
wxchan's avatar
wxchan committed
310
311
312
313
314
315
316
317
        self.min_split_gain = min_split_gain
        self.min_child_weight = min_child_weight
        self.min_child_samples = min_child_samples
        self.subsample = subsample
        self.subsample_freq = subsample_freq
        self.colsample_bytree = colsample_bytree
        self.reg_alpha = reg_alpha
        self.reg_lambda = reg_lambda
318
319
        self.random_state = random_state
        self.n_jobs = n_jobs
wxchan's avatar
wxchan committed
320
        self.silent = silent
321
        self.importance_type = importance_type
wxchan's avatar
wxchan committed
322
        self._Booster = None
323
324
325
326
        self._evals_result = None
        self._best_score = None
        self._best_iteration = None
        self._other_params = {}
327
        self._objective = objective
328
        self.class_weight = class_weight
329
330
        self._class_weight = None
        self._class_map = None
331
332
333
        self._n_features = None
        self._classes = None
        self._n_classes = None
334
        self.set_params(**kwargs)
wxchan's avatar
wxchan committed
335

Nikita Titov's avatar
Nikita Titov committed
336
337
338
339
    def _more_tags(self):
        return {'allow_nan': True,
                'X_types': ['2darray', 'sparse', '1dlabels']}

wxchan's avatar
wxchan committed
340
    def get_params(self, deep=True):
341
342
343
344
345
346
347
348
349
350
351
352
353
        """Get parameters for this estimator.

        Parameters
        ----------
        deep : bool, optional (default=True)
            If True, will return the parameters for this estimator and
            contained subobjects that are estimators.

        Returns
        -------
        params : dict
            Parameter names mapped to their values.
        """
wxchan's avatar
wxchan committed
354
        params = super(LGBMModel, self).get_params(deep=deep)
355
        params.update(self._other_params)
wxchan's avatar
wxchan committed
356
357
358
        return params

    def set_params(self, **params):
359
360
361
362
363
364
365
366
367
368
369
370
        """Set the parameters of this estimator.

        Parameters
        ----------
        **params
            Parameter names with their new values.

        Returns
        -------
        self : object
            Returns self.
        """
wxchan's avatar
wxchan committed
371
372
        for key, value in params.items():
            setattr(self, key, value)
373
374
            if hasattr(self, '_' + key):
                setattr(self, '_' + key, value)
375
            self._other_params[key] = value
wxchan's avatar
wxchan committed
376
        return self
wxchan's avatar
wxchan committed
377

Guolin Ke's avatar
Guolin Ke committed
378
    def fit(self, X, y,
379
            sample_weight=None, init_score=None, group=None,
380
            eval_set=None, eval_names=None, eval_sample_weight=None,
381
382
            eval_class_weight=None, eval_init_score=None, eval_group=None,
            eval_metric=None, early_stopping_rounds=None, verbose=True,
383
384
            feature_name='auto', categorical_feature='auto',
            callbacks=None, init_model=None):
385
        """Build a gradient boosting model from the training set (X, y).
wxchan's avatar
wxchan committed
386
387
388

        Parameters
        ----------
389
390
391
392
393
394
395
396
        X : array-like or sparse matrix of shape = [n_samples, n_features]
            Input feature matrix.
        y : array-like of shape = [n_samples]
            The target values (class labels in classification, real numbers in regression).
        sample_weight : array-like of shape = [n_samples] or None, optional (default=None)
            Weights of training data.
        init_score : array-like of shape = [n_samples] or None, optional (default=None)
            Init score of training data.
397
        group : array-like or None, optional (default=None)
398
399
            Group data of training data.
        eval_set : list or None, optional (default=None)
400
            A list of (X, y) tuple pairs to use as validation sets.
401
        eval_names : list of strings or None, optional (default=None)
402
403
404
            Names of eval_set.
        eval_sample_weight : list of arrays or None, optional (default=None)
            Weights of eval data.
405
406
        eval_class_weight : list or None, optional (default=None)
            Class weights of eval data.
407
408
409
410
411
412
        eval_init_score : list of arrays or None, optional (default=None)
            Init score of eval data.
        eval_group : list of arrays or None, optional (default=None)
            Group data of eval data.
        eval_metric : string, list of strings, callable or None, optional (default=None)
            If string, it should be a built-in evaluation metric to use.
413
            If callable, it should be a custom evaluation metric, see note below for more details.
Misha Lisovyi's avatar
Misha Lisovyi committed
414
            In either case, the ``metric`` from the model parameters will be evaluated and used as well.
415
            Default: 'l2' for LGBMRegressor, 'logloss' for LGBMClassifier, 'ndcg' for LGBMRanker.
416
417
        early_stopping_rounds : int or None, optional (default=None)
            Activates early stopping. The model will train until the validation score stops improving.
418
            Validation score needs to improve at least every ``early_stopping_rounds`` round(s)
419
            to continue training.
420
421
            Requires at least one validation data and one metric.
            If there's more than one, will check all of them. But the training data is ignored anyway.
422
423
            To check only the first metric, set the ``first_metric_only`` parameter to ``True``
            in additional parameters ``**kwargs`` of the model constructor.
424
425
426
427
428
429
        verbose : bool or int, optional (default=True)
            Requires at least one evaluation data.
            If True, the eval metric on the eval set is printed at each boosting stage.
            If int, the eval metric on the eval set is printed at every ``verbose`` boosting stage.
            The last boosting stage or the boosting stage found by using ``early_stopping_rounds`` is also printed.

Nikita Titov's avatar
Nikita Titov committed
430
431
            .. rubric:: Example

432
433
434
            With ``verbose`` = 4 and at least one item in ``eval_set``,
            an evaluation metric is printed every 4 (instead of 1) boosting stages.

435
        feature_name : list of strings or 'auto', optional (default='auto')
436
437
            Feature names.
            If 'auto' and data is pandas DataFrame, data columns names are used.
438
        categorical_feature : list of strings or int, or 'auto', optional (default='auto')
439
440
            Categorical features.
            If list of int, interpreted as indices.
441
            If list of strings, interpreted as feature names (need to specify ``feature_name`` as well).
442
            If 'auto' and data is pandas DataFrame, pandas unordered categorical columns are used.
443
            All values in categorical features should be less than int32 max value (2147483647).
444
            Large values could be memory consuming. Consider using consecutive integers starting from zero.
445
            All negative values in categorical features will be treated as missing values.
446
            The output cannot be monotonically constrained with respect to a categorical feature.
447
        callbacks : list of callback functions or None, optional (default=None)
448
            List of callback functions that are applied at each iteration.
449
            See Callbacks in Python API for more information.
450
451
        init_model : string, Booster, LGBMModel or None, optional (default=None)
            Filename of LightGBM model, Booster instance or LGBMModel instance used for continue training.
452

453
454
455
456
457
        Returns
        -------
        self : object
            Returns self.

458
459
        Note
        ----
460
        Custom eval function expects a callable with following signatures:
461
        ``func(y_true, y_pred)``, ``func(y_true, y_pred, weight)`` or
462
        ``func(y_true, y_pred, weight, group)``
463
464
        and returns (eval_name, eval_result, is_higher_better) or
        list of (eval_name, eval_result, is_higher_better):
465

Nikita Titov's avatar
Nikita Titov committed
466
            y_true : array-like of shape = [n_samples]
467
                The target values.
468
            y_pred : array-like of shape = [n_samples] or shape = [n_samples * n_classes] (for multi-class task)
469
                The predicted values.
Nikita Titov's avatar
Nikita Titov committed
470
            weight : array-like of shape = [n_samples]
471
                The weight of samples.
Nikita Titov's avatar
Nikita Titov committed
472
            group : array-like
473
                Group/query data, used for ranking task.
Nikita Titov's avatar
Nikita Titov committed
474
            eval_name : string
475
                The name of evaluation function (without whitespaces).
Nikita Titov's avatar
Nikita Titov committed
476
            eval_result : float
477
                The eval result.
478
479
            is_higher_better : bool
                Is eval result higher better, e.g. AUC is ``is_higher_better``.
480

481
482
        For multi-class task, the y_pred is group by class_id first, then group by row_id.
        If you want to get i-th row y_pred in j-th class, the access way is y_pred[j * num_data + i].
wxchan's avatar
wxchan committed
483
        """
484
485
486
487
488
489
490
491
492
493
        if self._objective is None:
            if isinstance(self, LGBMRegressor):
                self._objective = "regression"
            elif isinstance(self, LGBMClassifier):
                self._objective = "binary"
            elif isinstance(self, LGBMRanker):
                self._objective = "lambdarank"
            else:
                raise ValueError("Unknown LGBMModel type.")
        if callable(self._objective):
494
            self._fobj = _ObjectiveFunctionWrapper(self._objective)
495
496
        else:
            self._fobj = None
wxchan's avatar
wxchan committed
497
498
        evals_result = {}
        params = self.get_params()
wxchan's avatar
wxchan committed
499
        # user can set verbose with kwargs, it has higher priority
500
        if not any(verbose_alias in params for verbose_alias in _ConfigAliases.get("verbosity")) and self.silent:
501
            params['verbose'] = -1
wxchan's avatar
wxchan committed
502
        params.pop('silent', None)
503
        params.pop('importance_type', None)
wxchan's avatar
wxchan committed
504
        params.pop('n_estimators', None)
505
        params.pop('class_weight', None)
506
507
        for alias in _ConfigAliases.get('objective'):
            params.pop(alias, None)
508
        if self._n_classes is not None and self._n_classes > 2:
509
510
            for alias in _ConfigAliases.get('num_class'):
                params.pop(alias, None)
511
512
            params['num_class'] = self._n_classes
        if hasattr(self, '_eval_at'):
513
514
            for alias in _ConfigAliases.get('eval_at'):
                params.pop(alias, None)
515
            params['eval_at'] = self._eval_at
516
517
        params['objective'] = self._objective
        if self._fobj:
wxchan's avatar
wxchan committed
518
            params['objective'] = 'None'  # objective = nullptr for unknown objective
wxchan's avatar
wxchan committed
519
520

        if callable(eval_metric):
521
            feval = _EvalFunctionWrapper(eval_metric)
wxchan's avatar
wxchan committed
522
523
        else:
            feval = None
524
525
526
527
528
529
530
531
532
533
534
            # register default metric for consistency with callable eval_metric case
            original_metric = self._objective if isinstance(self._objective, string_type) else None
            if original_metric is None:
                # try to deduce from class instance
                if isinstance(self, LGBMRegressor):
                    original_metric = "l2"
                elif isinstance(self, LGBMClassifier):
                    original_metric = "multi_logloss" if self._n_classes > 2 else "binary_logloss"
                elif isinstance(self, LGBMRanker):
                    original_metric = "ndcg"
            # overwrite default metric by explicitly set metric
535
            for metric_alias in _ConfigAliases.get("metric"):
536
537
538
539
540
                if metric_alias in params:
                    original_metric = params.pop(metric_alias)
            # concatenate metric from params (or default if not provided in params) and eval_metric
            original_metric = [original_metric] if isinstance(original_metric, (string_type, type(None))) else original_metric
            eval_metric = [eval_metric] if isinstance(eval_metric, (string_type, type(None))) else eval_metric
541
542
            params['metric'] = [e for e in eval_metric if e not in original_metric] + original_metric
            params['metric'] = [metric for metric in params['metric'] if metric is not None]
wxchan's avatar
wxchan committed
543

544
        if not isinstance(X, (DataFrame, DataTable)):
545
546
547
548
            _X, _y = _LGBMCheckXY(X, y, accept_sparse=True, force_all_finite=False, ensure_min_samples=2)
            _LGBMCheckConsistentLength(_X, _y, sample_weight)
        else:
            _X, _y = X, y
549

550
551
552
553
        if self._class_weight is None:
            self._class_weight = self.class_weight
        if self._class_weight is not None:
            class_sample_weight = _LGBMComputeSampleWeight(self._class_weight, y)
554
555
556
557
            if sample_weight is None or len(sample_weight) == 0:
                sample_weight = class_sample_weight
            else:
                sample_weight = np.multiply(sample_weight, class_sample_weight)
558

559
        self._n_features = _X.shape[1]
560

Guolin Ke's avatar
Guolin Ke committed
561
        def _construct_dataset(X, y, sample_weight, init_score, group, params):
562
563
            return Dataset(X, label=y, weight=sample_weight, group=group,
                           init_score=init_score, params=params)
Guolin Ke's avatar
Guolin Ke committed
564

565
        train_set = _construct_dataset(_X, _y, sample_weight, init_score, group, params)
Guolin Ke's avatar
Guolin Ke committed
566
567
568

        valid_sets = []
        if eval_set is not None:
569

570
            def _get_meta_data(collection, name, i):
571
572
573
574
575
576
577
                if collection is None:
                    return None
                elif isinstance(collection, list):
                    return collection[i] if len(collection) > i else None
                elif isinstance(collection, dict):
                    return collection.get(i, None)
                else:
578
                    raise TypeError('{} should be dict or list'.format(name))
579

Guolin Ke's avatar
Guolin Ke committed
580
581
582
            if isinstance(eval_set, tuple):
                eval_set = [eval_set]
            for i, valid_data in enumerate(eval_set):
583
                # reduce cost for prediction training data
Guolin Ke's avatar
Guolin Ke committed
584
585
586
                if valid_data[0] is X and valid_data[1] is y:
                    valid_set = train_set
                else:
587
588
589
590
591
592
                    valid_weight = _get_meta_data(eval_sample_weight, 'eval_sample_weight', i)
                    valid_class_weight = _get_meta_data(eval_class_weight, 'eval_class_weight', i)
                    if valid_class_weight is not None:
                        if isinstance(valid_class_weight, dict) and self._class_map is not None:
                            valid_class_weight = {self._class_map[k]: v for k, v in valid_class_weight.items()}
                        valid_class_sample_weight = _LGBMComputeSampleWeight(valid_class_weight, valid_data[1])
593
594
595
596
                        if valid_weight is None or len(valid_weight) == 0:
                            valid_weight = valid_class_sample_weight
                        else:
                            valid_weight = np.multiply(valid_weight, valid_class_sample_weight)
597
598
                    valid_init_score = _get_meta_data(eval_init_score, 'eval_init_score', i)
                    valid_group = _get_meta_data(eval_group, 'eval_group', i)
599
600
                    valid_set = _construct_dataset(valid_data[0], valid_data[1],
                                                   valid_weight, valid_init_score, valid_group, params)
Guolin Ke's avatar
Guolin Ke committed
601
602
                valid_sets.append(valid_set)

603
604
605
        if isinstance(init_model, LGBMModel):
            init_model = init_model.booster_

Guolin Ke's avatar
Guolin Ke committed
606
        self._Booster = train(params, train_set,
607
                              self.n_estimators, valid_sets=valid_sets, valid_names=eval_names,
wxchan's avatar
wxchan committed
608
                              early_stopping_rounds=early_stopping_rounds,
609
                              evals_result=evals_result, fobj=self._fobj, feval=feval,
Guolin Ke's avatar
Guolin Ke committed
610
                              verbose_eval=verbose, feature_name=feature_name,
611
                              categorical_feature=categorical_feature,
612
                              callbacks=callbacks, init_model=init_model)
wxchan's avatar
wxchan committed
613
614

        if evals_result:
615
            self._evals_result = evals_result
wxchan's avatar
wxchan committed
616
617

        if early_stopping_rounds is not None:
618
            self._best_iteration = self._Booster.best_iteration
619
620

        self._best_score = self._Booster.best_score
wxchan's avatar
wxchan committed
621
622

        # free dataset
623
        self._Booster.free_dataset()
wxchan's avatar
wxchan committed
624
        del train_set, valid_sets
wxchan's avatar
wxchan committed
625
626
        return self

627
    def predict(self, X, raw_score=False, num_iteration=None,
628
                pred_leaf=False, pred_contrib=False, **kwargs):
629
        """Return the predicted value for each sample.
wxchan's avatar
wxchan committed
630
631
632

        Parameters
        ----------
633
        X : array-like or sparse matrix of shape = [n_samples, n_features]
wxchan's avatar
wxchan committed
634
            Input features matrix.
635
636
        raw_score : bool, optional (default=False)
            Whether to predict raw scores.
637
        num_iteration : int or None, optional (default=None)
638
            Limit number of iterations in the prediction.
639
640
            If None, if the best iteration exists, it is used; otherwise, all trees are used.
            If <= 0, all trees are used (no limits).
641
642
643
644
        pred_leaf : bool, optional (default=False)
            Whether to predict leaf index.
        pred_contrib : bool, optional (default=False)
            Whether to predict feature contributions.
645

Nikita Titov's avatar
Nikita Titov committed
646
647
648
649
650
651
652
            .. note::

                If you want to get more explanations for your model's predictions using SHAP values,
                like SHAP interaction values,
                you can install the shap package (https://github.com/slundberg/shap).
                Note that unlike the shap package, with ``pred_contrib`` we return a matrix with an extra
                column, where the last column is the expected value.
653

654
655
        **kwargs
            Other parameters for the prediction.
wxchan's avatar
wxchan committed
656
657
658

        Returns
        -------
659
660
        predicted_result : array-like of shape = [n_samples] or shape = [n_samples, n_classes]
            The predicted values.
661
        X_leaves : array-like of shape = [n_samples, n_trees] or shape = [n_samples, n_trees * n_classes]
Nikita Titov's avatar
Nikita Titov committed
662
            If ``pred_leaf=True``, the predicted leaf of every tree for each sample.
663
664
        X_SHAP_values : array-like of shape = [n_samples, n_features + 1] or shape = [n_samples, (n_features + 1) * n_classes]
            If ``pred_contrib=True``, the feature contributions for each sample.
wxchan's avatar
wxchan committed
665
        """
666
667
        if self._n_features is None:
            raise LGBMNotFittedError("Estimator not fitted, call `fit` before exploiting the model.")
668
        if not isinstance(X, (DataFrame, DataTable)):
669
            X = _LGBMCheckArray(X, accept_sparse=True, force_all_finite=False)
670
671
672
673
674
675
        n_features = X.shape[1]
        if self._n_features != n_features:
            raise ValueError("Number of features of the model must "
                             "match the input. Model n_features_ is %s and "
                             "input n_features is %s "
                             % (self._n_features, n_features))
676
        return self._Booster.predict(X, raw_score=raw_score, num_iteration=num_iteration,
677
                                     pred_leaf=pred_leaf, pred_contrib=pred_contrib, **kwargs)
wxchan's avatar
wxchan committed
678

679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
    @property
    def n_features_(self):
        """Get the number of features of fitted model."""
        if self._n_features is None:
            raise LGBMNotFittedError('No n_features found. Need to call fit beforehand.')
        return self._n_features

    @property
    def best_score_(self):
        """Get the best score of fitted model."""
        if self._n_features is None:
            raise LGBMNotFittedError('No best_score found. Need to call fit beforehand.')
        return self._best_score

    @property
    def best_iteration_(self):
        """Get the best iteration of fitted model."""
        if self._n_features is None:
            raise LGBMNotFittedError('No best_iteration found. Need to call fit with early_stopping_rounds beforehand.')
        return self._best_iteration

    @property
    def objective_(self):
        """Get the concrete objective used while fitting this model."""
        if self._n_features is None:
            raise LGBMNotFittedError('No objective found. Need to call fit beforehand.')
        return self._objective

707
708
709
710
    @property
    def booster_(self):
        """Get the underlying lightgbm Booster of this model."""
        if self._Booster is None:
711
            raise LGBMNotFittedError('No booster found. Need to call fit beforehand.')
712
        return self._Booster
wxchan's avatar
wxchan committed
713

714
715
716
    @property
    def evals_result_(self):
        """Get the evaluation results."""
717
718
719
        if self._n_features is None:
            raise LGBMNotFittedError('No results found. Need to call fit with eval_set beforehand.')
        return self._evals_result
720
721

    @property
722
    def feature_importances_(self):
723
        """Get feature importances.
724

Nikita Titov's avatar
Nikita Titov committed
725
726
727
728
        .. note::

            ``importance_type`` attribute is passed to the function
            to configure the type of importance values to be extracted.
729
        """
730
731
        if self._n_features is None:
            raise LGBMNotFittedError('No feature_importances found. Need to call fit beforehand.')
732
        return self._Booster.feature_importance(importance_type=self.importance_type)
wxchan's avatar
wxchan committed
733

734
735
736
737
738
739
740
    @property
    def feature_name_(self):
        """Get feature name."""
        if self._n_features is None:
            raise LGBMNotFittedError('No feature_name found. Need to call fit beforehand.')
        return self._Booster.feature_name()

wxchan's avatar
wxchan committed
741

742
743
class LGBMRegressor(LGBMModel, _LGBMRegressorBase):
    """LightGBM regressor."""
wxchan's avatar
wxchan committed
744

Guolin Ke's avatar
Guolin Ke committed
745
746
    def fit(self, X, y,
            sample_weight=None, init_score=None,
747
            eval_set=None, eval_names=None, eval_sample_weight=None,
748
            eval_init_score=None, eval_metric=None, early_stopping_rounds=None,
749
750
            verbose=True, feature_name='auto', categorical_feature='auto',
            callbacks=None, init_model=None):
751
        """Docstring is inherited from the LGBMModel."""
752
753
        super(LGBMRegressor, self).fit(X, y, sample_weight=sample_weight,
                                       init_score=init_score, eval_set=eval_set,
754
                                       eval_names=eval_names,
755
756
757
758
759
                                       eval_sample_weight=eval_sample_weight,
                                       eval_init_score=eval_init_score,
                                       eval_metric=eval_metric,
                                       early_stopping_rounds=early_stopping_rounds,
                                       verbose=verbose, feature_name=feature_name,
760
                                       categorical_feature=categorical_feature,
761
                                       callbacks=callbacks, init_model=init_model)
Guolin Ke's avatar
Guolin Ke committed
762
763
        return self

764
765
766
    _base_doc = LGBMModel.fit.__doc__
    fit.__doc__ = (_base_doc[:_base_doc.find('eval_class_weight :')]
                   + _base_doc[_base_doc.find('eval_init_score :'):])
wxchan's avatar
wxchan committed
767

768
769
770

class LGBMClassifier(LGBMModel, _LGBMClassifierBase):
    """LightGBM classifier."""
wxchan's avatar
wxchan committed
771

Guolin Ke's avatar
Guolin Ke committed
772
773
    def fit(self, X, y,
            sample_weight=None, init_score=None,
774
            eval_set=None, eval_names=None, eval_sample_weight=None,
775
            eval_class_weight=None, eval_init_score=None, eval_metric=None,
wxchan's avatar
wxchan committed
776
            early_stopping_rounds=None, verbose=True,
777
778
            feature_name='auto', categorical_feature='auto',
            callbacks=None, init_model=None):
779
        """Docstring is inherited from the LGBMModel."""
780
        _LGBMAssertAllFinite(y)
781
782
        _LGBMCheckClassificationTargets(y)
        self._le = _LGBMLabelEncoder().fit(y)
783
        _y = self._le.transform(y)
784
785
786
        self._class_map = dict(zip_(self._le.classes_, self._le.transform(self._le.classes_)))
        if isinstance(self.class_weight, dict):
            self._class_weight = {self._class_map[k]: v for k, v in self.class_weight.items()}
787

788
789
790
        self._classes = self._le.classes_
        self._n_classes = len(self._classes)
        if self._n_classes > 2:
wxchan's avatar
wxchan committed
791
            # Switch to using a multiclass objective in the underlying LGBM instance
792
            ova_aliases = {"multiclassova", "multiclass_ova", "ova", "ovr"}
793
            if self._objective not in ova_aliases and not callable(self._objective):
794
                self._objective = "multiclass"
795
            if eval_metric in {'logloss', 'binary_logloss'}:
wxchan's avatar
wxchan committed
796
                eval_metric = "multi_logloss"
797
            elif eval_metric in {'error', 'binary_error'}:
wxchan's avatar
wxchan committed
798
799
                eval_metric = "multi_error"
        else:
800
            if eval_metric in {'logloss', 'multi_logloss'}:
wxchan's avatar
wxchan committed
801
                eval_metric = 'binary_logloss'
802
            elif eval_metric in {'error', 'multi_error'}:
wxchan's avatar
wxchan committed
803
                eval_metric = 'binary_error'
wxchan's avatar
wxchan committed
804

805
806
        # do not modify args, as it causes errors in model selection tools
        valid_sets = None
wxchan's avatar
wxchan committed
807
        if eval_set is not None:
808
809
            if isinstance(eval_set, tuple):
                eval_set = [eval_set]
810
            valid_sets = [None] * len(eval_set)
811
812
            for i, (valid_x, valid_y) in enumerate(eval_set):
                if valid_x is X and valid_y is y:
813
                    valid_sets[i] = (valid_x, _y)
814
                else:
815
                    valid_sets[i] = (valid_x, self._le.transform(valid_y))
816

817
        super(LGBMClassifier, self).fit(X, _y, sample_weight=sample_weight,
818
                                        init_score=init_score, eval_set=valid_sets,
819
                                        eval_names=eval_names,
820
                                        eval_sample_weight=eval_sample_weight,
821
                                        eval_class_weight=eval_class_weight,
822
823
824
825
                                        eval_init_score=eval_init_score,
                                        eval_metric=eval_metric,
                                        early_stopping_rounds=early_stopping_rounds,
                                        verbose=verbose, feature_name=feature_name,
826
                                        categorical_feature=categorical_feature,
827
                                        callbacks=callbacks, init_model=init_model)
wxchan's avatar
wxchan committed
828
829
        return self

830
    fit.__doc__ = LGBMModel.fit.__doc__
831

832
    def predict(self, X, raw_score=False, num_iteration=None,
833
                pred_leaf=False, pred_contrib=False, **kwargs):
834
        """Docstring is inherited from the LGBMModel."""
835
836
        result = self.predict_proba(X, raw_score, num_iteration,
                                    pred_leaf, pred_contrib, **kwargs)
837
        if callable(self._objective) or raw_score or pred_leaf or pred_contrib:
838
839
840
841
            return result
        else:
            class_index = np.argmax(result, axis=1)
            return self._le.inverse_transform(class_index)
wxchan's avatar
wxchan committed
842

843
844
    predict.__doc__ = LGBMModel.predict.__doc__

845
    def predict_proba(self, X, raw_score=False, num_iteration=None,
846
                      pred_leaf=False, pred_contrib=False, **kwargs):
847
        """Return the predicted probability for each class for each sample.
wxchan's avatar
wxchan committed
848
849
850

        Parameters
        ----------
851
        X : array-like or sparse matrix of shape = [n_samples, n_features]
wxchan's avatar
wxchan committed
852
            Input features matrix.
853
854
        raw_score : bool, optional (default=False)
            Whether to predict raw scores.
855
        num_iteration : int or None, optional (default=None)
856
            Limit number of iterations in the prediction.
857
858
            If None, if the best iteration exists, it is used; otherwise, all trees are used.
            If <= 0, all trees are used (no limits).
859
860
861
862
        pred_leaf : bool, optional (default=False)
            Whether to predict leaf index.
        pred_contrib : bool, optional (default=False)
            Whether to predict feature contributions.
863

Nikita Titov's avatar
Nikita Titov committed
864
865
866
867
868
869
870
            .. note::

                If you want to get more explanations for your model's predictions using SHAP values,
                like SHAP interaction values,
                you can install the shap package (https://github.com/slundberg/shap).
                Note that unlike the shap package, with ``pred_contrib`` we return a matrix with an extra
                column, where the last column is the expected value.
871

872
873
        **kwargs
            Other parameters for the prediction.
wxchan's avatar
wxchan committed
874
875
876

        Returns
        -------
877
878
        predicted_probability : array-like of shape = [n_samples, n_classes]
            The predicted probability for each class for each sample.
879
        X_leaves : array-like of shape = [n_samples, n_trees * n_classes]
880
            If ``pred_leaf=True``, the predicted leaf of every tree for each sample.
881
        X_SHAP_values : array-like of shape = [n_samples, (n_features + 1) * n_classes]
882
            If ``pred_contrib=True``, the feature contributions for each sample.
wxchan's avatar
wxchan committed
883
        """
884
885
        result = super(LGBMClassifier, self).predict(X, raw_score, num_iteration,
                                                     pred_leaf, pred_contrib, **kwargs)
886
887
888
889
890
891
        if callable(self._objective) and not (raw_score or pred_leaf or pred_contrib):
            warnings.warn("Cannot compute class probabilities or labels "
                          "due to the usage of customized objective function.\n"
                          "Returning raw scores instead.")
            return result
        elif self._n_classes > 2 or raw_score or pred_leaf or pred_contrib:
892
            return result
wxchan's avatar
wxchan committed
893
        else:
894
            return np.vstack((1. - result, result)).transpose()
895
896
897

    @property
    def classes_(self):
898
899
900
901
        """Get the class label array."""
        if self._classes is None:
            raise LGBMNotFittedError('No classes found. Need to call fit beforehand.')
        return self._classes
902
903
904

    @property
    def n_classes_(self):
905
906
907
908
        """Get the number of classes."""
        if self._n_classes is None:
            raise LGBMNotFittedError('No classes found. Need to call fit beforehand.')
        return self._n_classes
wxchan's avatar
wxchan committed
909

wxchan's avatar
wxchan committed
910

wxchan's avatar
wxchan committed
911
class LGBMRanker(LGBMModel):
912
    """LightGBM ranker."""
wxchan's avatar
wxchan committed
913

Guolin Ke's avatar
Guolin Ke committed
914
    def fit(self, X, y,
915
            sample_weight=None, init_score=None, group=None,
916
            eval_set=None, eval_names=None, eval_sample_weight=None,
917
            eval_init_score=None, eval_group=None, eval_metric=None,
918
            eval_at=[1, 2, 3, 4, 5], early_stopping_rounds=None, verbose=True,
919
920
            feature_name='auto', categorical_feature='auto',
            callbacks=None, init_model=None):
921
        """Docstring is inherited from the LGBMModel."""
922
        # check group data
Guolin Ke's avatar
Guolin Ke committed
923
        if group is None:
924
            raise ValueError("Should set group for ranking task")
wxchan's avatar
wxchan committed
925
926

        if eval_set is not None:
Guolin Ke's avatar
Guolin Ke committed
927
            if eval_group is None:
928
                raise ValueError("Eval_group cannot be None when eval_set is not None")
Guolin Ke's avatar
Guolin Ke committed
929
            elif len(eval_group) != len(eval_set):
930
                raise ValueError("Length of eval_group should be equal to eval_set")
931
932
933
934
            elif (isinstance(eval_group, dict)
                  and any(i not in eval_group or eval_group[i] is None for i in range_(len(eval_group)))
                  or isinstance(eval_group, list)
                  and any(group is None for group in eval_group)):
935
936
                raise ValueError("Should set group for all eval datasets for ranking task; "
                                 "if you use dict, the index should start from 0")
937

938
        self._eval_at = eval_at
939
940
        super(LGBMRanker, self).fit(X, y, sample_weight=sample_weight,
                                    init_score=init_score, group=group,
941
942
                                    eval_set=eval_set, eval_names=eval_names,
                                    eval_sample_weight=eval_sample_weight,
943
944
945
946
                                    eval_init_score=eval_init_score, eval_group=eval_group,
                                    eval_metric=eval_metric,
                                    early_stopping_rounds=early_stopping_rounds,
                                    verbose=verbose, feature_name=feature_name,
947
                                    categorical_feature=categorical_feature,
948
                                    callbacks=callbacks, init_model=init_model)
wxchan's avatar
wxchan committed
949
        return self
950

951
952
953
954
    _base_doc = LGBMModel.fit.__doc__
    fit.__doc__ = (_base_doc[:_base_doc.find('eval_class_weight :')]
                   + _base_doc[_base_doc.find('eval_init_score :'):])
    _base_doc = fit.__doc__
955
956
    _before_early_stop, _early_stop, _after_early_stop = _base_doc.partition('early_stopping_rounds :')
    fit.__doc__ = (_before_early_stop
957
                   + 'eval_at : list of int, optional (default=[1, 2, 3, 4, 5])\n'
958
959
                   + ' ' * 12 + 'The evaluation positions of the specified metric.\n'
                   + ' ' * 8 + _early_stop + _after_early_stop)