test_dask.py 16.8 KB
Newer Older
1
# coding: utf-8
2
3
"""Tests for lightgbm.dask module"""

4
import socket
5
6
7
from itertools import groupby
from os import getenv
from sys import platform
8

9
import lightgbm as lgb
10
import pytest
11
if not platform.startswith('linux'):
12
    pytest.skip('lightgbm.dask is currently supported in Linux environments', allow_module_level=True)
13
14
if not lgb.compat.DASK_INSTALLED:
    pytest.skip('Dask is not installed', allow_module_level=True)
15
16
17
18
19

import dask.array as da
import dask.dataframe as dd
import numpy as np
import pandas as pd
20
from scipy.stats import spearmanr
21
22
from dask.array.utils import assert_eq
from distributed.utils_test import client, cluster_fixture, gen_cluster, loop
23
from scipy.sparse import csr_matrix
24
from sklearn.datasets import make_blobs, make_regression
25
from sklearn.utils import check_random_state
26

27
28
29
from .utils import make_ranking


30
31
data_output = ['array', 'scipy_csr_matrix', 'dataframe']
data_centers = [[[-4, -4], [4, 4]], [[-4, -4], [4, 4], [-4, 4]]]
32
group_sizes = [5, 5, 5, 10, 10, 10, 20, 20, 20, 50, 50]
33
34

pytestmark = [
35
36
    pytest.mark.skipif(getenv('TASK', '') == 'mpi', reason='Fails to run with MPI interface'),
    pytest.mark.skipif(getenv('TASK', '') == 'gpu', reason='Fails to run with GPU interface')
37
38
39
40
41
42
43
44
45
46
47
48
]


@pytest.fixture()
def listen_port():
    listen_port.port += 10
    return listen_port.port


listen_port.port = 13000


49
def _create_ranking_data(n_samples=100, output='array', chunk_size=50, **kwargs):
50
    X, y, g = make_ranking(n_samples=n_samples, random_state=42, **kwargs)
51
52
    rnd = np.random.RandomState(42)
    w = rnd.rand(X.shape[0]) * 0.01
53
    g_rle = np.array([len(list(grp)) for _, grp in groupby(g)])
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

    if output == 'dataframe':
        # add target, weight, and group to DataFrame so that partitions abide by group boundaries.
        X_df = pd.DataFrame(X, columns=[f'feature_{i}' for i in range(X.shape[1])])
        X = X_df.copy()
        X_df = X_df.assign(y=y, g=g, w=w)

        # set_index ensures partitions are based on group id.
        # See https://stackoverflow.com/questions/49532824/dask-dataframe-split-partitions-based-on-a-column-or-function.
        X_df.set_index('g', inplace=True)
        dX = dd.from_pandas(X_df, chunksize=chunk_size)

        # separate target, weight from features.
        dy = dX['y']
        dw = dX['w']
        dX = dX.drop(columns=['y', 'w'])
        dg = dX.index.to_series()

        # encode group identifiers into run-length encoding, the format LightGBMRanker is expecting
        # so that within each partition, sum(g) = n_samples.
        dg = dg.map_partitions(lambda p: p.groupby('g', sort=False).apply(lambda z: z.shape[0]))
    elif output == 'array':
        # ranking arrays: one chunk per group. Each chunk must include all columns.
        p = X.shape[1]
        dX, dy, dw, dg = [], [], [], []
        for g_idx, rhs in enumerate(np.cumsum(g_rle)):
            lhs = rhs - g_rle[g_idx]
            dX.append(da.from_array(X[lhs:rhs, :], chunks=(rhs - lhs, p)))
            dy.append(da.from_array(y[lhs:rhs]))
            dw.append(da.from_array(w[lhs:rhs]))
            dg.append(da.from_array(np.array([g_rle[g_idx]])))

        dX = da.concatenate(dX, axis=0)
        dy = da.concatenate(dy, axis=0)
        dw = da.concatenate(dw, axis=0)
        dg = da.concatenate(dg, axis=0)
    else:
        raise ValueError('Ranking data creation only supported for Dask arrays and dataframes')

    return X, y, w, g_rle, dX, dy, dw, dg


96
97
98
99
100
101
def _create_data(objective, n_samples=100, centers=2, output='array', chunk_size=50):
    if objective == 'classification':
        X, y = make_blobs(n_samples=n_samples, centers=centers, random_state=42)
    elif objective == 'regression':
        X, y = make_regression(n_samples=n_samples, random_state=42)
    else:
102
        raise ValueError("Unknown objective '%s'" % objective)
103
104
105
106
107
108
109
110
111
112
113
114
115
116
    rnd = np.random.RandomState(42)
    weights = rnd.random(X.shape[0]) * 0.01

    if output == 'array':
        dX = da.from_array(X, (chunk_size, X.shape[1]))
        dy = da.from_array(y, chunk_size)
        dw = da.from_array(weights, chunk_size)
    elif output == 'dataframe':
        X_df = pd.DataFrame(X, columns=['feature_%d' % i for i in range(X.shape[1])])
        y_df = pd.Series(y, name='target')
        dX = dd.from_pandas(X_df, chunksize=chunk_size)
        dy = dd.from_pandas(y_df, chunksize=chunk_size)
        dw = dd.from_array(weights, chunksize=chunk_size)
    elif output == 'scipy_csr_matrix':
117
        dX = da.from_array(X, chunks=(chunk_size, X.shape[1])).map_blocks(csr_matrix)
118
119
120
        dy = da.from_array(y, chunks=chunk_size)
        dw = da.from_array(weights, chunk_size)
    else:
121
        raise ValueError("Unknown output type '%s'" % output)
122
123
124
125

    return X, y, weights, dX, dy, dw


126
127
128
129
130
131
132
133
134
135
def _r2_score(dy_true, dy_pred):
    numerator = ((dy_true - dy_pred) ** 2).sum(axis=0, dtype=np.float64)
    denominator = ((dy_true - dy_pred.mean(axis=0)) ** 2).sum(axis=0, dtype=np.float64)
    return (1 - numerator / denominator).compute()


def _accuracy_score(dy_true, dy_pred):
    return da.average(dy_true == dy_pred).compute()


136
137
138
@pytest.mark.parametrize('output', data_output)
@pytest.mark.parametrize('centers', data_centers)
def test_classifier(output, centers, client, listen_port):
139
140
141
142
143
    X, y, w, dX, dy, dw = _create_data(
        objective='classification',
        output=output,
        centers=centers
    )
144

145
146
147
148
    params = {
        "n_estimators": 10,
        "num_leaves": 10
    }
149
    dask_classifier = lgb.DaskLGBMClassifier(
James Lamb's avatar
James Lamb committed
150
151
        time_out=5,
        local_listen_port=listen_port,
152
        **params
James Lamb's avatar
James Lamb committed
153
    )
154
155
    dask_classifier = dask_classifier.fit(dX, dy, sample_weight=dw, client=client)
    p1 = dask_classifier.predict(dX)
James Lamb's avatar
James Lamb committed
156
    p1_proba = dask_classifier.predict_proba(dX).compute()
157
    s1 = _accuracy_score(dy, p1)
158
159
    p1 = p1.compute()

160
    local_classifier = lgb.LGBMClassifier(**params)
161
162
    local_classifier.fit(X, y, sample_weight=w)
    p2 = local_classifier.predict(X)
James Lamb's avatar
James Lamb committed
163
    p2_proba = local_classifier.predict_proba(X)
164
165
166
167
168
169
    s2 = local_classifier.score(X, y)

    assert_eq(s1, s2)
    assert_eq(p1, p2)
    assert_eq(y, p1)
    assert_eq(y, p2)
James Lamb's avatar
James Lamb committed
170
    assert_eq(p1_proba, p2_proba, atol=0.3)
171

172
173
    client.close()

174

175
176
177
@pytest.mark.parametrize('output', data_output)
@pytest.mark.parametrize('centers', data_centers)
def test_classifier_pred_contrib(output, centers, client, listen_port):
178
179
180
181
182
    X, y, w, dX, dy, dw = _create_data(
        objective='classification',
        output=output,
        centers=centers
    )
183

184
185
186
187
    params = {
        "n_estimators": 10,
        "num_leaves": 10
    }
188
    dask_classifier = lgb.DaskLGBMClassifier(
189
190
191
        time_out=5,
        local_listen_port=listen_port,
        tree_learner='data',
192
        **params
193
194
195
196
    )
    dask_classifier = dask_classifier.fit(dX, dy, sample_weight=dw, client=client)
    preds_with_contrib = dask_classifier.predict(dX, pred_contrib=True).compute()

197
    local_classifier = lgb.LGBMClassifier(**params)
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
    local_classifier.fit(X, y, sample_weight=w)
    local_preds_with_contrib = local_classifier.predict(X, pred_contrib=True)

    if output == 'scipy_csr_matrix':
        preds_with_contrib = np.array(preds_with_contrib.todense())

    # shape depends on whether it is binary or multiclass classification
    num_features = dask_classifier.n_features_
    num_classes = dask_classifier.n_classes_
    if num_classes == 2:
        expected_num_cols = num_features + 1
    else:
        expected_num_cols = (num_features + 1) * num_classes

    # * shape depends on whether it is binary or multiclass classification
    # * matrix for binary classification is of the form [feature_contrib, base_value],
    #   for multi-class it's [feat_contrib_class1, base_value_class1, feat_contrib_class2, base_value_class2, etc.]
    # * contrib outputs for distributed training are different than from local training, so we can just test
    #   that the output has the right shape and base values are in the right position
    assert preds_with_contrib.shape[1] == expected_num_cols
    assert preds_with_contrib.shape == local_preds_with_contrib.shape

    if num_classes == 2:
        assert len(np.unique(preds_with_contrib[:, num_features]) == 1)
    else:
        for i in range(num_classes):
            base_value_col = num_features * (i + 1) + i
            assert len(np.unique(preds_with_contrib[:, base_value_col]) == 1)


228
229
230
231
232
233
def test_training_does_not_fail_on_port_conflicts(client):
    _, _, _, dX, dy, dw = _create_data('classification', output='array')

    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
        s.bind(('127.0.0.1', 12400))

234
        dask_classifier = lgb.DaskLGBMClassifier(
235
            time_out=5,
James Lamb's avatar
James Lamb committed
236
237
238
            local_listen_port=12400,
            n_estimators=5,
            num_leaves=5
239
        )
240
        for _ in range(5):
241
242
243
244
245
246
247
248
            dask_classifier.fit(
                X=dX,
                y=dy,
                sample_weight=dw,
                client=client
            )
            assert dask_classifier.booster_

249
250
    client.close()

251

252
def test_classifier_local_predict(client, listen_port):
253
254
255
256
    X, y, w, dX, dy, dw = _create_data(
        objective='classification',
        output='array'
    )
257

258
259
260
261
    params = {
        "n_estimators": 10,
        "num_leaves": 10
    }
262
    dask_classifier = lgb.DaskLGBMClassifier(
James Lamb's avatar
James Lamb committed
263
        time_out=5,
264
        local_port=listen_port,
265
        **params
James Lamb's avatar
James Lamb committed
266
    )
267
268
269
    dask_classifier = dask_classifier.fit(dX, dy, sample_weight=dw, client=client)
    p1 = dask_classifier.to_local().predict(dX)

270
    local_classifier = lgb.LGBMClassifier(**params)
271
272
273
274
275
276
277
    local_classifier.fit(X, y, sample_weight=w)
    p2 = local_classifier.predict(X)

    assert_eq(p1, p2)
    assert_eq(y, p1)
    assert_eq(y, p2)

278
279
    client.close()

280
281
282

@pytest.mark.parametrize('output', data_output)
def test_regressor(output, client, listen_port):
283
284
285
286
    X, y, w, dX, dy, dw = _create_data(
        objective='regression',
        output=output
    )
287

288
289
290
291
    params = {
        "random_state": 42,
        "num_leaves": 10
    }
292
    dask_regressor = lgb.DaskLGBMRegressor(
James Lamb's avatar
James Lamb committed
293
294
        time_out=5,
        local_listen_port=listen_port,
295
296
        tree='data',
        **params
James Lamb's avatar
James Lamb committed
297
    )
298
299
300
    dask_regressor = dask_regressor.fit(dX, dy, client=client, sample_weight=dw)
    p1 = dask_regressor.predict(dX)
    if output != 'dataframe':
301
        s1 = _r2_score(dy, p1)
302
303
    p1 = p1.compute()

304
    local_regressor = lgb.LGBMRegressor(**params)
305
306
307
308
309
310
311
312
313
314
315
316
    local_regressor.fit(X, y, sample_weight=w)
    s2 = local_regressor.score(X, y)
    p2 = local_regressor.predict(X)

    # Scores should be the same
    if output != 'dataframe':
        assert_eq(s1, s2, atol=.01)

    # Predictions should be roughly the same
    assert_eq(y, p1, rtol=1., atol=100.)
    assert_eq(y, p2, rtol=1., atol=50.)

317
318
    client.close()

319

320
321
@pytest.mark.parametrize('output', data_output)
def test_regressor_pred_contrib(output, client, listen_port):
322
323
324
325
    X, y, w, dX, dy, dw = _create_data(
        objective='regression',
        output=output
    )
326

327
328
329
330
    params = {
        "n_estimators": 10,
        "num_leaves": 10
    }
331
    dask_regressor = lgb.DaskLGBMRegressor(
332
333
334
        time_out=5,
        local_listen_port=listen_port,
        tree_learner='data',
335
        **params
336
337
338
339
    )
    dask_regressor = dask_regressor.fit(dX, dy, sample_weight=dw, client=client)
    preds_with_contrib = dask_regressor.predict(dX, pred_contrib=True).compute()

340
    local_regressor = lgb.LGBMRegressor(**params)
341
342
343
344
345
346
347
348
349
350
351
352
353
    local_regressor.fit(X, y, sample_weight=w)
    local_preds_with_contrib = local_regressor.predict(X, pred_contrib=True)

    if output == "scipy_csr_matrix":
        preds_with_contrib = np.array(preds_with_contrib.todense())

    # contrib outputs for distributed training are different than from local training, so we can just test
    # that the output has the right shape and base values are in the right position
    num_features = dX.shape[1]
    assert preds_with_contrib.shape[1] == num_features + 1
    assert preds_with_contrib.shape == local_preds_with_contrib.shape


354
355
356
@pytest.mark.parametrize('output', data_output)
@pytest.mark.parametrize('alpha', [.1, .5, .9])
def test_regressor_quantile(output, client, listen_port, alpha):
357
358
359
360
    X, y, w, dX, dy, dw = _create_data(
        objective='regression',
        output=output
    )
361

362
363
364
365
366
367
368
    params = {
        "objective": "quantile",
        "alpha": alpha,
        "random_state": 42,
        "n_estimators": 10,
        "num_leaves": 10
    }
369
    dask_regressor = lgb.DaskLGBMRegressor(
James Lamb's avatar
James Lamb committed
370
        local_listen_port=listen_port,
371
372
        tree_learner_type='data_parallel',
        **params
James Lamb's avatar
James Lamb committed
373
    )
374
375
376
377
    dask_regressor = dask_regressor.fit(dX, dy, client=client, sample_weight=dw)
    p1 = dask_regressor.predict(dX).compute()
    q1 = np.count_nonzero(y < p1) / y.shape[0]

378
    local_regressor = lgb.LGBMRegressor(**params)
379
380
381
382
383
384
385
386
    local_regressor.fit(X, y, sample_weight=w)
    p2 = local_regressor.predict(X)
    q2 = np.count_nonzero(y < p2) / y.shape[0]

    # Quantiles should be right
    np.testing.assert_allclose(q1, alpha, atol=0.2)
    np.testing.assert_allclose(q2, alpha, atol=0.2)

387
388
    client.close()

389
390

def test_regressor_local_predict(client, listen_port):
391
    X, y, _, dX, dy, dw = _create_data('regression', output='array')
392

393
    dask_regressor = lgb.DaskLGBMRegressor(
James Lamb's avatar
James Lamb committed
394
        local_listen_port=listen_port,
395
        random_state=42,
James Lamb's avatar
James Lamb committed
396
        n_estimators=10,
397
398
        num_leaves=10,
        tree_type='data'
James Lamb's avatar
James Lamb committed
399
    )
400
401
402
    dask_regressor = dask_regressor.fit(dX, dy, sample_weight=dw, client=client)
    p1 = dask_regressor.predict(dX)
    p2 = dask_regressor.to_local().predict(X)
403
    s1 = _r2_score(dy, p1)
404
405
406
407
408
409
410
    p1 = p1.compute()
    s2 = dask_regressor.to_local().score(X, y)

    # Predictions and scores should be the same
    assert_eq(p1, p2)
    assert_eq(s1, s2)

411
412
413
414
415
416
417
    client.close()


@pytest.mark.parametrize('output', ['array', 'dataframe'])
@pytest.mark.parametrize('group', [None, group_sizes])
def test_ranker(output, client, listen_port, group):

418
419
420
421
    X, y, w, g, dX, dy, dw, dg = _create_ranking_data(
        output=output,
        group=group
    )
422
423
424

    # use many trees + leaves to overfit, help ensure that dask data-parallel strategy matches that of
    # serial learner. See https://github.com/microsoft/LightGBM/issues/3292#issuecomment-671288210.
425
426
427
428
429
430
    params = {
        "random_state": 42,
        "n_estimators": 50,
        "num_leaves": 20,
        "min_child_samples": 1
    }
431
    dask_ranker = lgb.DaskLGBMRanker(
432
433
434
        time_out=5,
        local_listen_port=listen_port,
        tree_learner_type='data_parallel',
435
        **params
436
    )
437
438
439
440
    dask_ranker = dask_ranker.fit(dX, dy, sample_weight=dw, group=dg, client=client)
    rnkvec_dask = dask_ranker.predict(dX)
    rnkvec_dask = rnkvec_dask.compute()

441
    local_ranker = lgb.LGBMRanker(**params)
442
443
444
445
446
447
448
    local_ranker.fit(X, y, sample_weight=w, group=g)
    rnkvec_local = local_ranker.predict(X)

    # distributed ranker should be able to rank decently well and should
    # have high rank correlation with scores from serial ranker.
    dcor = spearmanr(rnkvec_dask, y).correlation
    assert dcor > 0.6
449
    assert spearmanr(rnkvec_dask, rnkvec_local).correlation > 0.75
450
451
452
453
454
455
456
457

    client.close()


@pytest.mark.parametrize('output', ['array', 'dataframe'])
@pytest.mark.parametrize('group', [None, group_sizes])
def test_ranker_local_predict(output, client, listen_port, group):

458
459
460
461
    X, y, w, g, dX, dy, dw, dg = _create_ranking_data(
        output=output,
        group=group
    )
462

463
    dask_ranker = lgb.DaskLGBMRanker(
464
465
466
467
468
        time_out=5,
        local_listen_port=listen_port,
        tree_learner='data',
        n_estimators=10,
        num_leaves=10,
469
        random_state=42,
470
471
        min_child_samples=1
    )
472
473
474
475
476
477
478
479
480
481
    dask_ranker = dask_ranker.fit(dX, dy, group=dg, client=client)
    rnkvec_dask = dask_ranker.predict(dX)
    rnkvec_dask = rnkvec_dask.compute()
    rnkvec_local = dask_ranker.to_local().predict(X)

    # distributed and to-local scores should be the same.
    assert_eq(rnkvec_dask, rnkvec_local)

    client.close()

482

483
484
485
486
def test_find_open_port_works():
    worker_ip = '127.0.0.1'
    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
        s.bind((worker_ip, 12400))
487
        new_port = lgb.dask._find_open_port(
488
489
490
491
492
493
494
495
496
497
            worker_ip=worker_ip,
            local_listen_port=12400,
            ports_to_skip=set()
        )
        assert new_port == 12401

    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s_1:
        s_1.bind((worker_ip, 12400))
        with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s_2:
            s_2.bind((worker_ip, 12401))
498
            new_port = lgb.dask._find_open_port(
499
500
501
502
503
                worker_ip=worker_ip,
                local_listen_port=12400,
                ports_to_skip=set()
            )
            assert new_port == 12402
504
505
506
507
508
509
510
511
512
513


@gen_cluster(client=True, timeout=None)
def test_errors(c, s, a, b):
    def f(part):
        raise Exception('foo')

    df = dd.demo.make_timeseries()
    df = df.map_partitions(f, meta=df._meta)
    with pytest.raises(Exception) as info:
514
        yield lgb.dask._train(
515
516
517
518
            client=c,
            data=df,
            label=df.x,
            params={},
519
            model_factory=lgb.LGBMClassifier
520
        )
521
        assert 'foo' in str(info.value)