regression_objective.hpp 22.9 KB
Newer Older
Guolin Ke's avatar
Guolin Ke committed
1
2
3
#ifndef LIGHTGBM_OBJECTIVE_REGRESSION_OBJECTIVE_HPP_
#define LIGHTGBM_OBJECTIVE_REGRESSION_OBJECTIVE_HPP_

4
5
#include <LightGBM/meta.h>

Guolin Ke's avatar
Guolin Ke committed
6
#include <LightGBM/objective_function.h>
7
#include <LightGBM/utils/array_args.h>
Guolin Ke's avatar
Guolin Ke committed
8
9

namespace LightGBM {
10

11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
#define PercentileFun(T, data_reader, cnt_data, alpha) {\
  std::vector<T> ref_data(cnt_data);\
  for (data_size_t i = 0; i < cnt_data; ++i) {\
    ref_data[i] = data_reader(i);\
  }\
  const double float_pos = (1.0f - alpha) * cnt_data;\
  const data_size_t pos = static_cast<data_size_t>(float_pos);\
  if (pos < 1) {\
    return ref_data[ArrayArgs<T>::ArgMax(ref_data)];\
  } else if (pos >= cnt_data) {\
    return ref_data[ArrayArgs<T>::ArgMin(ref_data)];\
  } else {\
    const double bias = float_pos - pos;\
    if (pos > cnt_data / 2) {\
      ArrayArgs<T>::ArgMaxAtK(&ref_data, 0, cnt_data, pos - 1);\
      T v1 = ref_data[pos - 1];\
      T v2 = ref_data[pos + ArrayArgs<T>::ArgMax(ref_data.data() + pos, cnt_data - pos)];\
      return static_cast<T>(v1 - (v1 - v2) * bias);\
    } else {\
      ArrayArgs<T>::ArgMaxAtK(&ref_data, 0, cnt_data, pos);\
      T v2 = ref_data[pos];\
      T v1 = ref_data[ArrayArgs<T>::ArgMin(ref_data.data(), pos)];\
      return static_cast<T>(v1 - (v1 - v2) * bias);\
    }\
  }\
}\

#define WeightedPercentileFun(T, data_reader, weight_reader, cnt_data, alpha) {\
  std::vector<data_size_t> sorted_idx(cnt_data);\
  for (data_size_t i = 0; i < cnt_data; ++i) {\
    sorted_idx[i] = i;\
  }\
  std::sort(sorted_idx.begin(), sorted_idx.end(), [=](data_size_t a, data_size_t b) {return data_reader(a) < data_reader(b); });\
  std::vector<double> weighted_cdf(cnt_data);\
  weighted_cdf[0] = weight_reader(sorted_idx[0]);\
  for (data_size_t i = 1; i < cnt_data; ++i) {\
    weighted_cdf[i] = weighted_cdf[i - 1] + weight_reader(sorted_idx[i]);\
  }\
  double threshold = weighted_cdf[cnt_data - 1] * alpha;\
  size_t pos = std::upper_bound(weighted_cdf.begin(), weighted_cdf.end(), threshold) - weighted_cdf.begin();\
  if (pos == 0) {\
    return data_reader(sorted_idx[0]);\
  }\
  CHECK(threshold >= weighted_cdf[pos - 1]);\
  CHECK(threshold < weighted_cdf[pos]);\
  T v1 = data_reader(sorted_idx[pos - 1]);\
  T v2 = data_reader(sorted_idx[pos]);\
  return static_cast<T>((threshold - weighted_cdf[pos]) / (weighted_cdf[pos + 1] - weighted_cdf[pos]) * (v2 - v1) + v1);\
}\

Guolin Ke's avatar
Guolin Ke committed
61
/*!
62
* \brief Objective function for regression
Guolin Ke's avatar
Guolin Ke committed
63
64
65
*/
class RegressionL2loss: public ObjectiveFunction {
public:
Guolin Ke's avatar
Guolin Ke committed
66
  explicit RegressionL2loss(const Config& config) {
67
    sqrt_ = config.reg_sqrt;
Guolin Ke's avatar
Guolin Ke committed
68
69
  }

70
71
72
73
74
75
76
  explicit RegressionL2loss(const std::vector<std::string>& strs) {
    sqrt_ = false;
    for (auto str : strs) {
      if (str == std::string("sqrt")) {
        sqrt_ = true;
      }
    }
77
  }
78
  
Guolin Ke's avatar
Guolin Ke committed
79
80
81
82
83
84
  ~RegressionL2loss() {
  }

  void Init(const Metadata& metadata, data_size_t num_data) override {
    num_data_ = num_data;
    label_ = metadata.label();
85
86
    if (sqrt_) {
      trans_label_.resize(num_data_);
87
      #pragma omp parallel for schedule(static)
88
      for (data_size_t i = 0; i < num_data; ++i) {
89
        trans_label_[i] = Common::Sign(label_[i]) * std::sqrt(std::fabs(label_[i]));
90
91
92
      }
      label_ = trans_label_.data();
    }
Guolin Ke's avatar
Guolin Ke committed
93
94
95
    weights_ = metadata.weights();
  }

96
97
  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
Guolin Ke's avatar
Guolin Ke committed
98
    if (weights_ == nullptr) {
99
      #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
100
      for (data_size_t i = 0; i < num_data_; ++i) {
101
        gradients[i] = static_cast<score_t>(score[i] - label_[i]);
102
        hessians[i] = 1.0f;
Guolin Ke's avatar
Guolin Ke committed
103
104
      }
    } else {
105
      #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
106
      for (data_size_t i = 0; i < num_data_; ++i) {
107
108
        gradients[i] = static_cast<score_t>((score[i] - label_[i]) * weights_[i]);
        hessians[i] = static_cast<score_t>(weights_[i]);
Guolin Ke's avatar
Guolin Ke committed
109
110
111
112
      }
    }
  }

Guolin Ke's avatar
Guolin Ke committed
113
114
  const char* GetName() const override {
    return "regression";
Guolin Ke's avatar
Guolin Ke committed
115
116
  }

117
118
  void ConvertOutput(const double* input, double* output) const override {
    if (sqrt_) {
119
      output[0] = Common::Sign(input[0]) * input[0] * input[0];
120
121
122
123
124
    } else {
      output[0] = input[0];
    }
  }

125
126
127
  std::string ToString() const override {
    std::stringstream str_buf;
    str_buf << GetName();
128
129
130
    if (sqrt_) {
      str_buf << " sqrt";
    }
131
132
133
    return str_buf.str();
  }

134
135
136
137
138
139
140
141
  bool IsConstantHessian() const override {
    if (weights_ == nullptr) {
      return true;
    } else {
      return false;
    }
  }

142
143
144
145
146
147
148
149
150
  double BoostFromScore() const override {
    double suml = 0.0f;
    double sumw = 0.0f;
    if (weights_ != nullptr) {
      #pragma omp parallel for schedule(static) reduction(+:suml,sumw)
      for (data_size_t i = 0; i < num_data_; ++i) {
        suml += label_[i] * weights_[i];
        sumw += weights_[i];
      }
151
    } else {
152
153
154
155
156
      sumw = static_cast<double>(num_data_);
      #pragma omp parallel for schedule(static) reduction(+:suml)
      for (data_size_t i = 0; i < num_data_; ++i) {
        suml += label_[i];
      }
157
    }
158
    return suml / sumw;
159
  }
160

161
162
protected:
  bool sqrt_;
Guolin Ke's avatar
Guolin Ke committed
163
164
165
  /*! \brief Number of data */
  data_size_t num_data_;
  /*! \brief Pointer of label */
166
  const label_t* label_;
Guolin Ke's avatar
Guolin Ke committed
167
  /*! \brief Pointer of weights */
168
169
  const label_t* weights_;
  std::vector<label_t> trans_label_;
Guolin Ke's avatar
Guolin Ke committed
170
171
};

Guolin Ke's avatar
Guolin Ke committed
172
173
174
/*!
* \brief L1 regression loss
*/
175
class RegressionL1loss: public RegressionL2loss {
176
public:
Guolin Ke's avatar
Guolin Ke committed
177
  explicit RegressionL1loss(const Config& config): RegressionL2loss(config) {
178
  }
179

180
  explicit RegressionL1loss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
181
182
  }

183
184
  ~RegressionL1loss() {}

185
186
  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
187
    if (weights_ == nullptr) {
188
      #pragma omp parallel for schedule(static)
189
      for (data_size_t i = 0; i < num_data_; ++i) {
190
        const double diff = score[i] - label_[i];
191
192
        gradients[i] = static_cast<score_t>(Common::Sign(diff));
        hessians[i] = 1.0f;
193
194
      }
    } else {
195
      #pragma omp parallel for schedule(static)
196
      for (data_size_t i = 0; i < num_data_; ++i) {
197
        const double diff = score[i] - label_[i];
198
199
        gradients[i] = static_cast<score_t>(Common::Sign(diff) * weights_[i]);
        hessians[i] = weights_[i];
200
201
202
203
      }
    }
  }

204
205
206
207
208
209
210
211
212
213
214
215
216
  double BoostFromScore() const override {
    const double alpha = 0.5;
    if (weights_ != nullptr) {
      #define data_reader(i) (label_[i])
      #define weight_reader(i) (weights_[i])
      WeightedPercentileFun(label_t, data_reader, weight_reader, num_data_, alpha);
      #undef data_reader
      #undef weight_reader
    } else {
      #define data_reader(i) (label_[i])
      PercentileFun(label_t, data_reader, num_data_, alpha);
      #undef data_reader
    }
217
218
  }

219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
  bool IsRenewTreeOutput() const override { return true; }

  double RenewTreeOutput(double, const double* pred, 
                         const data_size_t* index_mapper,
                         const data_size_t* bagging_mapper,
                         data_size_t num_data_in_leaf) const override {
    const double alpha = 0.5;
    if (weights_ == nullptr) {
      if (bagging_mapper == nullptr) {
        #define data_reader(i) (label_[index_mapper[i]] - pred[index_mapper[i]])
        PercentileFun(double, data_reader, num_data_in_leaf, alpha);
        #undef data_reader
      } else {
        #define data_reader(i) (label_[bagging_mapper[index_mapper[i]]] - pred[bagging_mapper[index_mapper[i]]])
        PercentileFun(double, data_reader, num_data_in_leaf, alpha);
        #undef data_reader
      }
    } else {
      if (bagging_mapper == nullptr) {
        #define data_reader(i) (label_[index_mapper[i]] - pred[index_mapper[i]])
        #define weight_reader(i) (weights_[index_mapper[i]])
        WeightedPercentileFun(double, data_reader, weight_reader, num_data_in_leaf, alpha);
        #undef data_reader
        #undef weight_reader
      } else {
        #define data_reader(i) (label_[bagging_mapper[index_mapper[i]]] - pred[bagging_mapper[index_mapper[i]]])
        #define weight_reader(i) (weights_[bagging_mapper[index_mapper[i]]])
        WeightedPercentileFun(double, data_reader, weight_reader, num_data_in_leaf, alpha);
        #undef data_reader
        #undef weight_reader
      }
    }
251
252
  }

253
254
255
  const char* GetName() const override {
    return "regression_l1";
  }
256
257
};

Guolin Ke's avatar
Guolin Ke committed
258
259
260
/*!
* \brief Huber regression loss
*/
261
class RegressionHuberLoss: public RegressionL2loss {
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
262
public:
Guolin Ke's avatar
Guolin Ke committed
263
  explicit RegressionHuberLoss(const Config& config): RegressionL2loss(config) {
264
    alpha_ = static_cast<double>(config.alpha);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
265
266
  }

267
  explicit RegressionHuberLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
268
269
270

  }

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
271
  ~RegressionHuberLoss() {
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
272
273
  }

274
275
  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
276
    if (weights_ == nullptr) {
277
      #pragma omp parallel for schedule(static)
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
278
      for (data_size_t i = 0; i < num_data_; ++i) {
279
        const double diff = score[i] - label_[i];
280
        if (std::abs(diff) <= alpha_) {
281
          gradients[i] = static_cast<score_t>(diff);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
282
        } else {
283
          gradients[i] = static_cast<score_t>(Common::Sign(diff) * alpha_);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
284
        }
285
        hessians[i] = 1.0f;
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
286
287
      }
    } else {
288
      #pragma omp parallel for schedule(static)
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
289
      for (data_size_t i = 0; i < num_data_; ++i) {
290
        const double diff = score[i] - label_[i];
291
        if (std::abs(diff) <= alpha_) {
292
          gradients[i] = static_cast<score_t>(diff * weights_[i]);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
293
        } else {
294
          gradients[i] = static_cast<score_t>(Common::Sign(diff) * weights_[i] * alpha_);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
295
        }
296
        hessians[i] = static_cast<score_t>(weights_[i]);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
297
298
299
300
301
302
303
304
      }
    }
  }

  const char* GetName() const override {
    return "huber";
  }

305
306
  bool IsConstantHessian() const override {
    return false;
307
308
  }

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
309
310
private:
  /*! \brief delta for Huber loss */
311
  double alpha_;
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
312
313
};

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
314
315

// http://research.microsoft.com/en-us/um/people/zhang/INRIA/Publis/Tutorial-Estim/node24.html
316
class RegressionFairLoss: public RegressionL2loss {
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
317
public:
Guolin Ke's avatar
Guolin Ke committed
318
  explicit RegressionFairLoss(const Config& config): RegressionL2loss(config) {
319
    c_ = static_cast<double>(config.fair_c);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
320
321
  }

322
  explicit RegressionFairLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
323
324
325

  }

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
326
327
  ~RegressionFairLoss() {}

328
329
  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
330
    if (weights_ == nullptr) {
331
      #pragma omp parallel for schedule(static)
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
332
      for (data_size_t i = 0; i < num_data_; ++i) {
333
        const double x = score[i] - label_[i];
334
335
        gradients[i] = static_cast<score_t>(c_ * x / (std::fabs(x) + c_));
        hessians[i] = static_cast<score_t>(c_ * c_ / ((std::fabs(x) + c_) * (std::fabs(x) + c_)));
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
336
337
      }
    } else {
338
      #pragma omp parallel for schedule(static)
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
339
      for (data_size_t i = 0; i < num_data_; ++i) {
340
        const double x = score[i] - label_[i];
341
342
        gradients[i] = static_cast<score_t>(c_ * x / (std::fabs(x) + c_) * weights_[i]);
        hessians[i] = static_cast<score_t>(c_ * c_ / ((std::fabs(x) + c_) * (std::fabs(x) + c_)) * weights_[i]);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
343
344
345
346
347
348
349
350
      }
    }
  }

  const char* GetName() const override {
    return "fair";
  }

351
352
  bool IsConstantHessian() const override {
    return false;
353
354
  }

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
355
356
private:
  /*! \brief c for Fair loss */
357
  double c_;
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
358
359
};

360
361
362
363

/*!
* \brief Objective function for Poisson regression
*/
364
class RegressionPoissonLoss: public RegressionL2loss {
365
public:
Guolin Ke's avatar
Guolin Ke committed
366
  explicit RegressionPoissonLoss(const Config& config): RegressionL2loss(config) {
367
    max_delta_step_ = static_cast<double>(config.poisson_max_delta_step);
368
    if (sqrt_) {
369
      Log::Warning("Cannot use sqrt transform in %s Regression, will auto disable it", GetName());
370
371
      sqrt_ = false;
    }
372
373
  }

374
  explicit RegressionPoissonLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
375
376
377

  }

378
379
380
  ~RegressionPoissonLoss() {}

  void Init(const Metadata& metadata, data_size_t num_data) override {
381
    if (sqrt_) {
382
      Log::Warning("Cannot use sqrt transform in %s Regression, will auto disable it", GetName());
383
384
      sqrt_ = false;
    }
385
    RegressionL2loss::Init(metadata, num_data);
386
    // Safety check of labels
387
    label_t miny;
388
    double sumy;
389
    Common::ObtainMinMaxSum(label_, num_data_, &miny, (label_t*)nullptr, &sumy);
390
    if (miny < 0.0f) {
391
      Log::Fatal("[%s]: at least one target label is negative", GetName());
392
393
    }
    if (sumy == 0.0f) {
394
      Log::Fatal("[%s]: sum of labels is zero", GetName());
395
    }
396
397
  }

398
399
400
401
402
403
404
405
406
  /* Parametrize with unbounded internal score "f"; then
   *  loss = exp(f) - label * f
   *  grad = exp(f) - label
   *  hess = exp(f)
   *
   * And the output is exp(f); so the associated metric get s=exp(f)
   * so that its loss = s - label * log(s); a little awkward maybe.
   *
   */
407
408
  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
409
    if (weights_ == nullptr) {
410
      #pragma omp parallel for schedule(static)
411
      for (data_size_t i = 0; i < num_data_; ++i) {
412
413
        gradients[i] = static_cast<score_t>(std::exp(score[i]) - label_[i]);
        hessians[i] = static_cast<score_t>(std::exp(score[i] + max_delta_step_));
414
415
      }
    } else {
416
      #pragma omp parallel for schedule(static)
417
      for (data_size_t i = 0; i < num_data_; ++i) {
418
419
        gradients[i] = static_cast<score_t>((std::exp(score[i]) - label_[i]) * weights_[i]);
        hessians[i] = static_cast<score_t>(std::exp(score[i] + max_delta_step_) * weights_[i]);
420
421
422
423
      }
    }
  }

424
425
426
427
  void ConvertOutput(const double* input, double* output) const override {
    output[0] = std::exp(input[0]);
  }

428
429
430
431
  const char* GetName() const override {
    return "poisson";
  }

432
433
  double BoostFromScore() const override {
    return std::log(RegressionL2loss::BoostFromScore());
434
435
  }

436
437
438
439
  bool IsConstantHessian() const override {
    return false;
  }

440
441
442
443
444
private:
  /*! \brief used to safeguard optimization */
  double max_delta_step_;
};

445
446
class RegressionQuantileloss : public RegressionL2loss {
public:
Guolin Ke's avatar
Guolin Ke committed
447
  explicit RegressionQuantileloss(const Config& config): RegressionL2loss(config) {
448
    alpha_ = static_cast<score_t>(config.alpha);
Guolin Ke's avatar
Guolin Ke committed
449
    CHECK(alpha_ > 0 && alpha_ < 1);
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
  }

  explicit RegressionQuantileloss(const std::vector<std::string>& strs): RegressionL2loss(strs) {

  }

  ~RegressionQuantileloss() {}

  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
    if (weights_ == nullptr) {
      #pragma omp parallel for schedule(static)
      for (data_size_t i = 0; i < num_data_; ++i) {
        score_t delta = static_cast<score_t>(score[i] - label_[i]);
        if (delta >= 0) {
          gradients[i] = (1.0f - alpha_);
        } else {
          gradients[i] = -alpha_;
        }
        hessians[i] = 1.0f;
      }
    } else {
      #pragma omp parallel for schedule(static)
      for (data_size_t i = 0; i < num_data_; ++i) {
        score_t delta = static_cast<score_t>(score[i] - label_[i]);
        if (delta >= 0) {
476
          gradients[i] = static_cast<score_t>((1.0f - alpha_) * weights_[i]);
477
        } else {
478
          gradients[i] = static_cast<score_t>(-alpha_ * weights_[i]);
479
        }
480
        hessians[i] = static_cast<score_t>(weights_[i]);
481
482
483
484
485
486
487
488
      }
    }
  }

  const char* GetName() const override {
    return "quantile";
  }

489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
  double BoostFromScore() const override {
    if (weights_ != nullptr) {
      #define data_reader(i) (label_[i])
      #define weight_reader(i) (weights_[i])
      WeightedPercentileFun(label_t, data_reader, weight_reader, num_data_, alpha_);
      #undef data_reader
      #undef weight_reader
    } else {
      #define data_reader(i) (label_[i])
      PercentileFun(label_t, data_reader, num_data_, alpha_);
      #undef data_reader
    }
  }

  bool IsRenewTreeOutput() const override { return true; }

  double RenewTreeOutput(double, const double* pred,
                         const data_size_t* index_mapper,
                         const data_size_t* bagging_mapper,
                         data_size_t num_data_in_leaf) const override {
    if (weights_ == nullptr) {
      if (bagging_mapper == nullptr) {
        #define data_reader(i) (label_[index_mapper[i]] - pred[index_mapper[i]])
        PercentileFun(double, data_reader, num_data_in_leaf, alpha_);
        #undef data_reader
      } else {
        #define data_reader(i) (label_[bagging_mapper[index_mapper[i]]] - pred[bagging_mapper[index_mapper[i]]])
        PercentileFun(double, data_reader, num_data_in_leaf, alpha_);
        #undef data_reader
      }
    } else {
      if (bagging_mapper == nullptr) {
        #define data_reader(i) (label_[index_mapper[i]] - pred[index_mapper[i]])
        #define weight_reader(i) (weights_[index_mapper[i]])
        WeightedPercentileFun(double, data_reader, weight_reader, num_data_in_leaf, alpha_);
        #undef data_reader
        #undef weight_reader
      } else {
        #define data_reader(i) (label_[bagging_mapper[index_mapper[i]]] - pred[bagging_mapper[index_mapper[i]]])
        #define weight_reader(i) (weights_[bagging_mapper[index_mapper[i]]])
        WeightedPercentileFun(double, data_reader, weight_reader, num_data_in_leaf, alpha_);
        #undef data_reader
        #undef weight_reader
      }
    }
  }

536
537
538
539
private:
  score_t alpha_;
};

540
541
542
543
544

/*!
* \brief Mape Regression Loss
*/
class RegressionMAPELOSS : public RegressionL1loss {
545
public:
Guolin Ke's avatar
Guolin Ke committed
546
  explicit RegressionMAPELOSS(const Config& config) : RegressionL1loss(config) {
547
548
  }

549
  explicit RegressionMAPELOSS(const std::vector<std::string>& strs) : RegressionL1loss(strs) {
550
551
552

  }

553
554
555
556
557
558
  ~RegressionMAPELOSS() {}

  void Init(const Metadata& metadata, data_size_t num_data) override {
    RegressionL2loss::Init(metadata, num_data);
    for (data_size_t i = 0; i < num_data_; ++i) {
      if (std::fabs(label_[i]) < 1) {
559
        Log::Warning("Met 'abs(label) < 1', will convert them to '1' in MAPE objective and metric");
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
        break;
      }
    }
    label_weight_.resize(num_data);
    if (weights_ == nullptr) {
      #pragma omp parallel for schedule(static)
      for (data_size_t i = 0; i < num_data_; ++i) {
        label_weight_[i] = 1.0f / std::max(1.0f, std::fabs(label_[i]));
      }
    } else {
      #pragma omp parallel for schedule(static)
      for (data_size_t i = 0; i < num_data_; ++i) {
        label_weight_[i] = 1.0f / std::max(1.0f, std::fabs(label_[i])) * weights_[i];
      }
    }
  }
576
577
578
579
580
581

  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
    if (weights_ == nullptr) {
      #pragma omp parallel for schedule(static)
      for (data_size_t i = 0; i < num_data_; ++i) {
582
583
584
        const double diff = score[i] - label_[i];
        gradients[i] = static_cast<score_t>(Common::Sign(diff) * label_weight_[i]);
        hessians[i] = 1.0f;
585
586
587
588
      }
    } else {
      #pragma omp parallel for schedule(static)
      for (data_size_t i = 0; i < num_data_; ++i) {
589
590
591
        const double diff = score[i] - label_[i];
        gradients[i] = static_cast<score_t>(Common::Sign(diff) * label_weight_[i]);
        hessians[i] = weights_[i];
592
593
594
595
      }
    }
  }

596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
  double BoostFromScore() const override {
    const double alpha = 0.5;
    #define data_reader(i) (label_[i])
    #define weight_reader(i) (label_weight_[i])
    WeightedPercentileFun(label_t, data_reader, weight_reader, num_data_, alpha);
    #undef data_reader
    #undef weight_reader
  }

  bool IsRenewTreeOutput() const override { return true; }

  double RenewTreeOutput(double, const double* pred,
                         const data_size_t* index_mapper,
                         const data_size_t* bagging_mapper,
                         data_size_t num_data_in_leaf) const override {
    const double alpha = 0.5;
    if (bagging_mapper == nullptr) {
      #define data_reader(i) (label_[index_mapper[i]] - pred[index_mapper[i]])
      #define weight_reader(i) (label_weight_[index_mapper[i]])
      WeightedPercentileFun(double, data_reader, weight_reader, num_data_in_leaf, alpha);
      #undef data_reader
      #undef weight_reader
    } else {
      #define data_reader(i) (label_[bagging_mapper[index_mapper[i]]] - pred[bagging_mapper[index_mapper[i]]])
      #define weight_reader(i) (label_weight_[bagging_mapper[index_mapper[i]]])
      WeightedPercentileFun(double, data_reader, weight_reader, num_data_in_leaf, alpha);
      #undef data_reader
      #undef weight_reader
    }
625
626
627
  }

  const char* GetName() const override {
628
629
630
631
632
    return "mape";
  }

  bool IsConstantHessian() const override {
    return true;
633
634
635
  }

private:
636
637
  std::vector<label_t> label_weight_;

638
639
};

Guolin Ke's avatar
Guolin Ke committed
640
641
642
643
644
645
646


/*!
* \brief Objective function for Gamma regression
*/
class RegressionGammaLoss : public RegressionPoissonLoss {
public:
Guolin Ke's avatar
Guolin Ke committed
647
  explicit RegressionGammaLoss(const Config& config) : RegressionPoissonLoss(config) {
Guolin Ke's avatar
Guolin Ke committed
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
  }

  explicit RegressionGammaLoss(const std::vector<std::string>& strs) : RegressionPoissonLoss(strs) {

  }

  ~RegressionGammaLoss() {}

  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
    if (weights_ == nullptr) {
      #pragma omp parallel for schedule(static)
      for (data_size_t i = 0; i < num_data_; ++i) {
        gradients[i] = static_cast<score_t>(1.0 - label_[i] / std::exp(score[i]));
        hessians[i] = static_cast<score_t>(label_[i] / std::exp(score[i]));
      }
    } else {
      #pragma omp parallel for schedule(static)
      for (data_size_t i = 0; i < num_data_; ++i) {
        gradients[i] = static_cast<score_t>(1.0 - label_[i] / std::exp(score[i]) * weights_[i]);
        hessians[i] = static_cast<score_t>(label_[i] / std::exp(score[i]) * weights_[i]);
      }
    }
  }

  const char* GetName() const override {
    return "gamma";
  }
 
};

/*!
* \brief Objective function for Tweedie regression
*/
class RegressionTweedieLoss: public RegressionPoissonLoss {
public:
Guolin Ke's avatar
Guolin Ke committed
684
  explicit RegressionTweedieLoss(const Config& config) : RegressionPoissonLoss(config) {
Guolin Ke's avatar
Guolin Ke committed
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
    rho_ = config.tweedie_variance_power;
  }

  explicit RegressionTweedieLoss(const std::vector<std::string>& strs) : RegressionPoissonLoss(strs) {

  }

  ~RegressionTweedieLoss() {}

  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
    if (weights_ == nullptr) {
      #pragma omp parallel for schedule(static)
      for (data_size_t i = 0; i < num_data_; ++i) {
        gradients[i] = static_cast<score_t>(-label_[i] * std::exp((1 - rho_) * score[i]) + std::exp((2 - rho_) * score[i]));
        hessians[i] = static_cast<score_t>(-label_[i] * (1 - rho_) * std::exp((1 - rho_) * score[i]) + 
          (2 - rho_) * std::exp((2 - rho_) * score[i]));
      }
    } else {
      #pragma omp parallel for schedule(static)
      for (data_size_t i = 0; i < num_data_; ++i) {
        gradients[i] = static_cast<score_t>((-label_[i] * std::exp((1 - rho_) * score[i]) + std::exp((2 - rho_) * score[i])) * weights_[i]);
        hessians[i] = static_cast<score_t>((-label_[i] * (1 - rho_) * std::exp((1 - rho_) * score[i]) +
          (2 - rho_) * std::exp((2 - rho_) * score[i])) * weights_[i]);
      }
    }
  }

  const char* GetName() const override {
    return "tweedie";
  }
private:
  double rho_;
};

720
721
722
#undef PercentileFun
#undef WeightedPercentileFun

Guolin Ke's avatar
Guolin Ke committed
723
}  // namespace LightGBM
Guolin Ke's avatar
Guolin Ke committed
724
#endif   // LightGBM_OBJECTIVE_REGRESSION_OBJECTIVE_HPP_