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

/*!
 * Copyright 2018-2019 by Contributors
 */
#include <algorithm>
#include <unordered_set>
#include <vector>

#include "xgboost/span.h"
#include "xgboost/json.h"
#include "constraints.h"
#include "param.h"

namespace xgboost {
void FeatureInteractionConstraintHost::Configure(tree::TrainParam const& param,
                                                 bst_feature_t const n_features) {
  if (param.interaction_constraints.empty()) {
    enabled_ = !param.interaction_constraints.empty();
    return;  // short-circuit if no constraint is specified
  }
  enabled_ = true;

  this->interaction_constraint_str_ = param.interaction_constraints;
  this->n_features_ = n_features;
  this->Reset();
}

void FeatureInteractionConstraintHost::Reset() {
  if (!enabled_) {
    return;
  }
  // Read std::vector<std::vector<bst_feature_t>> first and then
  //   convert to std::vector<std::unordered_set<bst_feature_t>>
  std::vector<std::vector<bst_feature_t>> tmp;
  try {
    ParseInteractionConstraint(this->interaction_constraint_str_, &tmp);
  } catch (dmlc::Error const &e) {
    LOG(FATAL) << "Failed to parse feature interaction constraint:\n"
               << this->interaction_constraint_str_ << "\n"
               << "With error:\n" << e.what();
  }
  for (const auto& e : tmp) {
    interaction_constraints_.emplace_back(e.begin(), e.end());
  }

  // Initialise interaction constraints record with all variables permitted for the first node
  node_constraints_.clear();
  node_constraints_.resize(1, std::unordered_set<bst_feature_t>());
  node_constraints_[0].reserve(n_features_);
  for (bst_feature_t i = 0; i < n_features_; ++i) {
    node_constraints_[0].insert(i);
  }

  // Initialise splits record
  splits_.clear();
  splits_.resize(1, std::unordered_set<bst_feature_t>());
}

void FeatureInteractionConstraintHost::SplitImpl(
    bst_node_t node_id, bst_feature_t feature_id, bst_node_t left_id, bst_node_t right_id) {
  bst_node_t newsize = std::max(left_id, right_id) + 1;

  // Record previous splits for child nodes
  auto feature_splits = splits_[node_id];  // fid history of current node
  feature_splits.insert(feature_id);  // add feature of current node
  splits_.resize(newsize);
  splits_[left_id] = feature_splits;
  splits_[right_id] = feature_splits;

  // Resize constraints record, initialise all features to be not permitted for new nodes
  CHECK_NE(newsize, 0);
  node_constraints_.resize(newsize, std::unordered_set<bst_feature_t>());

  // Permit features used in previous splits
  for (bst_feature_t fid : feature_splits) {
    node_constraints_[left_id].insert(fid);
    node_constraints_[right_id].insert(fid);
  }

  // Loop across specified interactions in constraints
  for (const auto &constraint : interaction_constraints_) {
    // flags whether the specified interaction is still relevant
    bst_uint flag = 1;

    // Test relevance of specified interaction by checking all previous
    // features are included
    for (bst_uint checkvar : feature_splits) {
      if (constraint.count(checkvar) == 0) {
        flag = 0;
        break;   // interaction is not relevant due to unmet constraint
      }
    }

    // If interaction is still relevant, permit all other features in the
    // interaction
    if (flag == 1) {
      for (bst_uint k : constraint) {
        node_constraints_[left_id].insert(k);
        node_constraints_[right_id].insert(k);
      }
    }
  }
}
}  // namespace xgboost