xgboost_lib-sys 3.0.5

Native bindings to the xgboost library
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

/**
 * Copyright 2017-2023, XGBoost Contributors
 * \brief Utility for fast column-wise access
 */
#include "column_matrix.h"

#include <algorithm>    // for transform
#include <cstddef>      // for size_t
#include <cstdint>      // for uint64_t, uint8_t
#include <limits>       // for numeric_limits
#include <type_traits>  // for remove_reference_t
#include <vector>       // for vector

#include "../data/gradient_index.h"  // for GHistIndexMatrix
#include "io.h"                      // for AlignedResourceReadStream, AlignedFileWriteStream
#include "xgboost/base.h"            // for bst_feaature_t
#include "xgboost/span.h"            // for Span

namespace xgboost::common {
void ColumnMatrix::InitStorage(GHistIndexMatrix const& gmat, double sparse_threshold) {
  auto const nfeature = gmat.Features();
  const size_t nrow = gmat.Size();
  // identify type of each column
  type_ = common::MakeFixedVecWithMalloc(nfeature, ColumnType{});

  uint32_t max_val = std::numeric_limits<uint32_t>::max();
  for (bst_feature_t fid = 0; fid < nfeature; ++fid) {
    CHECK_LE(gmat.cut.Ptrs()[fid + 1] - gmat.cut.Ptrs()[fid], max_val);
  }

  bool all_dense_column = true;

  std::vector<size_t> feature_counts(nfeature, 0);
  gmat.GetFeatureCounts(feature_counts.data());

  // classify features
  for (bst_feature_t fid = 0; fid < nfeature; ++fid) {
    if (static_cast<double>(feature_counts[fid]) < sparse_threshold * nrow) {
      type_[fid] = kSparseColumn;
      all_dense_column = false;
    } else {
      type_[fid] = kDenseColumn;
    }
  }

  // want to compute storage boundary for each feature
  // using variants of prefix sum scan
  feature_offsets_ = common::MakeFixedVecWithMalloc(nfeature + 1, std::size_t{0});
  size_t accum_index = 0;
  feature_offsets_[0] = accum_index;
  for (bst_feature_t fid = 1; fid < nfeature + 1; ++fid) {
    if (type_[fid - 1] == kDenseColumn) {
      accum_index += static_cast<size_t>(nrow);
    } else {
      accum_index += feature_counts[fid - 1];
    }
    feature_offsets_[fid] = accum_index;
  }

  SetTypeSize(gmat.MaxNumBinPerFeat());
  auto storage_size =
      feature_offsets_.back() * static_cast<std::underlying_type_t<BinTypeSize>>(bins_type_size_);

  index_ = common::MakeFixedVecWithMalloc(storage_size, std::uint8_t{0});

  if (!all_dense_column) {
    row_ind_ = common::MakeFixedVecWithMalloc(feature_offsets_[nfeature], std::size_t{0});
  }

  // store least bin id for each feature
  index_base_ = const_cast<uint32_t*>(gmat.cut.Ptrs().data());

  any_missing_ = !gmat.IsDense();

  missing_ = MissingIndicator{0, false};
}

// IO procedures for external memory.
bool ColumnMatrix::Read(AlignedResourceReadStream* fi, uint32_t const* index_base) {
  if (!common::ReadVec(fi, &index_)) {
    return false;
  }
  if (!common::ReadVec(fi, &type_)) {
    return false;
  }
  if (!common::ReadVec(fi, &row_ind_)) {
    return false;
  }
  if (!common::ReadVec(fi, &feature_offsets_)) {
    return false;
  }

  if (!common::ReadVec(fi, &missing_.storage)) {
    return false;
  }
  missing_.InitView();

  index_base_ = index_base;
  if (!fi->Read(&bins_type_size_)) {
    return false;
  }
  if (!fi->Read(&any_missing_)) {
    return false;
  }
  return true;
}

std::size_t ColumnMatrix::Write(AlignedFileWriteStream* fo) const {
  std::size_t bytes{0};

  bytes += common::WriteVec(fo, index_);
  bytes += common::WriteVec(fo, type_);
  bytes += common::WriteVec(fo, row_ind_);
  bytes += common::WriteVec(fo, feature_offsets_);
  bytes += common::WriteVec(fo, missing_.storage);

  bytes += fo->Write(bins_type_size_);
  bytes += fo->Write(any_missing_);

  return bytes;
}
}  // namespace xgboost::common