hyperparameter.rb 10.9 KB
Newer Older
Brice Videau's avatar
Brice Videau committed
1
2
module CCS

Brice Videau's avatar
Brice Videau committed
3
4
5
6
7
8
9
  @hyperparameter_counter = 0
  def self.get_id
    id = @hyperparameter_counter
    @hyperparameter_counter += 1
    id
  end

Brice Videau's avatar
Brice Videau committed
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
  HyperparameterType = enum FFI::Type::INT32, :ccs_hyperparameter_type_t, [
    :CCS_NUMERICAL,
    :CCS_CATEGORICAL,
    :CCS_ORDINAL
  ]
  class MemoryPointer
    def read_ccs_hyperparameter_type_t
      HyperparameterType.from_native(read_int32, nil)
    end
  end

  attach_function :ccs_hyperparameter_get_type, [:ccs_hyperparameter_t, :pointer], :ccs_result_t
  attach_function :ccs_hyperparameter_get_default_value, [:ccs_hyperparameter_t, :pointer], :ccs_result_t
  attach_function :ccs_hyperparameter_get_name, [:ccs_hyperparameter_t, :pointer], :ccs_result_t
  attach_function :ccs_hyperparameter_get_user_data, [:ccs_hyperparameter_t, :pointer], :ccs_result_t
  attach_function :ccs_hyperparameter_get_default_distribution, [:ccs_hyperparameter_t, :pointer], :ccs_result_t
  attach_function :ccs_hyperparameter_check_value, [:ccs_hyperparameter_t, :ccs_datum_t, :pointer], :ccs_result_t
  attach_function :ccs_hyperparameter_check_values, [:ccs_hyperparameter_t, :size_t, :pointer, :pointer], :ccs_result_t
Brice Videau's avatar
Brice Videau committed
28
29
  attach_function :ccs_hyperparameter_sample, [:ccs_hyperparameter_t, :ccs_distribution_t, :ccs_rng_t, :pointer], :ccs_result_t
  attach_function :ccs_hyperparameter_samples, [:ccs_hyperparameter_t, :ccs_distribution_t, :ccs_rng_t, :size_t, :pointer], :ccs_result_t
Brice Videau's avatar
Brice Videau committed
30
31

  class Hyperparameter < Object
Brice Videau's avatar
Brice Videau committed
32
    add_property :type, :ccs_hyperparameter_type_t, :ccs_hyperparameter_get_type, memoize:true
Brice Videau's avatar
Brice Videau committed
33
34
35
36
37
38
39
40
    add_property :user_data, :pointer, :ccs_hyperparameter_get_user_data, memoize: true
    def initialize(handle, retain: false)
      if !handle
        raise StandardError, :CCS_INVALID_OBJECT
      end
      super
    end

Brice Videau's avatar
Brice Videau committed
41
42
43
44
    def self.default_name
      "param#{"%03d"%CCS.get_id}"
    end

Brice Videau's avatar
Brice Videau committed
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
    def self.from_handle(handle)
      ptr = MemoryPointer::new(:ccs_hyperparameter_type_t)
      res = CCS.ccs_hyperparameter_get_type(handle, ptr)
      CCS.error_check(res)
      case ptr.read_ccs_hyperparameter_type_t
      when :CCS_NUMERICAL
        NumericalHyperparameter::new(handle, retain: true)
      when :CCS_CATEGORICAL
        CategoricalHyperparameter::new(handle, retain: true)
      when :CCS_ORDINAL
        OrdinalHyperparameter::new(handle, retain: true)
      else
        raise StandardError, :CCS_INVALID_HYPERPARAMETER
      end
    end

    def name
      @name ||= begin
        ptr = MemoryPointer::new(:pointer)
        res = CCS.ccs_hyperparameter_get_name(@handle, ptr)
        CCS.error_check(res)
        ptr.read_pointer.read_string
      end
    end

    def default_value
      @default_value ||= begin
        ptr = MemoryPointer::new(:ccs_datum_t)
Brice Videau's avatar
Brice Videau committed
73
        res = CCS.ccs_hyperparameter_get_default_value(@handle, ptr)
Brice Videau's avatar
Brice Videau committed
74
75
76
77
78
79
80
81
82
        CCS.error_check(res)
        d = Datum::new(ptr)
        d.value
      end
    end

    def default_distribution
      @default_distribution ||= begin
        ptr = MemoryPointer::new(:ccs_distribution_t)
Brice Videau's avatar
Brice Videau committed
83
        res = CCS.ccs_hyperparameter_get_default_distribution(@handle, ptr)
Brice Videau's avatar
Brice Videau committed
84
85
86
87
        CCS.error_check(res)
        Object::from_handle(ptr.read_pointer)
      end
    end
Brice Videau's avatar
Brice Videau committed
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205

    def check_value(v)
      ptr = MemoryPointer::new(:ccs_bool_t)
      res = CCS.ccs_hyperparameter_check_value(@handle, Datum::from_value(v), ptr)
      CCS.error_check(res)
      ptr.read_ccs_bool_t == CCS::FALSE ? false : true
    end

    def check_values(vals)
      count = vals.size
      return [] if count == 0
      values = MemoryPointer::new(:ccs_datum_t, count)
      vals.each_with_index{ |v, i| Datum::new(values[i]).value = v }
      ptr = MemoryPointer::new(:ccs_bool_t, count)
      res = CCS.ccs_hyperparameter_check_values(@handle, count, values, ptr)
      CCS.error_check(res)
      count.times.collect { |i| ptr[i].read_ccs_bool_t == CCS::FALSE ? false : true }
    end

    def sample(distribution: default_distribution, rng: CCS::DefaultRng)
      value = MemoryPointer::new(:ccs_datum_t)
      res = CCS.ccs_hyperparameter_sample(@handle, distribution, rng, value)
      CCS.error_check(res)
      Datum::new(value).value
    end

    def samples(count, distribution: default_distribution, rng: CCS::DefaultRng)
      return [] if count <= 0
      values = MemoryPointer::new(:ccs_datum_t, count)
      res = CCS.ccs_hyperparameter_samples(@handle, distribution, rng, count, values)
      CCS.error_check(res)
      count.times.collect { |i| Datum::new(values[i]).value }
    end
  end

  attach_function :ccs_create_numerical_hyperparameter, [:string, :ccs_numeric_type_t, :ccs_numeric_t, :ccs_numeric_t, :ccs_numeric_t, :ccs_numeric_t, :pointer, :pointer], :ccs_result_t
  attach_function :ccs_numerical_hyperparameter_get_parameters, [:ccs_hyperparameter_t, :pointer, :pointer, :pointer, :pointer], :ccs_result_t
  class NumericalHyperparameter < Hyperparameter
    def initialize(handle = nil, retain: false, name: Hyperparameter.default_name, data_type: :CCS_NUM_FLOAT, lower: 0.0, upper: 1.0, quantization: 0.0, default: lower, user_data: nil)
      if (handle)
        super(handle, retain: retain)
      else
        ptr = MemoryPointer::new(:ccs_hyperparameter_t)
        case data_type
        when :CCS_NUM_FLOAT
          lower = Numeric::from_value(lower.to_f)
          upper = Numeric::from_value(upper.to_f)
          quantization = Numeric::from_value(quantization.to_f)
          default = Numeric::from_value(default.to_f)
        when :CCS_NUM_INTEGER
          lower = Numeric::from_value(lower.to_i)
          upper = Numeric::from_value(upper.to_i)
          quantization = Numeric::from_value(quantization.to_i)
          default = Numeric::from_value(default.to_i)
        else
          raise StandardError, :CCS_INVALID_TYPE
        end
        res = CCS.ccs_create_numerical_hyperparameter(name, data_type, lower, upper, quantization, default, user_data, ptr)
        CCS.error_check(res)
        super(ptr.read_pointer, retain: false)
      end
    end

    def self.int(name: default_name, lower:, upper:, quantization: 0, default: lower, user_data: nil)
      self.new(nil, name: name, data_type: :CCS_NUM_INTEGER, lower: lower, upper: upper, quantization: quantization, default: default, user_data: user_data)
    end
 
    def self.float(name: default_name, lower:, upper:, quantization: 0.0, default: lower, user_data: nil)
      self.new(nil, name: name, data_type: :CCS_NUM_FLOAT, lower: lower, upper: upper, quantization: quantization, default: default, user_data: user_data)
    end

    def data_type
      @data_type ||= begin
        ptr = MemoryPointer::new(:ccs_numeric_type_t)
        res = CCS.ccs_numerical_hyperparameter_get_parameters(@handle, ptr, nil, nil, nil)
        CCS.error_check(res)
        ptr.read_ccs_numeric_type_t
      end
    end
 
    def lower
      @lower ||= begin
        ptr = MemoryPointer::new(:ccs_numeric_t)
        res = CCS.ccs_numerical_hyperparameter_get_parameters(@handle, nil, ptr, nil, nil)
        CCS.error_check(res)
        if data_type == :CCS_NUM_FLOAT
          ptr.read_ccs_float_t
        else
          ptr.read_ccs_int_t
        end
      end
    end

    def upper
      @upper ||= begin
        ptr = MemoryPointer::new(:ccs_numeric_t)
        res = CCS.ccs_numerical_hyperparameter_get_parameters(@handle, nil, nil, ptr, nil)
        CCS.error_check(res)
        if data_type == :CCS_NUM_FLOAT
          ptr.read_ccs_float_t
        else
          ptr.read_ccs_int_t
        end
      end
    end

    def quantization
      @quantization ||= begin
        ptr = MemoryPointer::new(:ccs_numeric_t)
        res = CCS.ccs_numerical_hyperparameter_get_parameters(@handle, nil, nil, nil, ptr)
        CCS.error_check(res)
        if data_type == :CCS_NUM_FLOAT
          ptr.read_ccs_float_t
        else
          ptr.read_ccs_int_t
        end
      end
    end
Brice Videau's avatar
Brice Videau committed
206
  end
Brice Videau's avatar
Brice Videau committed
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281

  attach_function :ccs_create_categorical_hyperparameter, [:string, :size_t, :pointer, :size_t, :pointer, :pointer],  :ccs_result_t
  attach_function :ccs_categorical_hyperparameter_get_values, [:ccs_hyperparameter_t, :size_t, :pointer, :pointer], :ccs_result_t
  class CategoricalHyperparameter < Hyperparameter
    def initialize(handle = nil, retain: false, name: Hyperparameter.default_name, values: [], default_index: 0, user_data: nil)
      if handle
        super(handle, retain: retain)
      else
        count = values.size
        return [] if count == 0
        vals = MemoryPointer::new(:ccs_datum_t, count)
        values.each_with_index{ |v, i| Datum::new(vals[i]).value = v }
        ptr = MemoryPointer::new(:ccs_hyperparameter_t)
        res = CCS.ccs_create_categorical_hyperparameter(name, count, vals, default_index, user_data, ptr)
        CCS.error_check(res)
        super(ptr.read_ccs_hyperparameter_t, retain: false)
      end
    end

    def values
      @values ||= begin
        ptr = MemoryPointer::new(:size_t)
        res = CCS.ccs_categorical_hyperparameter_get_values(@handle, 0, nil, ptr)
        CCS.error_check(res)
        count = ptr.read_size_t
        ptr = MemoryPointer::new(:ccs_datum_t, count)
        res = CCS.ccs_categorical_hyperparameter_get_values(@handle, count, ptr, nil)
        CCS.error_check(res)
        count.times.collect { |i| Datum::new(ptr[i]).value }
      end
    end
  end

  attach_function :ccs_create_ordinal_hyperparameter, [:string, :size_t, :pointer, :size_t, :pointer, :pointer],  :ccs_result_t
  attach_function :ccs_ordinal_hyperparameter_compare_values, [:ccs_hyperparameter_t, :ccs_datum_t, :ccs_datum_t, :pointer], :ccs_result_t
  attach_function :ccs_ordinal_hyperparameter_get_values, [:ccs_hyperparameter_t, :size_t, :pointer, :pointer], :ccs_result_t
  class OrdinalHyperparameter < Hyperparameter
    def initialize(handle = nil, retain: false, name: Hyperparameter.default_name, values: [], default_index: 0, user_data: nil)
      if handle
        super(handle, retain: retain)
      else
        count = values.size
        return [] if count == 0
        vals = MemoryPointer::new(:ccs_datum_t, count)
        values.each_with_index{ |v, i| Datum::new(vals[i]).value = v }
        ptr = MemoryPointer::new(:ccs_hyperparameter_t)
        res = CCS.ccs_create_ordinal_hyperparameter(name, count, vals, default_index, user_data, ptr)
        CCS.error_check(res)
        super(ptr.read_ccs_hyperparameter_t, retain: false)
      end
    end

    def compare(value1, value2)
      v1 = Datum::from_value(value1)
      v2 = Datum::from_value(value2)
      ptr = MemoryPointer::new(:ccs_int_t)
      res = CCS.ccs_ordinal_hyperparameter_compare_values(@handle, v1, v2, ptr)
      CCS.error_check(res)
      ptr.read_ccs_int_t
    end

    def values
      @values ||= begin
        ptr = MemoryPointer::new(:size_t)
        res = CCS.ccs_ordinal_hyperparameter_get_values(@handle, 0, nil, ptr)
        CCS.error_check(res)
        count = ptr.read_size_t
        ptr = MemoryPointer::new(:ccs_datum_t, count)
        res = CCS.ccs_ordinal_hyperparameter_get_values(@handle, count, ptr, nil)
        CCS.error_check(res)
        count.times.collect { |i| Datum::new(ptr[i]).value }
      end
    end
  end

Brice Videau's avatar
Brice Videau committed
282
end