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

/*!
 * Copyright (c) by Contributors 2019
 */
#include <gtest/gtest.h>

#include <xgboost/base.h>
#include <xgboost/parameter.h>

enum class Foo : int {
  kBar = 0, kFrog = 1, kCat = 2, kDog = 3
};

DECLARE_FIELD_ENUM_CLASS(Foo);

struct MyEnumParam : xgboost::XGBoostParameter<MyEnumParam> {
  Foo foo;
  int bar;
  DMLC_DECLARE_PARAMETER(MyEnumParam) {
    DMLC_DECLARE_FIELD(foo)
      .set_default(Foo::kBar)
      .add_enum("bar", Foo::kBar)
      .add_enum("frog", Foo::kFrog)
      .add_enum("cat", Foo::kCat)
      .add_enum("dog", Foo::kDog);
    DMLC_DECLARE_FIELD(bar)
      .set_default(-1);
  }
};

DMLC_REGISTER_PARAMETER(MyEnumParam);

TEST(EnumClassParam, Basic) {
  MyEnumParam param;
  std::map<std::string, std::string> kwargs{
    {"foo", "frog"}, {"bar", "10"}
  };
  // try initializing
  param.Init(kwargs); // NOLINT(clang-analyzer-core.UndefinedBinaryOperatorResult)
  ASSERT_EQ(param.foo, Foo::kFrog);
  ASSERT_EQ(param.bar, 10);

  // try all possible enum values
  kwargs["foo"] = "bar";
  param.Init(kwargs);
  ASSERT_EQ(param.foo, Foo::kBar);
  kwargs["foo"] = "frog";
  param.Init(kwargs);
  ASSERT_EQ(param.foo, Foo::kFrog);
  kwargs["foo"] = "cat";
  param.Init(kwargs);
  ASSERT_EQ(param.foo, Foo::kCat);
  kwargs["foo"] = "dog";
  param.Init(kwargs);
  ASSERT_EQ(param.foo, Foo::kDog);

  // try setting non-existent enum value
  kwargs["foo"] = "human";
  ASSERT_THROW(param.Init(kwargs), dmlc::ParamError);
}

struct UpdatableParam : xgboost::XGBoostParameter<UpdatableParam> {
  float f { 0.0f };
  double d { 0.0 };

  DMLC_DECLARE_PARAMETER(UpdatableParam) {
    DMLC_DECLARE_FIELD(f)
        .set_default(11.0f);
    DMLC_DECLARE_FIELD(d)
        .set_default(2.71828f);
  }
};

DMLC_REGISTER_PARAMETER(UpdatableParam);

TEST(XGBoostParameter, Update) {
  {
    UpdatableParam p;
    auto constexpr kRtEps = xgboost::kRtEps;

    p.UpdateAllowUnknown(xgboost::Args{});
    // When it's not initialized, perform set_default.
    ASSERT_NEAR(p.f, 11.0f, kRtEps);
    ASSERT_NEAR(p.d, 2.71828f, kRtEps);

    p.d = 3.14149;

    p.UpdateAllowUnknown(xgboost::Args{{"f", "2.71828"}});
    ASSERT_NEAR(p.f, 2.71828f, kRtEps);

    // p.d is un-effected by the update.
    ASSERT_NEAR(p.d, 3.14149, kRtEps);
  }
  {
    UpdatableParam p;
    auto constexpr kRtEps = xgboost::kRtEps;
    p.UpdateAllowUnknown(xgboost::Args{{"f", "2.71828"}});
    ASSERT_NEAR(p.f, 2.71828f, kRtEps);
    ASSERT_NEAR(p.d, 2.71828, kRtEps);  // default
  }

  // Just in case dmlc's use of global memory has any impact in parameters.
  UpdatableParam a, b;
  a.UpdateAllowUnknown(xgboost::Args{{"f", "2.71828"}});
  ASSERT_NE(a.f, b.f);
}