regression_objective.hpp 27.1 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
#include <LightGBM/meta.h>
5
#include <LightGBM/objective_function.h>
6
#include <LightGBM/utils/array_args.h>
Guolin Ke's avatar
Guolin Ke committed
7

8
9
10
11
#include <string>
#include <algorithm>
#include <vector>

Guolin Ke's avatar
Guolin Ke committed
12
namespace LightGBM {
13

14
#define PercentileFun(T, data_reader, cnt_data, alpha) {\
15
  if (cnt_data <= 1) { return  data_reader(0); }\
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
  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) {\
43
  if (cnt_data <= 1) { return  data_reader(0); }\
44
45
46
47
  std::vector<data_size_t> sorted_idx(cnt_data);\
  for (data_size_t i = 0; i < cnt_data; ++i) {\
    sorted_idx[i] = i;\
  }\
48
  std::stable_sort(sorted_idx.begin(), sorted_idx.end(), [=](data_size_t a, data_size_t b) {return data_reader(a) < data_reader(b); });\
49
50
51
52
53
54
55
  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();\
56
  pos = std::min(pos, static_cast<size_t>(cnt_data -1));\
Guolin Ke's avatar
Guolin Ke committed
57
  if (pos == 0 || pos ==  static_cast<size_t>(cnt_data - 1)) {\
58
    return data_reader(sorted_idx[pos]);\
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]);\
64
  if (weighted_cdf[pos + 1] - weighted_cdf[pos] > kEpsilon) {\
Guolin Ke's avatar
Guolin Ke committed
65
66
67
68
    return static_cast<T>((threshold - weighted_cdf[pos]) / (weighted_cdf[pos + 1] - weighted_cdf[pos]) * (v2 - v1) + v1); \
  } else {\
    return static_cast<T>(v2);\
  }\
69
70
}\

Guolin Ke's avatar
Guolin Ke committed
71
/*!
72
* \brief Objective function for regression
Guolin Ke's avatar
Guolin Ke committed
73
74
*/
class RegressionL2loss: public ObjectiveFunction {
Nikita Titov's avatar
Nikita Titov committed
75
 public:
Guolin Ke's avatar
Guolin Ke committed
76
  explicit RegressionL2loss(const Config& config) {
77
    sqrt_ = config.reg_sqrt;
Guolin Ke's avatar
Guolin Ke committed
78
79
  }

80
81
82
83
84
85
86
  explicit RegressionL2loss(const std::vector<std::string>& strs) {
    sqrt_ = false;
    for (auto str : strs) {
      if (str == std::string("sqrt")) {
        sqrt_ = true;
      }
    }
87
  }
88

Guolin Ke's avatar
Guolin Ke committed
89
90
91
92
93
94
  ~RegressionL2loss() {
  }

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

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

Guolin Ke's avatar
Guolin Ke committed
123
124
  const char* GetName() const override {
    return "regression";
Guolin Ke's avatar
Guolin Ke committed
125
126
  }

127
128
  void ConvertOutput(const double* input, double* output) const override {
    if (sqrt_) {
129
      output[0] = Common::Sign(input[0]) * input[0] * input[0];
130
131
132
133
134
    } else {
      output[0] = input[0];
    }
  }

135
136
137
  std::string ToString() const override {
    std::stringstream str_buf;
    str_buf << GetName();
138
139
140
    if (sqrt_) {
      str_buf << " sqrt";
    }
141
142
143
    return str_buf.str();
  }

144
145
146
147
148
149
150
151
  bool IsConstantHessian() const override {
    if (weights_ == nullptr) {
      return true;
    } else {
      return false;
    }
  }

152
  double BoostFromScore(int) const override {
153
154
155
    double suml = 0.0f;
    double sumw = 0.0f;
    if (weights_ != nullptr) {
156
      #pragma omp parallel for schedule(static) reduction(+:suml, sumw)
157
158
159
160
      for (data_size_t i = 0; i < num_data_; ++i) {
        suml += label_[i] * weights_[i];
        sumw += weights_[i];
      }
161
    } else {
162
163
164
165
166
      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];
      }
167
    }
168
    return suml / sumw;
169
  }
170

Nikita Titov's avatar
Nikita Titov committed
171
 protected:
172
  bool sqrt_;
Guolin Ke's avatar
Guolin Ke committed
173
174
175
  /*! \brief Number of data */
  data_size_t num_data_;
  /*! \brief Pointer of label */
176
  const label_t* label_;
Guolin Ke's avatar
Guolin Ke committed
177
  /*! \brief Pointer of weights */
178
179
  const label_t* weights_;
  std::vector<label_t> trans_label_;
Guolin Ke's avatar
Guolin Ke committed
180
181
};

Guolin Ke's avatar
Guolin Ke committed
182
183
184
/*!
* \brief L1 regression loss
*/
185
class RegressionL1loss: public RegressionL2loss {
Nikita Titov's avatar
Nikita Titov committed
186
 public:
Guolin Ke's avatar
Guolin Ke committed
187
  explicit RegressionL1loss(const Config& config): RegressionL2loss(config) {
188
  }
189

190
  explicit RegressionL1loss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
191
192
  }

193
194
  ~RegressionL1loss() {}

195
196
  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
197
    if (weights_ == nullptr) {
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));
        hessians[i] = 1.0f;
203
204
      }
    } else {
205
      #pragma omp parallel for schedule(static)
206
      for (data_size_t i = 0; i < num_data_; ++i) {
207
        const double diff = score[i] - label_[i];
208
209
        gradients[i] = static_cast<score_t>(Common::Sign(diff) * weights_[i]);
        hessians[i] = weights_[i];
210
211
212
213
      }
    }
  }

214
  double BoostFromScore(int) const override {
215
216
217
218
219
220
221
222
223
224
225
226
    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
    }
227
228
  }

229
230
  bool IsRenewTreeOutput() const override { return true; }

231
  double RenewTreeOutput(double, const double* pred,
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
                         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
      }
    }
261
262
  }

263
  double RenewTreeOutput(double, double pred,
Guolin Ke's avatar
Guolin Ke committed
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
                         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
      }
    }
  }

295
296
297
  const char* GetName() const override {
    return "regression_l1";
  }
298
299
};

Guolin Ke's avatar
Guolin Ke committed
300
301
302
/*!
* \brief Huber regression loss
*/
303
class RegressionHuberLoss: public RegressionL2loss {
Nikita Titov's avatar
Nikita Titov committed
304
 public:
Guolin Ke's avatar
Guolin Ke committed
305
  explicit RegressionHuberLoss(const Config& config): RegressionL2loss(config) {
306
    alpha_ = static_cast<double>(config.alpha);
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;
    }
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
311
312
  }

313
  explicit RegressionHuberLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
Guolin Ke's avatar
Guolin Ke committed
314
315
316
317
    if (sqrt_) {
      Log::Warning("Cannot use sqrt transform in %s Regression, will auto disable it", GetName());
      sqrt_ = false;
    }
318
319
  }

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
320
  ~RegressionHuberLoss() {
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
321
322
  }

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

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

354
355
  bool IsConstantHessian() const override {
    return false;
356
357
  }

Nikita Titov's avatar
Nikita Titov committed
358
 private:
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
359
  /*! \brief delta for Huber loss */
360
  double alpha_;
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
361
362
};

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
363
364

// http://research.microsoft.com/en-us/um/people/zhang/INRIA/Publis/Tutorial-Estim/node24.html
365
class RegressionFairLoss: public RegressionL2loss {
Nikita Titov's avatar
Nikita Titov committed
366
 public:
Guolin Ke's avatar
Guolin Ke committed
367
  explicit RegressionFairLoss(const Config& config): RegressionL2loss(config) {
368
    c_ = static_cast<double>(config.fair_c);
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
369
370
  }

371
  explicit RegressionFairLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
372
373
  }

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
374
375
  ~RegressionFairLoss() {}

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

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

399
400
  bool IsConstantHessian() const override {
    return false;
401
402
  }

Nikita Titov's avatar
Nikita Titov committed
403
 private:
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
404
  /*! \brief c for Fair loss */
405
  double c_;
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
406
407
};

408
409
410
411

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

422
  explicit RegressionPoissonLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
423
424
  }

425
426
427
  ~RegressionPoissonLoss() {}

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

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

471
472
473
474
  void ConvertOutput(const double* input, double* output) const override {
    output[0] = std::exp(input[0]);
  }

475
476
477
478
  const char* GetName() const override {
    return "poisson";
  }

479
  double BoostFromScore(int) const override {
Guolin Ke's avatar
Guolin Ke committed
480
    return Common::SafeLog(RegressionL2loss::BoostFromScore(0));
481
482
  }

483
484
485
486
  bool IsConstantHessian() const override {
    return false;
  }

Nikita Titov's avatar
Nikita Titov committed
487
 private:
488
489
490
491
  /*! \brief used to safeguard optimization */
  double max_delta_step_;
};

492
class RegressionQuantileloss : public RegressionL2loss {
Nikita Titov's avatar
Nikita Titov committed
493
 public:
Guolin Ke's avatar
Guolin Ke committed
494
  explicit RegressionQuantileloss(const Config& config): RegressionL2loss(config) {
495
    alpha_ = static_cast<score_t>(config.alpha);
Guolin Ke's avatar
Guolin Ke committed
496
    CHECK(alpha_ > 0 && alpha_ < 1);
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
  }

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

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

535
  double BoostFromScore(int) const override {
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
578
579
580
581
    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
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
609
610
611
612
  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
      }
    }
  }

Nikita Titov's avatar
Nikita Titov committed
613
 private:
614
615
616
  score_t alpha_;
};

617
618
619
620
621

/*!
* \brief Mape Regression Loss
*/
class RegressionMAPELOSS : public RegressionL1loss {
Nikita Titov's avatar
Nikita Titov committed
622
 public:
Guolin Ke's avatar
Guolin Ke committed
623
  explicit RegressionMAPELOSS(const Config& config) : RegressionL1loss(config) {
624
625
  }

626
  explicit RegressionMAPELOSS(const std::vector<std::string>& strs) : RegressionL1loss(strs) {
627
628
  }

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

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

672
  double BoostFromScore(int) const override {
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
    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
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
      #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);
718
719
720
      #undef data_reader
      #undef weight_reader
    }
721
722
723
  }

  const char* GetName() const override {
724
725
726
727
728
    return "mape";
  }

  bool IsConstantHessian() const override {
    return true;
729
730
  }

Nikita Titov's avatar
Nikita Titov committed
731
 private:
732
  std::vector<label_t> label_weight_;
733
734
};

Guolin Ke's avatar
Guolin Ke committed
735
736
737
738
739
740


/*!
* \brief Objective function for Gamma regression
*/
class RegressionGammaLoss : public RegressionPoissonLoss {
Nikita Titov's avatar
Nikita Titov committed
741
 public:
Guolin Ke's avatar
Guolin Ke committed
742
  explicit RegressionGammaLoss(const Config& config) : RegressionPoissonLoss(config) {
Guolin Ke's avatar
Guolin Ke committed
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
  }

  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 {
Nikita Titov's avatar
Nikita Titov committed
776
 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
    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]));
792
        hessians[i] = static_cast<score_t>(-label_[i] * (1 - rho_) * std::exp((1 - rho_) * score[i]) +
Guolin Ke's avatar
Guolin Ke committed
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
          (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";
  }
808

Nikita Titov's avatar
Nikita Titov committed
809
 private:
Guolin Ke's avatar
Guolin Ke committed
810
811
812
  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_