metadata.cpp 29.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.
 */
5
6
#include <LightGBM/dataset.h>
#include <LightGBM/utils/common.h>
Guolin Ke's avatar
Guolin Ke committed
7

8
#include <set>
Guolin Ke's avatar
Guolin Ke committed
9
#include <string>
10
#include <vector>
Guolin Ke's avatar
Guolin Ke committed
11
12
13

namespace LightGBM {

Guolin Ke's avatar
Guolin Ke committed
14
Metadata::Metadata() {
Guolin Ke's avatar
Guolin Ke committed
15
16
17
18
  num_weights_ = 0;
  num_init_score_ = 0;
  num_data_ = 0;
  num_queries_ = 0;
19
  num_positions_ = 0;
20
  weight_load_from_file_ = false;
21
  position_load_from_file_ = false;
22
23
  query_load_from_file_ = false;
  init_score_load_from_file_ = false;
24
  #ifdef USE_CUDA
25
  cuda_metadata_ = nullptr;
26
  #endif  // USE_CUDA
Guolin Ke's avatar
Guolin Ke committed
27
28
}

29
void Metadata::Init(const char* data_filename) {
Guolin Ke's avatar
Guolin Ke committed
30
  data_filename_ = data_filename;
31
  // for lambdarank, it needs query data for partition data in distributed learning
Guolin Ke's avatar
Guolin Ke committed
32
33
  LoadQueryBoundaries();
  LoadWeights();
34
  LoadPositions();
35
  CalculateQueryWeights();
36
  LoadInitialScore(data_filename_);
Guolin Ke's avatar
Guolin Ke committed
37
38
39
40
41
}

Metadata::~Metadata() {
}

42
void Metadata::Init(data_size_t num_data, int weight_idx, int query_idx) {
Guolin Ke's avatar
Guolin Ke committed
43
  num_data_ = num_data;
44
  label_ = std::vector<label_t>(num_data_);
Guolin Ke's avatar
Guolin Ke committed
45
  if (weight_idx >= 0) {
Guolin Ke's avatar
Guolin Ke committed
46
    if (!weights_.empty()) {
47
      Log::Info("Using weights in data file, ignoring the additional weights file");
Guolin Ke's avatar
Guolin Ke committed
48
      weights_.clear();
Guolin Ke's avatar
Guolin Ke committed
49
    }
50
    weights_ = std::vector<label_t>(num_data_, 0.0f);
Guolin Ke's avatar
Guolin Ke committed
51
    num_weights_ = num_data_;
52
    weight_load_from_file_ = false;
Guolin Ke's avatar
Guolin Ke committed
53
54
  }
  if (query_idx >= 0) {
Guolin Ke's avatar
Guolin Ke committed
55
    if (!query_boundaries_.empty()) {
56
      Log::Info("Using query id in data file, ignoring the additional query file");
Guolin Ke's avatar
Guolin Ke committed
57
      query_boundaries_.clear();
Guolin Ke's avatar
Guolin Ke committed
58
    }
Guolin Ke's avatar
Guolin Ke committed
59
    if (!query_weights_.empty()) { query_weights_.clear(); }
60
    queries_ = std::vector<data_size_t>(num_data_, 0);
61
    query_load_from_file_ = false;
Guolin Ke's avatar
Guolin Ke committed
62
  }
Guolin Ke's avatar
Guolin Ke committed
63
64
}

65
66
67
68
void Metadata::InitByReference(data_size_t num_data, const Metadata* reference) {
  int has_weights = reference->num_weights_ > 0;
  int has_init_scores = reference->num_init_score_ > 0;
  int has_queries = reference->num_queries_ > 0;
69
  int nclasses = reference->num_init_score_classes();
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
  Init(num_data, has_weights, has_init_scores, has_queries, nclasses);
}

void Metadata::Init(data_size_t num_data, int32_t has_weights, int32_t has_init_scores, int32_t has_queries, int32_t nclasses) {
  num_data_ = num_data;
  label_ = std::vector<label_t>(num_data_);
  if (has_weights) {
    if (!weights_.empty()) {
      Log::Fatal("Calling Init() on Metadata weights that have already been initialized");
    }
    weights_.resize(num_data_, 0.0f);
    num_weights_ = num_data_;
    weight_load_from_file_ = false;
  }
  if (has_init_scores) {
    if (!init_score_.empty()) {
      Log::Fatal("Calling Init() on Metadata initial scores that have already been initialized");
    }
    num_init_score_ = static_cast<int64_t>(num_data) * nclasses;
    init_score_.resize(num_init_score_, 0);
  }
  if (has_queries) {
    if (!query_weights_.empty()) {
      Log::Fatal("Calling Init() on Metadata queries that have already been initialized");
    }
    queries_.resize(num_data_, 0);
    query_load_from_file_ = false;
  }
}

Guolin Ke's avatar
Guolin Ke committed
100
101
102
void Metadata::Init(const Metadata& fullset, const data_size_t* used_indices, data_size_t num_used_indices) {
  num_data_ = num_used_indices;

103
  label_ = std::vector<label_t>(num_used_indices);
104
#pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static, 512) if (num_used_indices >= 1024)
105
  for (data_size_t i = 0; i < num_used_indices; ++i) {
Guolin Ke's avatar
Guolin Ke committed
106
107
108
    label_[i] = fullset.label_[used_indices[i]];
  }

Guolin Ke's avatar
Guolin Ke committed
109
  if (!fullset.weights_.empty()) {
110
    weights_ = std::vector<label_t>(num_used_indices);
Guolin Ke's avatar
Guolin Ke committed
111
    num_weights_ = num_used_indices;
112
#pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static, 512) if (num_used_indices >= 1024)
113
    for (data_size_t i = 0; i < num_used_indices; ++i) {
Guolin Ke's avatar
Guolin Ke committed
114
115
116
117
118
119
      weights_[i] = fullset.weights_[used_indices[i]];
    }
  } else {
    num_weights_ = 0;
  }

Guolin Ke's avatar
Guolin Ke committed
120
  if (!fullset.init_score_.empty()) {
Guolin Ke's avatar
Guolin Ke committed
121
    int num_class = static_cast<int>(fullset.num_init_score_ / fullset.num_data_);
122
    init_score_ = std::vector<double>(static_cast<size_t>(num_used_indices) * num_class);
Guolin Ke's avatar
Guolin Ke committed
123
    num_init_score_ = static_cast<int64_t>(num_used_indices) * num_class;
124
    #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
125
    for (int k = 0; k < num_class; ++k) {
126
127
128
129
      const size_t offset_dest = static_cast<size_t>(k) * num_data_;
      const size_t offset_src = static_cast<size_t>(k) * fullset.num_data_;
      for (data_size_t i = 0; i < num_used_indices; ++i) {
        init_score_[offset_dest + i] = fullset.init_score_[offset_src + used_indices[i]];
130
      }
Guolin Ke's avatar
Guolin Ke committed
131
132
133
134
135
    }
  } else {
    num_init_score_ = 0;
  }

Guolin Ke's avatar
Guolin Ke committed
136
  if (!fullset.query_boundaries_.empty()) {
Guolin Ke's avatar
Guolin Ke committed
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
    std::vector<data_size_t> used_query;
    data_size_t data_idx = 0;
    for (data_size_t qid = 0; qid < num_queries_ && data_idx < num_used_indices; ++qid) {
      data_size_t start = fullset.query_boundaries_[qid];
      data_size_t end = fullset.query_boundaries_[qid + 1];
      data_size_t len = end - start;
      if (used_indices[data_idx] > start) {
        continue;
      } else if (used_indices[data_idx] == start) {
        if (num_used_indices >= data_idx + len && used_indices[data_idx + len - 1] == end - 1) {
          used_query.push_back(qid);
          data_idx += len;
        } else {
          Log::Fatal("Data partition error, data didn't match queries");
        }
      } else {
        Log::Fatal("Data partition error, data didn't match queries");
      }
    }
    query_boundaries_ = std::vector<data_size_t>(used_query.size() + 1);
    num_queries_ = static_cast<data_size_t>(used_query.size());
    query_boundaries_[0] = 0;
    for (data_size_t i = 0; i < num_queries_; ++i) {
      data_size_t qid = used_query[i];
      data_size_t len = fullset.query_boundaries_[qid + 1] - fullset.query_boundaries_[qid];
      query_boundaries_[i + 1] = query_boundaries_[i] + len;
    }
  } else {
    num_queries_ = 0;
  }
}

Guolin Ke's avatar
Guolin Ke committed
169
void Metadata::PartitionLabel(const std::vector<data_size_t>& used_indices) {
Guolin Ke's avatar
Guolin Ke committed
170
  if (used_indices.empty()) {
Guolin Ke's avatar
Guolin Ke committed
171
172
    return;
  }
Guolin Ke's avatar
Guolin Ke committed
173
  auto old_label = label_;
Guolin Ke's avatar
Guolin Ke committed
174
  num_data_ = static_cast<data_size_t>(used_indices.size());
175
  label_ = std::vector<label_t>(num_data_);
176
#pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static, 512) if (num_data_ >= 1024)
Guolin Ke's avatar
Guolin Ke committed
177
178
179
  for (data_size_t i = 0; i < num_data_; ++i) {
    label_[i] = old_label[used_indices[i]];
  }
Guolin Ke's avatar
Guolin Ke committed
180
  old_label.clear();
Guolin Ke's avatar
Guolin Ke committed
181
182
}

183
184
185
186
187
188
189
190
191
192
void Metadata::CalculateQueryBoundaries() {
  if (!queries_.empty()) {
    // need convert query_id to boundaries
    std::vector<data_size_t> tmp_buffer;
    data_size_t last_qid = -1;
    data_size_t cur_cnt = 0;
    for (data_size_t i = 0; i < num_data_; ++i) {
      if (last_qid != queries_[i]) {
        if (cur_cnt > 0) {
          tmp_buffer.push_back(cur_cnt);
Guolin Ke's avatar
Guolin Ke committed
193
        }
194
195
        cur_cnt = 0;
        last_qid = queries_[i];
Guolin Ke's avatar
Guolin Ke committed
196
      }
197
      ++cur_cnt;
Guolin Ke's avatar
Guolin Ke committed
198
    }
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
    tmp_buffer.push_back(cur_cnt);
    query_boundaries_ = std::vector<data_size_t>(tmp_buffer.size() + 1);
    num_queries_ = static_cast<data_size_t>(tmp_buffer.size());
    query_boundaries_[0] = 0;
    for (size_t i = 0; i < tmp_buffer.size(); ++i) {
      query_boundaries_[i + 1] = query_boundaries_[i] + tmp_buffer[i];
    }
    CalculateQueryWeights();
    queries_.clear();
  }
}

void Metadata::CheckOrPartition(data_size_t num_all_data, const std::vector<data_size_t>& used_data_indices) {
  if (used_data_indices.empty()) {
     CalculateQueryBoundaries();
Guolin Ke's avatar
Guolin Ke committed
214
    // check weights
Guolin Ke's avatar
Guolin Ke committed
215
    if (!weights_.empty() && num_weights_ != num_data_) {
Guolin Ke's avatar
Guolin Ke committed
216
      weights_.clear();
Guolin Ke's avatar
Guolin Ke committed
217
      num_weights_ = 0;
Guolin Ke's avatar
Guolin Ke committed
218
      Log::Fatal("Weights size doesn't match data size");
Guolin Ke's avatar
Guolin Ke committed
219
220
    }

221
222
223
224
225
226
227
    // check positions
    if (!positions_.empty() && num_positions_ != num_data_) {
      Log::Fatal("Positions size (%i) doesn't match data size (%i)", num_positions_, num_data_);
      positions_.clear();
      num_positions_ = 0;
    }

Guolin Ke's avatar
Guolin Ke committed
228
    // check query boundries
Guolin Ke's avatar
Guolin Ke committed
229
    if (!query_boundaries_.empty() && query_boundaries_[num_queries_] != num_data_) {
Guolin Ke's avatar
Guolin Ke committed
230
      query_boundaries_.clear();
Guolin Ke's avatar
Guolin Ke committed
231
      num_queries_ = 0;
Guolin Ke's avatar
Guolin Ke committed
232
      Log::Fatal("Query size doesn't match data size");
Guolin Ke's avatar
Guolin Ke committed
233
234
235
    }

    // contain initial score file
236
    if (!init_score_.empty() && (num_init_score_ % num_data_) != 0) {
Guolin Ke's avatar
Guolin Ke committed
237
      init_score_.clear();
Guolin Ke's avatar
Guolin Ke committed
238
      num_init_score_ = 0;
Guolin Ke's avatar
Guolin Ke committed
239
      Log::Fatal("Initial score size doesn't match data size");
Guolin Ke's avatar
Guolin Ke committed
240
241
    }
  } else {
242
    if (!queries_.empty()) {
243
      Log::Fatal("Cannot used query_id for distributed training");
244
    }
Guolin Ke's avatar
Guolin Ke committed
245
246
    data_size_t num_used_data = static_cast<data_size_t>(used_data_indices.size());
    // check weights
247
248
249
250
251
252
253
254
255
256
    if (weight_load_from_file_) {
      if (weights_.size() > 0 && num_weights_ != num_all_data) {
        weights_.clear();
        num_weights_ = 0;
        Log::Fatal("Weights size doesn't match data size");
      }
      // get local weights
      if (!weights_.empty()) {
        auto old_weights = weights_;
        num_weights_ = num_data_;
257
        weights_ = std::vector<label_t>(num_data_);
258
#pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static, 512)
259
260
261
262
        for (int i = 0; i < static_cast<int>(used_data_indices.size()); ++i) {
          weights_[i] = old_weights[used_data_indices[i]];
        }
        old_weights.clear();
Guolin Ke's avatar
Guolin Ke committed
263
264
      }
    }
265
266
267
268
269
270
271
272
273
274
275
276
    // check positions
    if (position_load_from_file_) {
      if (positions_.size() > 0 && num_positions_ != num_all_data) {
        positions_.clear();
        num_positions_ = 0;
        Log::Fatal("Positions size (%i) doesn't match data size (%i)", num_positions_, num_data_);
      }
      // get local positions
      if (!positions_.empty()) {
        auto old_positions = positions_;
        num_positions_ = num_data_;
        positions_ = std::vector<data_size_t>(num_data_);
277
        #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static, 512)
278
279
280
281
282
283
        for (int i = 0; i < static_cast<int>(used_data_indices.size()); ++i) {
          positions_[i] = old_positions[used_data_indices[i]];
        }
        old_positions.clear();
      }
    }
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
    if (query_load_from_file_) {
      // check query boundries
      if (!query_boundaries_.empty() && query_boundaries_[num_queries_] != num_all_data) {
        query_boundaries_.clear();
        num_queries_ = 0;
        Log::Fatal("Query size doesn't match data size");
      }
      // get local query boundaries
      if (!query_boundaries_.empty()) {
        std::vector<data_size_t> used_query;
        data_size_t data_idx = 0;
        for (data_size_t qid = 0; qid < num_queries_ && data_idx < num_used_data; ++qid) {
          data_size_t start = query_boundaries_[qid];
          data_size_t end = query_boundaries_[qid + 1];
          data_size_t len = end - start;
          if (used_data_indices[data_idx] > start) {
            continue;
          } else if (used_data_indices[data_idx] == start) {
            if (num_used_data >= data_idx + len && used_data_indices[data_idx + len - 1] == end - 1) {
              used_query.push_back(qid);
              data_idx += len;
            } else {
              Log::Fatal("Data partition error, data didn't match queries");
            }
Guolin Ke's avatar
Guolin Ke committed
308
          } else {
Guolin Ke's avatar
Guolin Ke committed
309
            Log::Fatal("Data partition error, data didn't match queries");
Guolin Ke's avatar
Guolin Ke committed
310
311
          }
        }
312
313
314
315
316
317
318
319
320
321
        auto old_query_boundaries = query_boundaries_;
        query_boundaries_ = std::vector<data_size_t>(used_query.size() + 1);
        num_queries_ = static_cast<data_size_t>(used_query.size());
        query_boundaries_[0] = 0;
        for (data_size_t i = 0; i < num_queries_; ++i) {
          data_size_t qid = used_query[i];
          data_size_t len = old_query_boundaries[qid + 1] - old_query_boundaries[qid];
          query_boundaries_[i + 1] = query_boundaries_[i] + len;
        }
        old_query_boundaries.clear();
Guolin Ke's avatar
Guolin Ke committed
322
323
      }
    }
324
325
326
327
328
329
330
    if (init_score_load_from_file_) {
      // contain initial score file
      if (!init_score_.empty() && (num_init_score_ % num_all_data) != 0) {
        init_score_.clear();
        num_init_score_ = 0;
        Log::Fatal("Initial score size doesn't match data size");
      }
Guolin Ke's avatar
Guolin Ke committed
331

332
333
334
335
336
337
      // get local initial scores
      if (!init_score_.empty()) {
        auto old_scores = init_score_;
        int num_class = static_cast<int>(num_init_score_ / num_all_data);
        num_init_score_ = static_cast<int64_t>(num_data_) * num_class;
        init_score_ = std::vector<double>(num_init_score_);
338
#pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
339
        for (int k = 0; k < num_class; ++k) {
340
341
          const size_t offset_dest = static_cast<size_t>(k) * num_data_;
          const size_t offset_src = static_cast<size_t>(k) * num_all_data;
342
          for (size_t i = 0; i < used_data_indices.size(); ++i) {
343
            init_score_[offset_dest + i] = old_scores[offset_src + used_data_indices[i]];
344
          }
345
        }
346
        old_scores.clear();
Guolin Ke's avatar
Guolin Ke committed
347
348
      }
    }
349
350
    // re-calculate query weight
    CalculateQueryWeights();
Guolin Ke's avatar
Guolin Ke committed
351
  }
352
353
354
355
  if (num_queries_ > 0) {
    Log::Debug("Number of queries in %s: %i. Average number of rows per query: %f.",
      data_filename_.c_str(), static_cast<int>(num_queries_), static_cast<double>(num_data_) / num_queries_);
  }
Guolin Ke's avatar
Guolin Ke committed
356
357
}

358
359
template <typename It>
void Metadata::SetInitScoresFromIterator(It first, It last) {
360
  std::lock_guard<std::mutex> lock(mutex_);
361
362
  // Clear init scores on empty input
  if (last - first == 0) {
363
364
365
366
    init_score_.clear();
    num_init_score_ = 0;
    return;
  }
367
  if (((last - first) % num_data_) != 0) {
368
369
    Log::Fatal("Initial score size doesn't match data size");
  }
370
371
372
373
  if (init_score_.empty()) {
    init_score_.resize(last - first);
  }
  num_init_score_ = last - first;
374

375
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static, 512) if (num_init_score_ >= 1024)
Guolin Ke's avatar
Guolin Ke committed
376
  for (int64_t i = 0; i < num_init_score_; ++i) {
377
    init_score_[i] = Common::AvoidInf(first[i]);
378
  }
379
  init_score_load_from_file_ = false;
380

381
  #ifdef USE_CUDA
382
  if (cuda_metadata_ != nullptr) {
383
    cuda_metadata_->SetInitScore(init_score_.data(), init_score_.size());
384
  }
385
  #endif  // USE_CUDA
386
387
}

388
389
390
391
392
393
394
395
void Metadata::SetInitScore(const double* init_score, data_size_t len) {
  SetInitScoresFromIterator(init_score, init_score + len);
}

void Metadata::SetInitScore(const ArrowChunkedArray& array) {
  SetInitScoresFromIterator(array.begin<double>(), array.end<double>());
}

396
397
398
399
400
401
402
403
404
405
void Metadata::InsertInitScores(const double* init_scores, data_size_t start_index, data_size_t len, data_size_t source_size) {
  if (num_init_score_ <= 0) {
    Log::Fatal("Inserting initial score data into dataset with no initial scores");
  }
  if (start_index + len > num_data_) {
    // Note that len here is row count, not num_init_score, so we compare against num_data
    Log::Fatal("Inserted initial score data is too large for dataset");
  }
  if (init_score_.empty()) { init_score_.resize(num_init_score_); }

406
  int nclasses = num_init_score_classes();
407
408
409
410
411
412
413
414
415
416
417

  for (int32_t col = 0; col < nclasses; ++col) {
    int32_t dest_offset = num_data_ * col + start_index;
    // We need to use source_size here, because len might not equal size (due to a partially loaded dataset)
    int32_t source_offset = source_size * col;
    memcpy(init_score_.data() + dest_offset, init_scores + source_offset, sizeof(double) * len);
  }
  init_score_load_from_file_ = false;
  // CUDA is handled after all insertions are complete
}

418
419
template <typename It>
void Metadata::SetLabelsFromIterator(It first, It last) {
420
  std::lock_guard<std::mutex> lock(mutex_);
421
422
  if (num_data_ != last - first) {
    Log::Fatal("Length of labels differs from the length of #data");
423
  }
424
425
  if (label_.empty()) {
    label_.resize(num_data_);
Guolin Ke's avatar
Guolin Ke committed
426
  }
427

428
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static, 512) if (num_data_ >= 1024)
Guolin Ke's avatar
Guolin Ke committed
429
  for (data_size_t i = 0; i < num_data_; ++i) {
430
    label_[i] = Common::AvoidInf(first[i]);
Guolin Ke's avatar
Guolin Ke committed
431
  }
432

433
  #ifdef USE_CUDA
434
  if (cuda_metadata_ != nullptr) {
435
    cuda_metadata_->SetLabel(label_.data(), label_.size());
436
  }
437
  #endif  // USE_CUDA
Guolin Ke's avatar
Guolin Ke committed
438
439
}

440
441
442
443
444
445
446
447
448
449
450
void Metadata::SetLabel(const label_t* label, data_size_t len) {
  if (label == nullptr) {
    Log::Fatal("label cannot be nullptr");
  }
  SetLabelsFromIterator(label, label + len);
}

void Metadata::SetLabel(const ArrowChunkedArray& array) {
  SetLabelsFromIterator(array.begin<label_t>(), array.end<label_t>());
}

451
452
453
454
455
456
457
458
459
460
461
462
463
464
void Metadata::InsertLabels(const label_t* labels, data_size_t start_index, data_size_t len) {
  if (labels == nullptr) {
    Log::Fatal("label cannot be nullptr");
  }
  if (start_index + len > num_data_) {
    Log::Fatal("Inserted label data is too large for dataset");
  }
  if (label_.empty()) { label_.resize(num_data_); }

  memcpy(label_.data() + start_index, labels, sizeof(label_t) * len);

  // CUDA is handled after all insertions are complete
}

465
466
template <typename It>
void Metadata::SetWeightsFromIterator(It first, It last) {
467
  std::lock_guard<std::mutex> lock(mutex_);
468
469
  // Clear weights on empty input
  if (last - first == 0) {
470
471
472
473
    weights_.clear();
    num_weights_ = 0;
    return;
  }
474
475
476
477
478
  if (num_data_ != last - first) {
    Log::Fatal("Length of weights differs from the length of #data");
  }
  if (weights_.empty()) {
    weights_.resize(num_data_);
Guolin Ke's avatar
Guolin Ke committed
479
480
  }
  num_weights_ = num_data_;
481

482
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static, 512) if (num_weights_ >= 1024)
Guolin Ke's avatar
Guolin Ke committed
483
  for (data_size_t i = 0; i < num_weights_; ++i) {
484
    weights_[i] = Common::AvoidInf(first[i]);
Guolin Ke's avatar
Guolin Ke committed
485
  }
486
  CalculateQueryWeights();
487
  weight_load_from_file_ = false;
488

489
  #ifdef USE_CUDA
490
  if (cuda_metadata_ != nullptr) {
491
    cuda_metadata_->SetWeights(weights_.data(), weights_.size());
492
  }
493
  #endif  // USE_CUDA
Guolin Ke's avatar
Guolin Ke committed
494
495
}

496
497
498
499
500
501
502
503
void Metadata::SetWeights(const label_t* weights, data_size_t len) {
  SetWeightsFromIterator(weights, weights + len);
}

void Metadata::SetWeights(const ArrowChunkedArray& array) {
  SetWeightsFromIterator(array.begin<label_t>(), array.end<label_t>());
}

504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
void Metadata::InsertWeights(const label_t* weights, data_size_t start_index, data_size_t len) {
  if (!weights) {
    Log::Fatal("Passed null weights");
  }
  if (num_weights_ <= 0) {
    Log::Fatal("Inserting weight data into dataset with no weights");
  }
  if (start_index + len > num_weights_) {
    Log::Fatal("Inserted weight data is too large for dataset");
  }
  if (weights_.empty()) { weights_.resize(num_weights_); }

  memcpy(weights_.data() + start_index, weights, sizeof(label_t) * len);

  weight_load_from_file_ = false;
  // CUDA is handled after all insertions are complete
}

522
523
template <typename It>
void Metadata::SetQueriesFromIterator(It first, It last) {
524
  std::lock_guard<std::mutex> lock(mutex_);
525
526
  // Clear query boundaries on empty input
  if (last - first == 0) {
527
528
529
530
    query_boundaries_.clear();
    num_queries_ = 0;
    return;
  }
531

Guolin Ke's avatar
Guolin Ke committed
532
  data_size_t sum = 0;
533
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static) reduction(+:sum)
534
535
  for (data_size_t i = 0; i < last - first; ++i) {
    sum += first[i];
Guolin Ke's avatar
Guolin Ke committed
536
537
  }
  if (num_data_ != sum) {
538
    Log::Fatal("Sum of query counts (%i) differs from the length of #data (%i)", num_data_, sum);
Guolin Ke's avatar
Guolin Ke committed
539
  }
540
541
  num_queries_ = last - first;

542
  query_boundaries_.resize(num_queries_ + 1);
Guolin Ke's avatar
Guolin Ke committed
543
  query_boundaries_[0] = 0;
Guolin Ke's avatar
Guolin Ke committed
544
  for (data_size_t i = 0; i < num_queries_; ++i) {
545
    query_boundaries_[i + 1] = query_boundaries_[i] + first[i];
Guolin Ke's avatar
Guolin Ke committed
546
  }
547
  CalculateQueryWeights();
548
  query_load_from_file_ = false;
549

550
  #ifdef USE_CUDA
551
552
553
554
555
556
557
558
  if (cuda_metadata_ != nullptr) {
    if (query_weights_.size() > 0) {
      CHECK_EQ(query_weights_.size(), static_cast<size_t>(num_queries_));
      cuda_metadata_->SetQuery(query_boundaries_.data(), query_weights_.data(), num_queries_);
    } else {
      cuda_metadata_->SetQuery(query_boundaries_.data(), nullptr, num_queries_);
    }
  }
559
  #endif  // USE_CUDA
560
}
Guolin Ke's avatar
Guolin Ke committed
561

562
563
564
565
566
567
568
569
void Metadata::SetQuery(const data_size_t* query, data_size_t len) {
  SetQueriesFromIterator(query, query + len);
}

void Metadata::SetQuery(const ArrowChunkedArray& array) {
  SetQueriesFromIterator(array.begin<data_size_t>(), array.end<data_size_t>());
}

570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
void Metadata::SetPosition(const data_size_t* positions, data_size_t len) {
  std::lock_guard<std::mutex> lock(mutex_);
  // save to nullptr
  if (positions == nullptr || len == 0) {
    positions_.clear();
    num_positions_ = 0;
    return;
  }
  #ifdef USE_CUDA
  Log::Fatal("Positions in learning to rank is not supported in CUDA version yet.");
  #endif  // USE_CUDA
  if (num_data_ != len) {
    Log::Fatal("Positions size (%i) doesn't match data size (%i)", len, num_data_);
  }
  if (positions_.empty()) {
    positions_.resize(num_data_);
  } else {
    Log::Warning("Overwritting positions in dataset.");
  }
  num_positions_ = num_data_;

  position_load_from_file_ = false;

  position_ids_.clear();
  std::unordered_map<data_size_t, int> map_id2pos;
  for (data_size_t i = 0; i < num_positions_; ++i) {
    if (map_id2pos.count(positions[i]) == 0) {
      int pos = static_cast<int>(map_id2pos.size());
      map_id2pos[positions[i]] = pos;
      position_ids_.push_back(std::to_string(positions[i]));
    }
  }

  Log::Debug("number of unique positions found = %ld", position_ids_.size());

605
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static, 512) if (num_positions_ >= 1024)
606
607
608
609
610
  for (data_size_t i = 0; i < num_positions_; ++i) {
    positions_[i] = map_id2pos.at(positions[i]);
  }
}

611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
void Metadata::InsertQueries(const data_size_t* queries, data_size_t start_index, data_size_t len) {
  if (!queries) {
    Log::Fatal("Passed null queries");
  }
  if (queries_.size() <= 0) {
    Log::Fatal("Inserting query data into dataset with no queries");
  }
  if (static_cast<size_t>(start_index + len) > queries_.size()) {
    Log::Fatal("Inserted query data is too large for dataset");
  }

  memcpy(queries_.data() + start_index, queries, sizeof(data_size_t) * len);

  query_load_from_file_ = false;
  // CUDA is handled after all insertions are complete
}

Guolin Ke's avatar
Guolin Ke committed
628
629
630
631
632
void Metadata::LoadWeights() {
  num_weights_ = 0;
  std::string weight_filename(data_filename_);
  // default weight file name
  weight_filename.append(".weight");
Guolin Ke's avatar
Guolin Ke committed
633
  TextReader<size_t> reader(weight_filename.c_str(), false);
Guolin Ke's avatar
Guolin Ke committed
634
  reader.ReadAllLines();
Guolin Ke's avatar
Guolin Ke committed
635
  if (reader.Lines().empty()) {
Guolin Ke's avatar
Guolin Ke committed
636
637
    return;
  }
638
  Log::Info("Loading weights...");
Guolin Ke's avatar
Guolin Ke committed
639
  num_weights_ = static_cast<data_size_t>(reader.Lines().size());
640
  weights_ = std::vector<label_t>(num_weights_);
641
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
Guolin Ke's avatar
Guolin Ke committed
642
  for (data_size_t i = 0; i < num_weights_; ++i) {
643
    double tmp_weight = 0.0f;
Guolin Ke's avatar
Guolin Ke committed
644
    Common::Atof(reader.Lines()[i].c_str(), &tmp_weight);
645
    weights_[i] = Common::AvoidInf(static_cast<label_t>(tmp_weight));
Guolin Ke's avatar
Guolin Ke committed
646
  }
647
  weight_load_from_file_ = true;
Guolin Ke's avatar
Guolin Ke committed
648
649
}

650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
void Metadata::LoadPositions() {
  num_positions_ = 0;
  std::string position_filename(data_filename_);
  // default position file name
  position_filename.append(".position");
  TextReader<size_t> reader(position_filename.c_str(), false);
  reader.ReadAllLines();
  if (reader.Lines().empty()) {
    return;
  }
  Log::Info("Loading positions from %s ...", position_filename.c_str());
  num_positions_ = static_cast<data_size_t>(reader.Lines().size());
  positions_ = std::vector<data_size_t>(num_positions_);
  position_ids_ = std::vector<std::string>();
  std::unordered_map<std::string, data_size_t> map_id2pos;
  for (data_size_t i = 0; i < num_positions_; ++i) {
    std::string& line = reader.Lines()[i];
    if (map_id2pos.count(line) == 0) {
      map_id2pos[line] = static_cast<data_size_t>(position_ids_.size());
      position_ids_.push_back(line);
    }
    positions_[i] = map_id2pos.at(line);
  }
  position_load_from_file_ = true;
}

676
void Metadata::LoadInitialScore(const std::string& data_filename) {
Guolin Ke's avatar
Guolin Ke committed
677
  num_init_score_ = 0;
678
679
  std::string init_score_filename(data_filename);
  init_score_filename = std::string(data_filename);
680
681
  // default init_score file name
  init_score_filename.append(".init");
Guolin Ke's avatar
Guolin Ke committed
682
  TextReader<size_t> reader(init_score_filename.c_str(), false);
Guolin Ke's avatar
Guolin Ke committed
683
  reader.ReadAllLines();
Guolin Ke's avatar
Guolin Ke committed
684
  if (reader.Lines().empty()) {
Guolin Ke's avatar
Guolin Ke committed
685
686
    return;
  }
687
688
  Log::Info("Loading initial scores...");

689
690
691
  // use first line to count number class
  int num_class = static_cast<int>(Common::Split(reader.Lines()[0].c_str(), '\t').size());
  data_size_t num_line = static_cast<data_size_t>(reader.Lines().size());
Guolin Ke's avatar
Guolin Ke committed
692
  num_init_score_ = static_cast<int64_t>(num_line) * num_class;
693

Guolin Ke's avatar
Guolin Ke committed
694
  init_score_ = std::vector<double>(num_init_score_);
695
  if (num_class == 1) {
696
    #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
697
    for (data_size_t i = 0; i < num_line; ++i) {
Guolin Ke's avatar
Guolin Ke committed
698
      double tmp = 0.0f;
699
      Common::Atof(reader.Lines()[i].c_str(), &tmp);
700
      init_score_[i] = Common::AvoidInf(static_cast<double>(tmp));
701
    }
702
  } else {
703
    std::vector<std::string> oneline_init_score;
704
    #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
705
    for (data_size_t i = 0; i < num_line; ++i) {
Guolin Ke's avatar
Guolin Ke committed
706
      double tmp = 0.0f;
707
708
      oneline_init_score = Common::Split(reader.Lines()[i].c_str(), '\t');
      if (static_cast<int>(oneline_init_score.size()) != num_class) {
709
        Log::Fatal("Invalid initial score file. Redundant or insufficient columns");
710
711
712
      }
      for (int k = 0; k < num_class; ++k) {
        Common::Atof(oneline_init_score[k].c_str(), &tmp);
713
        init_score_[static_cast<size_t>(k) * num_line + i] = Common::AvoidInf(static_cast<double>(tmp));
714
      }
715
    }
Guolin Ke's avatar
Guolin Ke committed
716
  }
717
  init_score_load_from_file_ = true;
Guolin Ke's avatar
Guolin Ke committed
718
719
720
721
722
723
724
}

void Metadata::LoadQueryBoundaries() {
  num_queries_ = 0;
  std::string query_filename(data_filename_);
  // default query file name
  query_filename.append(".query");
Guolin Ke's avatar
Guolin Ke committed
725
  TextReader<size_t> reader(query_filename.c_str(), false);
Guolin Ke's avatar
Guolin Ke committed
726
  reader.ReadAllLines();
Guolin Ke's avatar
Guolin Ke committed
727
  if (reader.Lines().empty()) {
Guolin Ke's avatar
Guolin Ke committed
728
729
    return;
  }
730
  Log::Info("Calculating query boundaries...");
Guolin Ke's avatar
Guolin Ke committed
731
  query_boundaries_ = std::vector<data_size_t>(reader.Lines().size() + 1);
Guolin Ke's avatar
Guolin Ke committed
732
733
734
735
736
737
738
  num_queries_ = static_cast<data_size_t>(reader.Lines().size());
  query_boundaries_[0] = 0;
  for (size_t i = 0; i < reader.Lines().size(); ++i) {
    int tmp_cnt;
    Common::Atoi(reader.Lines()[i].c_str(), &tmp_cnt);
    query_boundaries_[i + 1] = query_boundaries_[i] + static_cast<data_size_t>(tmp_cnt);
  }
739
  query_load_from_file_ = true;
Guolin Ke's avatar
Guolin Ke committed
740
741
}

742
void Metadata::CalculateQueryWeights() {
Guolin Ke's avatar
Guolin Ke committed
743
  if (weights_.size() == 0 || query_boundaries_.size() == 0) {
Guolin Ke's avatar
Guolin Ke committed
744
745
    return;
  }
Guolin Ke's avatar
Guolin Ke committed
746
  query_weights_.clear();
747
  Log::Info("Calculating query weights...");
748
  query_weights_ = std::vector<label_t>(num_queries_);
Guolin Ke's avatar
Guolin Ke committed
749
750
751
752
753
754
755
756
757
  for (data_size_t i = 0; i < num_queries_; ++i) {
    query_weights_[i] = 0.0f;
    for (data_size_t j = query_boundaries_[i]; j < query_boundaries_[i + 1]; ++j) {
      query_weights_[i] += weights_[j];
    }
    query_weights_[i] /= (query_boundaries_[i + 1] - query_boundaries_[i]);
  }
}

758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
void Metadata::InsertAt(data_size_t start_index,
  data_size_t count,
  const float* labels,
  const float* weights,
  const double* init_scores,
  const int32_t* queries) {
  if (num_data_ < count + start_index) {
    Log::Fatal("Length of metadata is too long to append #data");
  }
  InsertLabels(labels, start_index, count);
  if (weights) {
    InsertWeights(weights, start_index, count);
  }
  if (init_scores) {
    InsertInitScores(init_scores, start_index, count, count);
  }
  if (queries) {
    InsertQueries(queries, start_index, count);
  }
}

void Metadata::FinishLoad() {
  CalculateQueryBoundaries();
}

783
#ifdef USE_CUDA
784
785
786
787
void Metadata::CreateCUDAMetadata(const int gpu_device_id) {
  cuda_metadata_.reset(new CUDAMetadata(gpu_device_id));
  cuda_metadata_->Init(label_, weights_, query_boundaries_, query_weights_, init_score_);
}
788
#endif  // USE_CUDA
789

Guolin Ke's avatar
Guolin Ke committed
790
791
792
793
void Metadata::LoadFromMemory(const void* memory) {
  const char* mem_ptr = reinterpret_cast<const char*>(memory);

  num_data_ = *(reinterpret_cast<const data_size_t*>(mem_ptr));
794
  mem_ptr += VirtualFileWriter::AlignedSize(sizeof(num_data_));
Guolin Ke's avatar
Guolin Ke committed
795
  num_weights_ = *(reinterpret_cast<const data_size_t*>(mem_ptr));
796
  mem_ptr += VirtualFileWriter::AlignedSize(sizeof(num_weights_));
Guolin Ke's avatar
Guolin Ke committed
797
  num_queries_ = *(reinterpret_cast<const data_size_t*>(mem_ptr));
798
  mem_ptr += VirtualFileWriter::AlignedSize(sizeof(num_queries_));
Guolin Ke's avatar
Guolin Ke committed
799

Guolin Ke's avatar
Guolin Ke committed
800
  if (!label_.empty()) { label_.clear(); }
801
  label_ = std::vector<label_t>(num_data_);
802
  std::memcpy(label_.data(), mem_ptr, sizeof(label_t) * num_data_);
803
  mem_ptr += VirtualFileWriter::AlignedSize(sizeof(label_t) * num_data_);
Guolin Ke's avatar
Guolin Ke committed
804
805

  if (num_weights_ > 0) {
Guolin Ke's avatar
Guolin Ke committed
806
    if (!weights_.empty()) { weights_.clear(); }
807
    weights_ = std::vector<label_t>(num_weights_);
808
    std::memcpy(weights_.data(), mem_ptr, sizeof(label_t) * num_weights_);
809
    mem_ptr += VirtualFileWriter::AlignedSize(sizeof(label_t) * num_weights_);
810
    weight_load_from_file_ = true;
Guolin Ke's avatar
Guolin Ke committed
811
812
  }
  if (num_queries_ > 0) {
Guolin Ke's avatar
Guolin Ke committed
813
    if (!query_boundaries_.empty()) { query_boundaries_.clear(); }
Guolin Ke's avatar
Guolin Ke committed
814
    query_boundaries_ = std::vector<data_size_t>(num_queries_ + 1);
815
    std::memcpy(query_boundaries_.data(), mem_ptr, sizeof(data_size_t) * (num_queries_ + 1));
816
817
    mem_ptr += VirtualFileWriter::AlignedSize(sizeof(data_size_t) *
                                              (num_queries_ + 1));
818
    query_load_from_file_ = true;
Guolin Ke's avatar
Guolin Ke committed
819
  }
820
  CalculateQueryWeights();
Guolin Ke's avatar
Guolin Ke committed
821
822
}

823
void Metadata::SaveBinaryToFile(BinaryWriter* writer) const {
824
825
826
827
  writer->AlignedWrite(&num_data_, sizeof(num_data_));
  writer->AlignedWrite(&num_weights_, sizeof(num_weights_));
  writer->AlignedWrite(&num_queries_, sizeof(num_queries_));
  writer->AlignedWrite(label_.data(), sizeof(label_t) * num_data_);
Guolin Ke's avatar
Guolin Ke committed
828
  if (!weights_.empty()) {
829
    writer->AlignedWrite(weights_.data(), sizeof(label_t) * num_weights_);
Guolin Ke's avatar
Guolin Ke committed
830
  }
Guolin Ke's avatar
Guolin Ke committed
831
  if (!query_boundaries_.empty()) {
832
833
    writer->AlignedWrite(query_boundaries_.data(),
                         sizeof(data_size_t) * (num_queries_ + 1));
Guolin Ke's avatar
Guolin Ke committed
834
  }
835
836
837
838
  if (num_init_score_ > 0) {
    Log::Warning("Please note that `init_score` is not saved in binary file.\n"
      "If you need it, please set it again after loading Dataset.");
  }
Guolin Ke's avatar
Guolin Ke committed
839
840
}

841
size_t Metadata::SizesInByte() const {
842
843
844
845
  size_t size = VirtualFileWriter::AlignedSize(sizeof(num_data_)) +
                VirtualFileWriter::AlignedSize(sizeof(num_weights_)) +
                VirtualFileWriter::AlignedSize(sizeof(num_queries_));
  size += VirtualFileWriter::AlignedSize(sizeof(label_t) * num_data_);
Guolin Ke's avatar
Guolin Ke committed
846
  if (!weights_.empty()) {
847
    size += VirtualFileWriter::AlignedSize(sizeof(label_t) * num_weights_);
Guolin Ke's avatar
Guolin Ke committed
848
  }
Guolin Ke's avatar
Guolin Ke committed
849
  if (!query_boundaries_.empty()) {
850
851
    size += VirtualFileWriter::AlignedSize(sizeof(data_size_t) *
                                           (num_queries_ + 1));
Guolin Ke's avatar
Guolin Ke committed
852
853
854
855
856
857
  }
  return size;
}


}  // namespace LightGBM