regression_objective.hpp 26.7 KB
Newer Older
1
2
3
4
/*!
 * Copyright (c) 2016 Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See LICENSE file in the project root for license information.
 */
Guolin Ke's avatar
Guolin Ke committed
5
6
7
#ifndef LIGHTGBM_OBJECTIVE_REGRESSION_OBJECTIVE_HPP_
#define LIGHTGBM_OBJECTIVE_REGRESSION_OBJECTIVE_HPP_

8
9
10
11
#include <LightGBM/meta.h>
#include <LightGBM/objective_function.h>
#include <LightGBM/utils/array_args.h>

12
13
14
15
#include <string>
#include <algorithm>
#include <vector>

Guolin Ke's avatar
Guolin Ke committed
16
namespace LightGBM {
17

Guolin Ke's avatar
Guolin Ke committed
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#define PercentileFun(T, data_reader, cnt_data, alpha)                    \
  {                                                                       \
    if (cnt_data <= 1) {                                                  \
      return data_reader(0);                                              \
    }                                                                     \
    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);                     \
      }                                                                   \
    }                                                                     \
48
49
  }\

Guolin Ke's avatar
Guolin Ke committed
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
#define WeightedPercentileFun(T, data_reader, weight_reader, cnt_data, alpha) \
  {                                                                           \
    if (cnt_data <= 1) {                                                      \
      return data_reader(0);                                                  \
    }                                                                         \
    std::vector<data_size_t> sorted_idx(cnt_data);                            \
    for (data_size_t i = 0; i < cnt_data; ++i) {                              \
      sorted_idx[i] = i;                                                      \
    }                                                                         \
    std::stable_sort(sorted_idx.begin(), sorted_idx.end(),                    \
                     [&](data_size_t a, data_size_t b) {                      \
                       return data_reader(a) < data_reader(b);                \
                     });                                                      \
    std::vector<double> weighted_cdf(cnt_data);                               \
    weighted_cdf[0] = weight_reader(sorted_idx[0]);                           \
    for (data_size_t i = 1; i < cnt_data; ++i) {                              \
      weighted_cdf[i] = weighted_cdf[i - 1] + weight_reader(sorted_idx[i]);   \
    }                                                                         \
    double threshold = weighted_cdf[cnt_data - 1] * alpha;                    \
    size_t pos = std::upper_bound(weighted_cdf.begin(), weighted_cdf.end(),   \
                                  threshold) -                                \
                 weighted_cdf.begin();                                        \
    pos = std::min(pos, static_cast<size_t>(cnt_data - 1));                   \
    if (pos == 0 || pos == static_cast<size_t>(cnt_data - 1)) {               \
      return data_reader(sorted_idx[pos]);                                    \
    }                                                                         \
Nikita Titov's avatar
Nikita Titov committed
76
77
    CHECK_GE(threshold, weighted_cdf[pos - 1]);                               \
    CHECK_LT(threshold, weighted_cdf[pos]);                                   \
Guolin Ke's avatar
Guolin Ke committed
78
79
80
81
82
83
84
85
86
87
    T v1 = data_reader(sorted_idx[pos - 1]);                                  \
    T v2 = data_reader(sorted_idx[pos]);                                      \
    if (weighted_cdf[pos + 1] - weighted_cdf[pos] >= 1.0f) {                  \
      return static_cast<T>((threshold - weighted_cdf[pos]) /                 \
                                (weighted_cdf[pos + 1] - weighted_cdf[pos]) * \
                                (v2 - v1) +                                   \
                            v1);                                              \
    } else {                                                                  \
      return static_cast<T>(v2);                                              \
    }                                                                         \
Guolin Ke's avatar
Guolin Ke committed
88
  }\
89

Guolin Ke's avatar
Guolin Ke committed
90
/*!
91
* \brief Objective function for regression
Guolin Ke's avatar
Guolin Ke committed
92
93
*/
class RegressionL2loss: public ObjectiveFunction {
Nikita Titov's avatar
Nikita Titov committed
94
 public:
Guolin Ke's avatar
Guolin Ke committed
95
96
  explicit RegressionL2loss(const Config& config)
      : deterministic_(config.deterministic) {
97
    sqrt_ = config.reg_sqrt;
Guolin Ke's avatar
Guolin Ke committed
98
99
  }

Guolin Ke's avatar
Guolin Ke committed
100
101
  explicit RegressionL2loss(const std::vector<std::string>& strs)
      : deterministic_(false) {
102
103
104
105
106
107
    sqrt_ = false;
    for (auto str : strs) {
      if (str == std::string("sqrt")) {
        sqrt_ = true;
      }
    }
108
  }
109

Guolin Ke's avatar
Guolin Ke committed
110
111
112
113
114
115
  ~RegressionL2loss() {
  }

  void Init(const Metadata& metadata, data_size_t num_data) override {
    num_data_ = num_data;
    label_ = metadata.label();
116
117
    if (sqrt_) {
      trans_label_.resize(num_data_);
118
      #pragma omp parallel for schedule(static)
119
      for (data_size_t i = 0; i < num_data; ++i) {
120
        trans_label_[i] = Common::Sign(label_[i]) * std::sqrt(std::fabs(label_[i]));
121
122
123
      }
      label_ = trans_label_.data();
    }
Guolin Ke's avatar
Guolin Ke committed
124
125
126
    weights_ = metadata.weights();
  }

127
128
  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
Guolin Ke's avatar
Guolin Ke committed
129
    if (weights_ == nullptr) {
130
      #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
131
      for (data_size_t i = 0; i < num_data_; ++i) {
132
        gradients[i] = static_cast<score_t>(score[i] - label_[i]);
133
        hessians[i] = 1.0f;
Guolin Ke's avatar
Guolin Ke committed
134
135
      }
    } else {
136
      #pragma omp parallel for schedule(static)
Guolin Ke's avatar
Guolin Ke committed
137
      for (data_size_t i = 0; i < num_data_; ++i) {
138
139
        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
140
141
142
143
      }
    }
  }

Guolin Ke's avatar
Guolin Ke committed
144
145
  const char* GetName() const override {
    return "regression";
Guolin Ke's avatar
Guolin Ke committed
146
147
  }

148
149
  void ConvertOutput(const double* input, double* output) const override {
    if (sqrt_) {
150
      output[0] = Common::Sign(input[0]) * input[0] * input[0];
151
152
153
154
155
    } else {
      output[0] = input[0];
    }
  }

156
157
158
  std::string ToString() const override {
    std::stringstream str_buf;
    str_buf << GetName();
159
160
161
    if (sqrt_) {
      str_buf << " sqrt";
    }
162
163
164
    return str_buf.str();
  }

165
166
167
168
169
170
171
172
  bool IsConstantHessian() const override {
    if (weights_ == nullptr) {
      return true;
    } else {
      return false;
    }
  }

173
  double BoostFromScore(int) const override {
174
175
176
    double suml = 0.0f;
    double sumw = 0.0f;
    if (weights_ != nullptr) {
Guolin Ke's avatar
Guolin Ke committed
177
      #pragma omp parallel for schedule(static) reduction(+:suml, sumw) if (!deterministic_)
178
179
180
181
      for (data_size_t i = 0; i < num_data_; ++i) {
        suml += label_[i] * weights_[i];
        sumw += weights_[i];
      }
182
    } else {
183
      sumw = static_cast<double>(num_data_);
Guolin Ke's avatar
Guolin Ke committed
184
      #pragma omp parallel for schedule(static) reduction(+:suml) if (!deterministic_)
185
186
187
      for (data_size_t i = 0; i < num_data_; ++i) {
        suml += label_[i];
      }
188
    }
189
    return suml / sumw;
190
  }
191

Nikita Titov's avatar
Nikita Titov committed
192
 protected:
193
  bool sqrt_;
Guolin Ke's avatar
Guolin Ke committed
194
195
196
  /*! \brief Number of data */
  data_size_t num_data_;
  /*! \brief Pointer of label */
197
  const label_t* label_;
Guolin Ke's avatar
Guolin Ke committed
198
  /*! \brief Pointer of weights */
199
200
  const label_t* weights_;
  std::vector<label_t> trans_label_;
Guolin Ke's avatar
Guolin Ke committed
201
  const bool deterministic_;
Guolin Ke's avatar
Guolin Ke committed
202
203
};

Guolin Ke's avatar
Guolin Ke committed
204
205
206
/*!
* \brief L1 regression loss
*/
207
class RegressionL1loss: public RegressionL2loss {
Nikita Titov's avatar
Nikita Titov committed
208
 public:
Guolin Ke's avatar
Guolin Ke committed
209
  explicit RegressionL1loss(const Config& config): RegressionL2loss(config) {
210
  }
211

212
  explicit RegressionL1loss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
213
214
  }

215
216
  ~RegressionL1loss() {}

217
218
  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
219
    if (weights_ == nullptr) {
220
      #pragma omp parallel for schedule(static)
221
      for (data_size_t i = 0; i < num_data_; ++i) {
222
        const double diff = score[i] - label_[i];
223
224
        gradients[i] = static_cast<score_t>(Common::Sign(diff));
        hessians[i] = 1.0f;
225
226
      }
    } else {
227
      #pragma omp parallel for schedule(static)
228
      for (data_size_t i = 0; i < num_data_; ++i) {
229
        const double diff = score[i] - label_[i];
230
231
        gradients[i] = static_cast<score_t>(Common::Sign(diff) * weights_[i]);
        hessians[i] = weights_[i];
232
233
234
235
      }
    }
  }

236
  double BoostFromScore(int) const override {
237
238
239
240
241
242
243
244
245
246
247
248
    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
    }
249
250
  }

251
252
  bool IsRenewTreeOutput() const override { return true; }

253
  double RenewTreeOutput(double, std::function<double(const label_t*, int)> residual_getter,
254
255
256
257
258
259
                         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) {
260
        #define data_reader(i) (residual_getter(label_, index_mapper[i]))
261
262
263
        PercentileFun(double, data_reader, num_data_in_leaf, alpha);
        #undef data_reader
      } else {
264
        #define data_reader(i) (residual_getter(label_, bagging_mapper[index_mapper[i]]))
265
266
267
268
269
        PercentileFun(double, data_reader, num_data_in_leaf, alpha);
        #undef data_reader
      }
    } else {
      if (bagging_mapper == nullptr) {
270
        #define data_reader(i) (residual_getter(label_, index_mapper[i]))
271
272
273
274
275
        #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 {
276
        #define data_reader(i) (residual_getter(label_, bagging_mapper[index_mapper[i]]))
Guolin Ke's avatar
Guolin Ke committed
277
278
279
280
281
282
283
284
        #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
      }
    }
  }

285
286
287
  const char* GetName() const override {
    return "regression_l1";
  }
288
289
};

Guolin Ke's avatar
Guolin Ke committed
290
291
292
/*!
* \brief Huber regression loss
*/
293
class RegressionHuberLoss: public RegressionL2loss {
Nikita Titov's avatar
Nikita Titov committed
294
 public:
Guolin Ke's avatar
Guolin Ke committed
295
  explicit RegressionHuberLoss(const Config& config): RegressionL2loss(config) {
296
    alpha_ = static_cast<double>(config.alpha);
Guolin Ke's avatar
Guolin Ke committed
297
298
299
300
    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
301
302
  }

303
  explicit RegressionHuberLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
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;
    }
308
309
  }

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
310
  ~RegressionHuberLoss() {
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
311
312
  }

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

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

Nikita Titov's avatar
Nikita Titov committed
344
 private:
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
345
  /*! \brief delta for Huber loss */
346
  double alpha_;
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
347
348
};

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
349
350

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

357
  explicit RegressionFairLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
358
359
  }

Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
360
361
  ~RegressionFairLoss() {}

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

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

385
386
  bool IsConstantHessian() const override {
    return false;
387
388
  }

Nikita Titov's avatar
Nikita Titov committed
389
 private:
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
390
  /*! \brief c for Fair loss */
391
  double c_;
Tsukasa OMOTO's avatar
Tsukasa OMOTO committed
392
393
};

394
395
396
397

/*!
* \brief Objective function for Poisson regression
*/
398
class RegressionPoissonLoss: public RegressionL2loss {
Nikita Titov's avatar
Nikita Titov committed
399
 public:
Guolin Ke's avatar
Guolin Ke committed
400
  explicit RegressionPoissonLoss(const Config& config): RegressionL2loss(config) {
401
    max_delta_step_ = static_cast<double>(config.poisson_max_delta_step);
402
    if (sqrt_) {
403
      Log::Warning("Cannot use sqrt transform in %s Regression, will auto disable it", GetName());
404
405
      sqrt_ = false;
    }
406
407
  }

408
  explicit RegressionPoissonLoss(const std::vector<std::string>& strs): RegressionL2loss(strs) {
409
410
  }

411
412
413
  ~RegressionPoissonLoss() {}

  void Init(const Metadata& metadata, data_size_t num_data) override {
414
    if (sqrt_) {
415
      Log::Warning("Cannot use sqrt transform in %s Regression, will auto disable it", GetName());
416
417
      sqrt_ = false;
    }
418
    RegressionL2loss::Init(metadata, num_data);
419
    // Safety check of labels
420
    label_t miny;
421
    double sumy;
422
    Common::ObtainMinMaxSum(label_, num_data_, &miny, static_cast<label_t*>(nullptr), &sumy);
423
    if (miny < 0.0f) {
424
      Log::Fatal("[%s]: at least one target label is negative", GetName());
425
426
    }
    if (sumy == 0.0f) {
427
      Log::Fatal("[%s]: sum of labels is zero", GetName());
428
    }
429
430
  }

431
432
433
434
435
436
437
438
439
  /* 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.
   *
   */
440
441
  void GetGradients(const double* score, score_t* gradients,
                    score_t* hessians) const override {
442
    if (weights_ == nullptr) {
443
      #pragma omp parallel for schedule(static)
444
      for (data_size_t i = 0; i < num_data_; ++i) {
445
446
        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_));
447
448
      }
    } else {
449
      #pragma omp parallel for schedule(static)
450
      for (data_size_t i = 0; i < num_data_; ++i) {
451
452
        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]);
453
454
455
456
      }
    }
  }

457
458
459
460
  void ConvertOutput(const double* input, double* output) const override {
    output[0] = std::exp(input[0]);
  }

461
462
463
464
  const char* GetName() const override {
    return "poisson";
  }

465
  double BoostFromScore(int) const override {
Guolin Ke's avatar
Guolin Ke committed
466
    return Common::SafeLog(RegressionL2loss::BoostFromScore(0));
467
468
  }

469
470
471
472
  bool IsConstantHessian() const override {
    return false;
  }

Nikita Titov's avatar
Nikita Titov committed
473
 private:
474
475
476
477
  /*! \brief used to safeguard optimization */
  double max_delta_step_;
};

478
class RegressionQuantileloss : public RegressionL2loss {
Nikita Titov's avatar
Nikita Titov committed
479
 public:
Guolin Ke's avatar
Guolin Ke committed
480
  explicit RegressionQuantileloss(const Config& config): RegressionL2loss(config) {
481
    alpha_ = static_cast<score_t>(config.alpha);
Guolin Ke's avatar
Guolin Ke committed
482
    CHECK(alpha_ > 0 && alpha_ < 1);
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
  }

  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) {
508
          gradients[i] = static_cast<score_t>((1.0f - alpha_) * weights_[i]);
509
        } else {
510
          gradients[i] = static_cast<score_t>(-alpha_ * weights_[i]);
511
        }
512
        hessians[i] = static_cast<score_t>(weights_[i]);
513
514
515
516
517
518
519
520
      }
    }
  }

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

521
  double BoostFromScore(int) const override {
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
    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; }

537
  double RenewTreeOutput(double, std::function<double(const label_t*, int)> residual_getter,
Guolin Ke's avatar
Guolin Ke committed
538
539
540
541
542
                         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) {
543
        #define data_reader(i) (residual_getter(label_, index_mapper[i]))
Guolin Ke's avatar
Guolin Ke committed
544
545
546
        PercentileFun(double, data_reader, num_data_in_leaf, alpha_);
        #undef data_reader
      } else {
547
        #define data_reader(i) (residual_getter(label_, bagging_mapper[index_mapper[i]]))
Guolin Ke's avatar
Guolin Ke committed
548
549
550
551
552
        PercentileFun(double, data_reader, num_data_in_leaf, alpha_);
        #undef data_reader
      }
    } else {
      if (bagging_mapper == nullptr) {
553
        #define data_reader(i) (residual_getter(label_, index_mapper[i]))
Guolin Ke's avatar
Guolin Ke committed
554
555
556
557
558
        #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 {
559
        #define data_reader(i) (residual_getter(label_, bagging_mapper[index_mapper[i]]))
Guolin Ke's avatar
Guolin Ke committed
560
561
562
563
564
565
566
567
        #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
568
 private:
569
570
571
  score_t alpha_;
};

572
573
574
575
576

/*!
* \brief Mape Regression Loss
*/
class RegressionMAPELOSS : public RegressionL1loss {
Nikita Titov's avatar
Nikita Titov committed
577
 public:
Guolin Ke's avatar
Guolin Ke committed
578
  explicit RegressionMAPELOSS(const Config& config) : RegressionL1loss(config) {
579
580
  }

581
  explicit RegressionMAPELOSS(const std::vector<std::string>& strs) : RegressionL1loss(strs) {
582
583
  }

584
585
586
587
588
589
  ~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) {
590
591
592
        Log::Warning(
          "Some label values are < 1 in absolute value. MAPE is unstable with such values, "
          "so LightGBM rounds them to 1.0 when calculating MAPE.");
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
        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];
      }
    }
  }
609
610
611
612
613
614

  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) {
615
616
617
        const double diff = score[i] - label_[i];
        gradients[i] = static_cast<score_t>(Common::Sign(diff) * label_weight_[i]);
        hessians[i] = 1.0f;
618
619
620
621
      }
    } else {
      #pragma omp parallel for schedule(static)
      for (data_size_t i = 0; i < num_data_; ++i) {
622
623
624
        const double diff = score[i] - label_[i];
        gradients[i] = static_cast<score_t>(Common::Sign(diff) * label_weight_[i]);
        hessians[i] = weights_[i];
625
626
627
628
      }
    }
  }

629
  double BoostFromScore(int) const override {
630
631
632
633
634
635
636
637
638
639
    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; }

640
  double RenewTreeOutput(double, std::function<double(const label_t*, int)> residual_getter,
Guolin Ke's avatar
Guolin Ke committed
641
642
643
644
645
                         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) {
646
      #define data_reader(i) (residual_getter(label_, index_mapper[i]))
Guolin Ke's avatar
Guolin Ke committed
647
648
649
650
651
      #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 {
652
      #define data_reader(i) (residual_getter(label_, bagging_mapper[index_mapper[i]]))
Guolin Ke's avatar
Guolin Ke committed
653
654
      #define weight_reader(i) (label_weight_[bagging_mapper[index_mapper[i]]])
      WeightedPercentileFun(double, data_reader, weight_reader, num_data_in_leaf, alpha);
655
656
657
      #undef data_reader
      #undef weight_reader
    }
658
659
660
  }

  const char* GetName() const override {
661
662
663
664
665
    return "mape";
  }

  bool IsConstantHessian() const override {
    return true;
666
667
  }

Nikita Titov's avatar
Nikita Titov committed
668
 private:
669
  std::vector<label_t> label_weight_;
670
671
};

Guolin Ke's avatar
Guolin Ke committed
672
673
674
675
676
677


/*!
* \brief Objective function for Gamma regression
*/
class RegressionGammaLoss : public RegressionPoissonLoss {
Nikita Titov's avatar
Nikita Titov committed
678
 public:
Guolin Ke's avatar
Guolin Ke committed
679
  explicit RegressionGammaLoss(const Config& config) : RegressionPoissonLoss(config) {
Guolin Ke's avatar
Guolin Ke committed
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
  }

  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
713
 public:
Guolin Ke's avatar
Guolin Ke committed
714
  explicit RegressionTweedieLoss(const Config& config) : RegressionPoissonLoss(config) {
Guolin Ke's avatar
Guolin Ke committed
715
716
717
718
719
720
721
722
723
724
725
726
727
728
    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]));
729
        hessians[i] = static_cast<score_t>(-label_[i] * (1 - rho_) * std::exp((1 - rho_) * score[i]) +
Guolin Ke's avatar
Guolin Ke committed
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
          (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";
  }
745

Nikita Titov's avatar
Nikita Titov committed
746
 private:
Guolin Ke's avatar
Guolin Ke committed
747
748
749
  double rho_;
};

750
751
752
#undef PercentileFun
#undef WeightedPercentileFun

Guolin Ke's avatar
Guolin Ke committed
753
}  // namespace LightGBM
Guolin Ke's avatar
Guolin Ke committed
754
#endif   // LightGBM_OBJECTIVE_REGRESSION_OBJECTIVE_HPP_