"src/vscode:/vscode.git/clone" did not exist on "ef408f552a293f3bc7e98f89b9d15564e0b17938"
metadata.cpp 29.8 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
    }
59
60
61
    if (!query_weights_.empty()) {
      query_weights_.clear();
    }
62
    queries_ = std::vector<data_size_t>(num_data_, 0);
63
    query_load_from_file_ = false;
Guolin Ke's avatar
Guolin Ke committed
64
  }
Guolin Ke's avatar
Guolin Ke committed
65
66
}

67
68
69
70
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;
71
  int nclasses = reference->num_init_score_classes();
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
100
101
  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
102
103
104
void Metadata::Init(const Metadata& fullset, const data_size_t* used_indices, data_size_t num_used_indices) {
  num_data_ = num_used_indices;

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

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

Guolin Ke's avatar
Guolin Ke committed
122
  if (!fullset.init_score_.empty()) {
Guolin Ke's avatar
Guolin Ke committed
123
    int num_class = static_cast<int>(fullset.num_init_score_ / fullset.num_data_);
124
    init_score_ = std::vector<double>(static_cast<size_t>(num_used_indices) * num_class);
Guolin Ke's avatar
Guolin Ke committed
125
    num_init_score_ = static_cast<int64_t>(num_used_indices) * num_class;
126
    #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
127
    for (int k = 0; k < num_class; ++k) {
128
129
130
131
      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]];
132
      }
Guolin Ke's avatar
Guolin Ke committed
133
134
135
136
137
    }
  } else {
    num_init_score_ = 0;
  }

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

185
186
187
188
189
190
191
192
193
194
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
195
        }
196
197
        cur_cnt = 0;
        last_qid = queries_[i];
Guolin Ke's avatar
Guolin Ke committed
198
      }
199
      ++cur_cnt;
Guolin Ke's avatar
Guolin Ke committed
200
    }
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
    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
216
    // check weights
Guolin Ke's avatar
Guolin Ke committed
217
    if (!weights_.empty() && num_weights_ != num_data_) {
Guolin Ke's avatar
Guolin Ke committed
218
      weights_.clear();
Guolin Ke's avatar
Guolin Ke committed
219
      num_weights_ = 0;
Guolin Ke's avatar
Guolin Ke committed
220
      Log::Fatal("Weights size doesn't match data size");
Guolin Ke's avatar
Guolin Ke committed
221
222
    }

223
224
225
226
227
228
229
    // 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;
    }

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

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

334
335
336
337
338
339
      // 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_);
340
#pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
341
        for (int k = 0; k < num_class; ++k) {
342
343
          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;
344
          for (size_t i = 0; i < used_data_indices.size(); ++i) {
345
            init_score_[offset_dest + i] = old_scores[offset_src + used_data_indices[i]];
346
          }
347
        }
348
        old_scores.clear();
Guolin Ke's avatar
Guolin Ke committed
349
350
      }
    }
351
352
    // re-calculate query weight
    CalculateQueryWeights();
Guolin Ke's avatar
Guolin Ke committed
353
  }
354
355
356
357
  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
358
359
}

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

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

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

390
391
392
393
394
395
396
397
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>());
}

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");
  }
406
407
408
  if (init_score_.empty()) {
    init_score_.resize(num_init_score_);
  }
409

410
  int nclasses = num_init_score_classes();
411
412
413
414
415
416
417
418
419
420
421

  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
}

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

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

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

444
445
446
447
448
449
450
451
452
453
454
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>());
}

455
456
457
458
459
460
461
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");
  }
462
463
464
  if (label_.empty()) {
    label_.resize(num_data_);
  }
465
466
467
468
469
470

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

  // CUDA is handled after all insertions are complete
}

471
472
template <typename It>
void Metadata::SetWeightsFromIterator(It first, It last) {
473
  std::lock_guard<std::mutex> lock(mutex_);
474
475
  // Clear weights on empty input
  if (last - first == 0) {
476
477
478
479
    weights_.clear();
    num_weights_ = 0;
    return;
  }
480
481
482
483
484
  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
485
486
  }
  num_weights_ = num_data_;
487

488
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static, 512) if (num_weights_ >= 1024)
Guolin Ke's avatar
Guolin Ke committed
489
  for (data_size_t i = 0; i < num_weights_; ++i) {
490
    weights_[i] = Common::AvoidInf(first[i]);
Guolin Ke's avatar
Guolin Ke committed
491
  }
492
  CalculateQueryWeights();
493
  weight_load_from_file_ = false;
494

495
  #ifdef USE_CUDA
496
  if (cuda_metadata_ != nullptr) {
497
    cuda_metadata_->SetWeights(weights_.data(), weights_.size());
498
  }
499
  #endif  // USE_CUDA
Guolin Ke's avatar
Guolin Ke committed
500
501
}

502
503
504
505
506
507
508
509
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>());
}

510
511
512
513
514
515
516
517
518
519
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");
  }
520
521
522
  if (weights_.empty()) {
    weights_.resize(num_weights_);
  }
523
524
525
526
527
528
529

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

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

530
531
template <typename It>
void Metadata::SetQueriesFromIterator(It first, It last) {
532
  std::lock_guard<std::mutex> lock(mutex_);
533
534
  // Clear query boundaries on empty input
  if (last - first == 0) {
535
536
537
538
    query_boundaries_.clear();
    num_queries_ = 0;
    return;
  }
539

Guolin Ke's avatar
Guolin Ke committed
540
  data_size_t sum = 0;
541
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static) reduction(+:sum)
542
  for (data_size_t i = 0; i < static_cast<data_size_t>(last - first); ++i) {
543
    sum += first[i];
Guolin Ke's avatar
Guolin Ke committed
544
545
  }
  if (num_data_ != sum) {
546
    Log::Fatal("Sum of query counts (%i) differs from the length of #data (%i)", num_data_, sum);
Guolin Ke's avatar
Guolin Ke committed
547
  }
548
549
  num_queries_ = last - first;

550
  query_boundaries_.resize(num_queries_ + 1);
Guolin Ke's avatar
Guolin Ke committed
551
  query_boundaries_[0] = 0;
Guolin Ke's avatar
Guolin Ke committed
552
  for (data_size_t i = 0; i < num_queries_; ++i) {
553
    query_boundaries_[i + 1] = query_boundaries_[i] + first[i];
Guolin Ke's avatar
Guolin Ke committed
554
  }
555
  CalculateQueryWeights();
556
  query_load_from_file_ = false;
557

558
  #ifdef USE_CUDA
559
560
561
562
563
564
565
566
  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_);
    }
  }
567
  #endif  // USE_CUDA
568
}
Guolin Ke's avatar
Guolin Ke committed
569

570
571
572
573
574
575
576
577
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>());
}

578
579
580
581
582
583
584
585
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;
  }
586
  #ifdef USE_CUDA
587
  Log::Fatal("Positions in learning to rank is not supported in CUDA version yet.");
588
  #endif  // USE_CUDA
589
590
591
592
593
594
  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 {
595
    Log::Warning("Overwriting positions in dataset.");
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
  }
  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());

613
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static, 512) if (num_positions_ >= 1024)
614
615
616
617
618
  for (data_size_t i = 0; i < num_positions_; ++i) {
    positions_[i] = map_id2pos.at(positions[i]);
  }
}

619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
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
636
637
638
639
640
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
641
  TextReader<size_t> reader(weight_filename.c_str(), false);
Guolin Ke's avatar
Guolin Ke committed
642
  reader.ReadAllLines();
Guolin Ke's avatar
Guolin Ke committed
643
  if (reader.Lines().empty()) {
Guolin Ke's avatar
Guolin Ke committed
644
645
    return;
  }
646
  Log::Info("Loading weights...");
Guolin Ke's avatar
Guolin Ke committed
647
  num_weights_ = static_cast<data_size_t>(reader.Lines().size());
648
  weights_ = std::vector<label_t>(num_weights_);
649
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
Guolin Ke's avatar
Guolin Ke committed
650
  for (data_size_t i = 0; i < num_weights_; ++i) {
651
    double tmp_weight = 0.0f;
Guolin Ke's avatar
Guolin Ke committed
652
    Common::Atof(reader.Lines()[i].c_str(), &tmp_weight);
653
    weights_[i] = Common::AvoidInf(static_cast<label_t>(tmp_weight));
Guolin Ke's avatar
Guolin Ke committed
654
  }
655
  weight_load_from_file_ = true;
Guolin Ke's avatar
Guolin Ke committed
656
657
}

658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
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;
}

684
void Metadata::LoadInitialScore(const std::string& data_filename) {
Guolin Ke's avatar
Guolin Ke committed
685
  num_init_score_ = 0;
686
687
  std::string init_score_filename(data_filename);
  init_score_filename = std::string(data_filename);
688
689
  // default init_score file name
  init_score_filename.append(".init");
Guolin Ke's avatar
Guolin Ke committed
690
  TextReader<size_t> reader(init_score_filename.c_str(), false);
Guolin Ke's avatar
Guolin Ke committed
691
  reader.ReadAllLines();
Guolin Ke's avatar
Guolin Ke committed
692
  if (reader.Lines().empty()) {
Guolin Ke's avatar
Guolin Ke committed
693
694
    return;
  }
695
696
  Log::Info("Loading initial scores...");

697
698
699
  // 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
700
  num_init_score_ = static_cast<int64_t>(num_line) * num_class;
701

Guolin Ke's avatar
Guolin Ke committed
702
  init_score_ = std::vector<double>(num_init_score_);
703
  if (num_class == 1) {
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
      Common::Atof(reader.Lines()[i].c_str(), &tmp);
708
      init_score_[i] = Common::AvoidInf(static_cast<double>(tmp));
709
    }
710
  } else {
711
    std::vector<std::string> oneline_init_score;
712
    #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
713
    for (data_size_t i = 0; i < num_line; ++i) {
Guolin Ke's avatar
Guolin Ke committed
714
      double tmp = 0.0f;
715
716
      oneline_init_score = Common::Split(reader.Lines()[i].c_str(), '\t');
      if (static_cast<int>(oneline_init_score.size()) != num_class) {
717
        Log::Fatal("Invalid initial score file. Redundant or insufficient columns");
718
719
720
      }
      for (int k = 0; k < num_class; ++k) {
        Common::Atof(oneline_init_score[k].c_str(), &tmp);
721
        init_score_[static_cast<size_t>(k) * num_line + i] = Common::AvoidInf(static_cast<double>(tmp));
722
      }
723
    }
Guolin Ke's avatar
Guolin Ke committed
724
  }
725
  init_score_load_from_file_ = true;
Guolin Ke's avatar
Guolin Ke committed
726
727
728
729
730
731
732
}

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
733
  TextReader<size_t> reader(query_filename.c_str(), false);
Guolin Ke's avatar
Guolin Ke committed
734
  reader.ReadAllLines();
Guolin Ke's avatar
Guolin Ke committed
735
  if (reader.Lines().empty()) {
Guolin Ke's avatar
Guolin Ke committed
736
737
    return;
  }
738
  Log::Info("Calculating query boundaries...");
Guolin Ke's avatar
Guolin Ke committed
739
  query_boundaries_ = std::vector<data_size_t>(reader.Lines().size() + 1);
Guolin Ke's avatar
Guolin Ke committed
740
741
742
743
744
745
746
  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);
  }
747
  query_load_from_file_ = true;
Guolin Ke's avatar
Guolin Ke committed
748
749
}

750
void Metadata::CalculateQueryWeights() {
Guolin Ke's avatar
Guolin Ke committed
751
  if (weights_.size() == 0 || query_boundaries_.size() == 0) {
Guolin Ke's avatar
Guolin Ke committed
752
753
    return;
  }
Guolin Ke's avatar
Guolin Ke committed
754
  query_weights_.clear();
755
  Log::Info("Calculating query weights...");
756
  query_weights_ = std::vector<label_t>(num_queries_);
Guolin Ke's avatar
Guolin Ke committed
757
758
759
760
761
762
763
764
765
  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]);
  }
}

766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
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();
}

791
#ifdef USE_CUDA
792
793
794
795
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_);
}
796
#endif  // USE_CUDA
797

Guolin Ke's avatar
Guolin Ke committed
798
799
800
801
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));
802
  mem_ptr += VirtualFileWriter::AlignedSize(sizeof(num_data_));
Guolin Ke's avatar
Guolin Ke committed
803
  num_weights_ = *(reinterpret_cast<const data_size_t*>(mem_ptr));
804
  mem_ptr += VirtualFileWriter::AlignedSize(sizeof(num_weights_));
Guolin Ke's avatar
Guolin Ke committed
805
  num_queries_ = *(reinterpret_cast<const data_size_t*>(mem_ptr));
806
  mem_ptr += VirtualFileWriter::AlignedSize(sizeof(num_queries_));
Guolin Ke's avatar
Guolin Ke committed
807

808
809
810
  if (!label_.empty()) {
    label_.clear();
  }
811
  label_ = std::vector<label_t>(num_data_);
812
  std::memcpy(label_.data(), mem_ptr, sizeof(label_t) * num_data_);
813
  mem_ptr += VirtualFileWriter::AlignedSize(sizeof(label_t) * num_data_);
Guolin Ke's avatar
Guolin Ke committed
814
815

  if (num_weights_ > 0) {
816
817
818
    if (!weights_.empty()) {
      weights_.clear();
    }
819
    weights_ = std::vector<label_t>(num_weights_);
820
    std::memcpy(weights_.data(), mem_ptr, sizeof(label_t) * num_weights_);
821
    mem_ptr += VirtualFileWriter::AlignedSize(sizeof(label_t) * num_weights_);
822
    weight_load_from_file_ = true;
Guolin Ke's avatar
Guolin Ke committed
823
824
  }
  if (num_queries_ > 0) {
825
826
827
    if (!query_boundaries_.empty()) {
      query_boundaries_.clear();
    }
Guolin Ke's avatar
Guolin Ke committed
828
    query_boundaries_ = std::vector<data_size_t>(num_queries_ + 1);
829
    std::memcpy(query_boundaries_.data(), mem_ptr, sizeof(data_size_t) * (num_queries_ + 1));
830
831
    mem_ptr += VirtualFileWriter::AlignedSize(sizeof(data_size_t) *
                                              (num_queries_ + 1));
832
    query_load_from_file_ = true;
Guolin Ke's avatar
Guolin Ke committed
833
  }
834
  CalculateQueryWeights();
Guolin Ke's avatar
Guolin Ke committed
835
836
}

837
void Metadata::SaveBinaryToFile(BinaryWriter* writer) const {
838
839
840
841
  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
842
  if (!weights_.empty()) {
843
    writer->AlignedWrite(weights_.data(), sizeof(label_t) * num_weights_);
Guolin Ke's avatar
Guolin Ke committed
844
  }
Guolin Ke's avatar
Guolin Ke committed
845
  if (!query_boundaries_.empty()) {
846
847
    writer->AlignedWrite(query_boundaries_.data(),
                         sizeof(data_size_t) * (num_queries_ + 1));
Guolin Ke's avatar
Guolin Ke committed
848
  }
849
850
851
852
  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
853
854
}

855
size_t Metadata::SizesInByte() const {
856
857
858
859
  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
860
  if (!weights_.empty()) {
861
    size += VirtualFileWriter::AlignedSize(sizeof(label_t) * num_weights_);
Guolin Ke's avatar
Guolin Ke committed
862
  }
Guolin Ke's avatar
Guolin Ke committed
863
  if (!query_boundaries_.empty()) {
864
865
    size += VirtualFileWriter::AlignedSize(sizeof(data_size_t) *
                                           (num_queries_ + 1));
Guolin Ke's avatar
Guolin Ke committed
866
867
868
869
870
871
  }
  return size;
}


}  // namespace LightGBM