regression_objective.hpp 26.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_

Guolin Ke's avatar
Guolin Ke committed
4
#include <LightGBM/objective_function.h>
5
6
#include <LightGBM/meta.h>

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

namespace LightGBM {
10

11
#define PercentileFun(T, data_reader, cnt_data, alpha) {\
12
  if (cnt_data <= 1) { return  data_reader(0); }\
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
  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) {\
40
  if (cnt_data <= 1) { return  data_reader(0); }\
41
42
43
44
  std::vector<data_size_t> sorted_idx(cnt_data);\
  for (data_size_t i = 0; i < cnt_data; ++i) {\
    sorted_idx[i] = i;\
  }\
45
  std::stable_sort(sorted_idx.begin(), sorted_idx.end(), [=](data_size_t a, data_size_t b) {return data_reader(a) < data_reader(b); });\
46
47
48
49
50
51
52
  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();\
53
  pos = std::min(pos, static_cast<size_t>(cnt_data -1));\
Guolin Ke's avatar
Guolin Ke committed
54
  if (pos == 0 || pos ==  static_cast<size_t>(cnt_data - 1)) {\
55
    return data_reader(sorted_idx[pos]);\
56
57
58
59
60
61
62
63
  }\
  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
64
/*!
65
* \brief Objective function for regression
Guolin Ke's avatar
Guolin Ke committed
66
67
68
*/
class RegressionL2loss: public ObjectiveFunction {
public:
Guolin Ke's avatar
Guolin Ke committed
69
  explicit RegressionL2loss(const Config& config) {
70
    sqrt_ = config.reg_sqrt;
Guolin Ke's avatar
Guolin Ke committed
71
72
  }

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

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

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

Guolin Ke's avatar
Guolin Ke committed
116
117
  const char* GetName() const override {
    return "regression";
Guolin Ke's avatar
Guolin Ke committed
118
119
  }

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

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

137
138
139
140
141
142
143
144
  bool IsConstantHessian() const override {
    if (weights_ == nullptr) {
      return true;
    } else {
      return false;
    }
  }

145
  double BoostFromScore(int) const override {
146
147
148
149
150
151
152
153
    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];
      }
154
    } else {
155
156
157
158
159
      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];
      }
160
    }
161
    return suml / sumw;
162
  }
163

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

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

183
  explicit RegressionL1loss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
184
185
  }

186
187
  ~RegressionL1loss() {}

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

207
  double BoostFromScore(int) const override {
208
209
210
211
212
213
214
215
216
217
218
219
    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
    }
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
251
252
253
  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
      }
    }
254
255
  }

Guolin Ke's avatar
Guolin Ke committed
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
  double RenewTreeOutput(double, 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)
        PercentileFun(double, data_reader, num_data_in_leaf, alpha);
        #undef data_reader
      } else {
        #define data_reader(i) (label_[bagging_mapper[index_mapper[i]]] - pred)
        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)
        #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)
        #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
      }
    }
  }

288
289
290
  const char* GetName() const override {
    return "regression_l1";
  }
291
292
};

Guolin Ke's avatar
Guolin Ke committed
293
294
295
/*!
* \brief Huber regression loss
*/
296
class RegressionHuberLoss: public RegressionL2loss {
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
297
public:
Guolin Ke's avatar
Guolin Ke committed
298
  explicit RegressionHuberLoss(const Config& config): RegressionL2loss(config) {
299
    alpha_ = static_cast<double>(config.alpha);
Guolin Ke's avatar
Guolin Ke committed
300
301
302
303
    if (sqrt_) {
      Log::Warning("Cannot use sqrt transform in %s Regression, will auto disable it", GetName());
      sqrt_ = false;
    }
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
304
305
  }

306
  explicit RegressionHuberLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
Guolin Ke's avatar
Guolin Ke committed
307
308
309
310
    if (sqrt_) {
      Log::Warning("Cannot use sqrt transform in %s Regression, will auto disable it", GetName());
      sqrt_ = false;
    }
311
312
  }

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
313
  ~RegressionHuberLoss() {
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
314
315
  }

316
317
  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
318
    if (weights_ == nullptr) {
319
      #pragma omp parallel for schedule(static)
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
320
      for (data_size_t i = 0; i < num_data_; ++i) {
321
        const double diff = score[i] - label_[i];
322
        if (std::abs(diff) <= alpha_) {
323
          gradients[i] = static_cast<score_t>(diff);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
324
        } else {
325
          gradients[i] = static_cast<score_t>(Common::Sign(diff) * alpha_);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
326
        }
327
        hessians[i] = 1.0f;
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
328
329
      }
    } else {
330
      #pragma omp parallel for schedule(static)
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
331
      for (data_size_t i = 0; i < num_data_; ++i) {
332
        const double diff = score[i] - label_[i];
333
        if (std::abs(diff) <= alpha_) {
334
          gradients[i] = static_cast<score_t>(diff * weights_[i]);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
335
        } else {
336
          gradients[i] = static_cast<score_t>(Common::Sign(diff) * weights_[i] * alpha_);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
337
        }
338
        hessians[i] = static_cast<score_t>(weights_[i]);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
339
340
341
342
343
344
345
346
      }
    }
  }

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

347
348
  bool IsConstantHessian() const override {
    return false;
349
350
  }

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
351
352
private:
  /*! \brief delta for Huber loss */
353
  double alpha_;
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
354
355
};

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
356
357

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

364
  explicit RegressionFairLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
365
366
367

  }

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
368
369
  ~RegressionFairLoss() {}

370
371
  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
372
    if (weights_ == nullptr) {
373
      #pragma omp parallel for schedule(static)
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
374
      for (data_size_t i = 0; i < num_data_; ++i) {
375
        const double x = score[i] - label_[i];
376
377
        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
378
379
      }
    } else {
380
      #pragma omp parallel for schedule(static)
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
381
      for (data_size_t i = 0; i < num_data_; ++i) {
382
        const double x = score[i] - label_[i];
383
384
        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
385
386
387
388
389
390
391
392
      }
    }
  }

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

393
394
  bool IsConstantHessian() const override {
    return false;
395
396
  }

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
397
398
private:
  /*! \brief c for Fair loss */
399
  double c_;
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
400
401
};

402
403
404
405

/*!
* \brief Objective function for Poisson regression
*/
406
class RegressionPoissonLoss: public RegressionL2loss {
407
public:
Guolin Ke's avatar
Guolin Ke committed
408
  explicit RegressionPoissonLoss(const Config& config): RegressionL2loss(config) {
409
    max_delta_step_ = static_cast<double>(config.poisson_max_delta_step);
410
    if (sqrt_) {
411
      Log::Warning("Cannot use sqrt transform in %s Regression, will auto disable it", GetName());
412
413
      sqrt_ = false;
    }
414
415
  }

416
  explicit RegressionPoissonLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
417
418
419

  }

420
421
422
  ~RegressionPoissonLoss() {}

  void Init(const Metadata& metadata, data_size_t num_data) override {
423
    if (sqrt_) {
424
      Log::Warning("Cannot use sqrt transform in %s Regression, will auto disable it", GetName());
425
426
      sqrt_ = false;
    }
427
    RegressionL2loss::Init(metadata, num_data);
428
    // Safety check of labels
429
    label_t miny;
430
    double sumy;
431
    Common::ObtainMinMaxSum(label_, num_data_, &miny, (label_t*)nullptr, &sumy);
432
    if (miny < 0.0f) {
433
      Log::Fatal("[%s]: at least one target label is negative", GetName());
434
435
    }
    if (sumy == 0.0f) {
436
      Log::Fatal("[%s]: sum of labels is zero", GetName());
437
    }
438
439
  }

440
441
442
443
444
445
446
447
448
  /* 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.
   *
   */
449
450
  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
451
    if (weights_ == nullptr) {
452
      #pragma omp parallel for schedule(static)
453
      for (data_size_t i = 0; i < num_data_; ++i) {
454
455
        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_));
456
457
      }
    } else {
458
      #pragma omp parallel for schedule(static)
459
      for (data_size_t i = 0; i < num_data_; ++i) {
460
461
        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]);
462
463
464
465
      }
    }
  }

466
467
468
469
  void ConvertOutput(const double* input, double* output) const override {
    output[0] = std::exp(input[0]);
  }

470
471
472
473
  const char* GetName() const override {
    return "poisson";
  }

474
475
  double BoostFromScore(int) const override {
    return std::log(RegressionL2loss::BoostFromScore(0));
476
477
  }

478
479
480
481
  bool IsConstantHessian() const override {
    return false;
  }

482
483
484
485
486
private:
  /*! \brief used to safeguard optimization */
  double max_delta_step_;
};

487
488
class RegressionQuantileloss : public RegressionL2loss {
public:
Guolin Ke's avatar
Guolin Ke committed
489
  explicit RegressionQuantileloss(const Config& config): RegressionL2loss(config) {
490
    alpha_ = static_cast<score_t>(config.alpha);
Guolin Ke's avatar
Guolin Ke committed
491
    CHECK(alpha_ > 0 && alpha_ < 1);
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
  }

  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) {
518
          gradients[i] = static_cast<score_t>((1.0f - alpha_) * weights_[i]);
519
        } else {
520
          gradients[i] = static_cast<score_t>(-alpha_ * weights_[i]);
521
        }
522
        hessians[i] = static_cast<score_t>(weights_[i]);
523
524
525
526
527
528
529
530
      }
    }
  }

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

531
  double BoostFromScore(int) const override {
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
    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
      }
    }
  }

Guolin Ke's avatar
Guolin Ke committed
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
  double RenewTreeOutput(double, 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)
        PercentileFun(double, data_reader, num_data_in_leaf, alpha_);
        #undef data_reader
      } else {
        #define data_reader(i) (label_[bagging_mapper[index_mapper[i]]] - pred)
        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)
        #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)
        #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
      }
    }
  }

609
610
611
612
private:
  score_t alpha_;
};

613
614
615
616
617

/*!
* \brief Mape Regression Loss
*/
class RegressionMAPELOSS : public RegressionL1loss {
618
public:
Guolin Ke's avatar
Guolin Ke committed
619
  explicit RegressionMAPELOSS(const Config& config) : RegressionL1loss(config) {
620
621
  }

622
  explicit RegressionMAPELOSS(const std::vector<std::string>& strs) : RegressionL1loss(strs) {
623
624
625

  }

626
627
628
629
630
631
  ~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) {
632
        Log::Warning("Met 'abs(label) < 1', will convert them to '1' in MAPE objective and metric");
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
        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];
      }
    }
  }
649
650
651
652
653
654

  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) {
655
656
657
        const double diff = score[i] - label_[i];
        gradients[i] = static_cast<score_t>(Common::Sign(diff) * label_weight_[i]);
        hessians[i] = 1.0f;
658
659
660
661
      }
    } else {
      #pragma omp parallel for schedule(static)
      for (data_size_t i = 0; i < num_data_; ++i) {
662
663
664
        const double diff = score[i] - label_[i];
        gradients[i] = static_cast<score_t>(Common::Sign(diff) * label_weight_[i]);
        hessians[i] = weights_[i];
665
666
667
668
      }
    }
  }

669
  double BoostFromScore(int) const override {
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
    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);
Guolin Ke's avatar
Guolin Ke committed
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
      #undef data_reader
      #undef weight_reader
    }
  }

  double RenewTreeOutput(double, 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)
      #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)
      #define weight_reader(i) (label_weight_[bagging_mapper[index_mapper[i]]])
      WeightedPercentileFun(double, data_reader, weight_reader, num_data_in_leaf, alpha);
715
716
717
      #undef data_reader
      #undef weight_reader
    }
718
719
720
  }

  const char* GetName() const override {
721
722
723
724
725
    return "mape";
  }

  bool IsConstantHessian() const override {
    return true;
726
727
728
  }

private:
729
730
  std::vector<label_t> label_weight_;

731
732
};

Guolin Ke's avatar
Guolin Ke committed
733
734
735
736
737
738
739


/*!
* \brief Objective function for Gamma regression
*/
class RegressionGammaLoss : public RegressionPoissonLoss {
public:
Guolin Ke's avatar
Guolin Ke committed
740
  explicit RegressionGammaLoss(const Config& config) : RegressionPoissonLoss(config) {
Guolin Ke's avatar
Guolin Ke committed
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
  }

  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
777
  explicit RegressionTweedieLoss(const Config& config) : RegressionPoissonLoss(config) {
Guolin Ke's avatar
Guolin Ke committed
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
    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_;
};

813
814
815
#undef PercentileFun
#undef WeightedPercentileFun

Guolin Ke's avatar
Guolin Ke committed
816
}  // namespace LightGBM
Guolin Ke's avatar
Guolin Ke committed
817
#endif   // LightGBM_OBJECTIVE_REGRESSION_OBJECTIVE_HPP_