"src/io/vscode:/vscode.git/clone" did not exist on "6482b47e9d3384a25e51f22ad063e599c24dd19d"
regression_objective.hpp 27 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
  }\
  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]);\
Guolin Ke's avatar
Guolin Ke committed
61
62
63
64
65
  if(weighted_cdf[pos + 1] - weighted_cdf[pos] > kEpsilon){\
    return static_cast<T>((threshold - weighted_cdf[pos]) / (weighted_cdf[pos + 1] - weighted_cdf[pos]) * (v2 - v1) + v1); \
  } else {\
    return static_cast<T>(v2);\
  }\
66
67
}\

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

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

Guolin Ke's avatar
Guolin Ke committed
86
87
88
89
90
91
  ~RegressionL2loss() {
  }

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

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

Guolin Ke's avatar
Guolin Ke committed
120
121
  const char* GetName() const override {
    return "regression";
Guolin Ke's avatar
Guolin Ke committed
122
123
  }

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

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

141
142
143
144
145
146
147
148
  bool IsConstantHessian() const override {
    if (weights_ == nullptr) {
      return true;
    } else {
      return false;
    }
  }

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

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

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

187
  explicit RegressionL1loss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
188
189
  }

190
191
  ~RegressionL1loss() {}

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

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

226
227
  bool IsRenewTreeOutput() const override { return true; }

228
  double RenewTreeOutput(double, const double* pred,
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
254
255
256
257
                         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
      }
    }
258
259
  }

260
  double RenewTreeOutput(double, double pred,
Guolin Ke's avatar
Guolin Ke committed
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
288
289
290
291
                         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
      }
    }
  }

292
293
294
  const char* GetName() const override {
    return "regression_l1";
  }
295
296
};

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

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

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
317
  ~RegressionHuberLoss() {
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
318
319
  }

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

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

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

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

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
360
361

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

368
  explicit RegressionFairLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
369
370
  }

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
371
372
  ~RegressionFairLoss() {}

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

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

396
397
  bool IsConstantHessian() const override {
    return false;
398
399
  }

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

405
406
407
408

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

419
  explicit RegressionPoissonLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
420
421
  }

422
423
424
  ~RegressionPoissonLoss() {}

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

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

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

472
473
474
475
  const char* GetName() const override {
    return "poisson";
  }

476
  double BoostFromScore(int) const override {
Guolin Ke's avatar
Guolin Ke committed
477
    return Common::SafeLog(RegressionL2loss::BoostFromScore(0));
478
479
  }

480
481
482
483
  bool IsConstantHessian() const override {
    return false;
  }

Nikita Titov's avatar
Nikita Titov committed
484
 private:
485
486
487
488
  /*! \brief used to safeguard optimization */
  double max_delta_step_;
};

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

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

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

532
  double BoostFromScore(int) const override {
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
578
    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
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
609
  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
610
 private:
611
612
613
  score_t alpha_;
};

614
615
616
617
618

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

623
  explicit RegressionMAPELOSS(const std::vector<std::string>& strs) : RegressionL1loss(strs) {
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
  }

Nikita Titov's avatar
Nikita Titov committed
728
 private:
729
  std::vector<label_t> label_weight_;
730
731
};

Guolin Ke's avatar
Guolin Ke committed
732
733
734
735
736
737


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

  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
773
 public:
Guolin Ke's avatar
Guolin Ke committed
774
  explicit RegressionTweedieLoss(const Config& config) : RegressionPoissonLoss(config) {
Guolin Ke's avatar
Guolin Ke committed
775
776
777
778
779
780
781
782
783
784
785
786
787
788
    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]));
789
        hessians[i] = static_cast<score_t>(-label_[i] * (1 - rho_) * std::exp((1 - rho_) * score[i]) +
Guolin Ke's avatar
Guolin Ke committed
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
          (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";
  }
805

Nikita Titov's avatar
Nikita Titov committed
806
 private:
Guolin Ke's avatar
Guolin Ke committed
807
808
809
  double rho_;
};

810
811
812
#undef PercentileFun
#undef WeightedPercentileFun

Guolin Ke's avatar
Guolin Ke committed
813
}  // namespace LightGBM
Guolin Ke's avatar
Guolin Ke committed
814
#endif   // LightGBM_OBJECTIVE_REGRESSION_OBJECTIVE_HPP_