-
Notifications
You must be signed in to change notification settings - Fork 94
/
premade.py
597 lines (534 loc) · 22.6 KB
/
premade.py
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
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
206
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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""TF Lattice premade models implement typical monotonic model architectures.
You can use TFL premade models to easily construct commonly used monotonic model
architectures. To construct a TFL premade model, construct a model configuration
from `tfl.configs` and pass it to the premade model constructor. No fields in
the model config will be automatically filled in, so the config must be fully
specified. Note that the inputs to the model should match the order in which
they are defined in the feature configs.
```python
model_config = tfl.configs.CalibratedLatticeConfig(...)
calibrated_lattice_model = tfl.premade.CalibratedLattice(
model_config=model_config)
calibrated_lattice_model.compile(...)
calibrated_lattice_model.fit(...)
```
Supported models are defined in `tfl.configs`. Each model architecture can be
used the same as any other `tf.keras.Model`.
"""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from . import aggregation_layer
from . import categorical_calibration_layer
from . import configs
from . import kronecker_factored_lattice_layer as kfll
from . import lattice_layer
from . import linear_layer
from . import parallel_combination_layer
from . import premade_lib
from . import pwl_calibration_layer
from . import rtl_layer
from absl import logging
import tensorflow as tf
# TODO: add support for serialization and object scoping or annoations.
class CalibratedLatticeEnsemble(tf.keras.Model):
"""Premade model for Tensorflow calibrated lattice ensemble models.
Creates a `tf.keras.Model` for the model architecture specified by the
`model_config`, which should be a
`tfl.configs.CalibratedLatticeEnsembleConfig`. No fields in the model config
will be automatically filled in, so the config must be fully specified. Note
that the inputs to the model should match the order in which they are defined
in the feature configs.
Example:
```python
model_config = tfl.configs.CalibratedLatticeEnsembleConfig(...)
calibrated_lattice_ensemble_model = tfl.premade.CalibratedLatticeEnsemble(
model_config=model_config)
calibrated_lattice_ensemble_model.compile(...)
calibrated_lattice_ensemble_model.fit(...)
```
Attributes:
model_config: Model configuration object describing model architecture.
Should be a `tfl.configs.CalibratedLatticeEnsembleConfig` instance.
"""
def __init__(self, model_config=None, dtype=tf.float32, **kwargs):
"""Initializes a `CalibratedLatticeEnsemble` instance.
Args:
model_config: Model configuration object describing model architecutre.
Should be one of the model configs in `tfl.configs`.
dtype: dtype of layers used in the model.
**kwargs: Any additional `tf.keras.Model` arguments
"""
# Set our model_config
self.model_config = model_config
# Check if we are constructing with already provided inputs/outputs, e.g.
# when we are loading a model.
if 'inputs' in kwargs and 'outputs' in kwargs:
super(CalibratedLatticeEnsemble, self).__init__(**kwargs)
return
if model_config is None:
raise ValueError('Must provide a model_config.')
# Check that proper config has been given.
if not isinstance(model_config, configs.CalibratedLatticeEnsembleConfig):
raise ValueError('Invalid config type: {}'.format(type(model_config)))
# Verify that the config is fully specified.
premade_lib.verify_config(model_config)
# Get feature configs and construct model.
input_layer = premade_lib.build_input_layer(
feature_configs=model_config.feature_configs, dtype=dtype)
lattice_outputs = premade_lib.build_calibrated_lattice_ensemble_layer(
calibration_input_layer=input_layer,
model_config=model_config,
average_outputs=(not model_config.use_linear_combination),
dtype=dtype)
if model_config.use_linear_combination:
averaged_lattice_output = premade_lib.build_linear_combination_layer(
ensemble_outputs=lattice_outputs,
model_config=model_config,
dtype=dtype)
else:
averaged_lattice_output = lattice_outputs
if model_config.output_calibration:
model_output = premade_lib.build_output_calibration_layer(
output_calibration_input=averaged_lattice_output,
model_config=model_config,
dtype=dtype)
else:
model_output = averaged_lattice_output
# Define inputs and initialize model.
inputs = [
input_layer[feature_config.name]
for feature_config in model_config.feature_configs
]
kwargs['inputs'] = inputs
kwargs['outputs'] = model_output
super(CalibratedLatticeEnsemble, self).__init__(**kwargs)
def get_config(self):
"""Returns a configuration dictionary."""
config = super(CalibratedLatticeEnsemble, self).get_config()
config['model_config'] = tf.keras.utils.serialize_keras_object(
self.model_config)
return config
@classmethod
def from_config(cls, config, custom_objects=None):
model = super(CalibratedLatticeEnsemble, cls).from_config(
config, custom_objects=custom_objects)
try:
model_config = tf.keras.utils.deserialize_keras_object(
config.get('model_config'), custom_objects=custom_objects)
premade_lib.verify_config(model_config)
model.model_config = model_config
except ValueError:
logging.warning(
'Could not load model_config. Constructing model without it: %s',
str(config.get('model_config')))
return model
class CalibratedLattice(tf.keras.Model):
"""Premade model for Tensorflow calibrated lattice models.
Creates a `tf.keras.Model` for the model architecture specified by the
`model_config`, which should be a `tfl.configs.CalibratedLatticeConfig`. No
fields in the model config will be automatically filled in, so the config
must be fully specified. Note that the inputs to the model should match the
order in which they are defined in the feature configs.
Example:
```python
model_config = tfl.configs.CalibratedLatticeConfig(...)
calibrated_lattice_model = tfl.premade.CalibratedLattice(
model_config=model_config)
calibrated_lattice_model.compile(...)
calibrated_lattice_model.fit(...)
```
Attributes:
model_config: Model configuration object describing model architecture.
Should be a `tfl.configs.CalibratedLatticeConfig` instance.
"""
def __init__(self, model_config=None, dtype=tf.float32, **kwargs):
"""Initializes a `CalibratedLattice` instance.
Args:
model_config: Model configuration object describing model architecutre.
Should be one of the model configs in `tfl.configs`.
dtype: dtype of layers used in the model.
**kwargs: Any additional `tf.keras.Model` arguments.
"""
# Set our model_config
self.model_config = model_config
# Check if we are constructing with already provided inputs/outputs, e.g.
# when we are loading a model.
if 'inputs' in kwargs and 'outputs' in kwargs:
super(CalibratedLattice, self).__init__(**kwargs)
return
if model_config is None:
raise ValueError('Must provide a model_config.')
# Check that proper config has been given.
if not isinstance(model_config, configs.CalibratedLatticeConfig):
raise ValueError('Invalid config type: {}'.format(type(model_config)))
# Verify that the config is fully specified.
premade_lib.verify_config(model_config)
# Get feature configs and construct model.
input_layer = premade_lib.build_input_layer(
feature_configs=model_config.feature_configs, dtype=dtype)
submodels_inputs = premade_lib.build_calibration_layers(
calibration_input_layer=input_layer,
model_config=model_config,
layer_output_range=premade_lib.LayerOutputRange.INPUT_TO_LATTICE,
submodels=[[
feature_config.name
for feature_config in model_config.feature_configs
]],
separate_calibrators=False,
dtype=dtype)
lattice_layer_output_range = (
premade_lib.LayerOutputRange.INPUT_TO_FINAL_CALIBRATION
if model_config.output_calibration else
premade_lib.LayerOutputRange.MODEL_OUTPUT)
lattice_output = premade_lib.build_lattice_layer(
lattice_input=submodels_inputs[0],
feature_configs=model_config.feature_configs,
model_config=model_config,
layer_output_range=lattice_layer_output_range,
submodel_index=0,
is_inside_ensemble=False,
dtype=dtype)
if model_config.output_calibration:
model_output = premade_lib.build_output_calibration_layer(
output_calibration_input=lattice_output,
model_config=model_config,
dtype=dtype)
else:
model_output = lattice_output
# Define inputs and initialize model.
inputs = [
input_layer[feature_config.name]
for feature_config in model_config.feature_configs
]
kwargs['inputs'] = inputs
kwargs['outputs'] = model_output
super(CalibratedLattice, self).__init__(**kwargs)
def get_config(self):
"""Returns a configuration dictionary."""
config = super(CalibratedLattice, self).get_config()
config['model_config'] = tf.keras.utils.serialize_keras_object(
self.model_config)
return config
@classmethod
def from_config(cls, config, custom_objects=None):
model = super(CalibratedLattice, cls).from_config(
config, custom_objects=custom_objects)
try:
model_config = tf.keras.utils.deserialize_keras_object(
config.get('model_config'), custom_objects=custom_objects)
premade_lib.verify_config(model_config)
model.model_config = model_config
except ValueError:
logging.warning(
'Could not load model_config. Constructing model without it: %s',
str(config.get('model_config')))
return model
class CalibratedLinear(tf.keras.Model):
"""Premade model for Tensorflow calibrated linear models.
Creates a `tf.keras.Model` for the model architecture specified by the
`model_config`, which should be a `tfl.configs.CalibratedLinearConfig`. No
fields in the model config will be automatically filled in, so the config
must be fully specified. Note that the inputs to the model should match the
order in which they are defined in the feature configs.
Example:
```python
model_config = tfl.configs.CalibratedLinearConfig(...)
calibrated_linear_model = tfl.premade.CalibratedLinear(
model_config=model_config)
calibrated_linear_model.compile(...)
calibrated_linear_model.fit(...)
```
Attributes:
model_config: Model configuration object describing model architecture.
Should be a `tfl.configs.CalibratedLinearConfig` instance.
"""
def __init__(self, model_config=None, dtype=tf.float32, **kwargs):
"""Initializes a `CalibratedLinear` instance.
Args:
model_config: Model configuration object describing model architecutre.
Should be one of the model configs in `tfl.configs`.
dtype: dtype of layers used in the model.
**kwargs: Any additional `tf.keras.Model` arguments.
"""
# Set our model_config
self.model_config = model_config
# Check if we are constructing with already provided inputs/outputs, e.g.
# when we are loading a model.
if 'inputs' in kwargs and 'outputs' in kwargs:
super(CalibratedLinear, self).__init__(**kwargs)
return
if model_config is None:
raise ValueError('Must provide a model_config.')
# Check that proper config has been given.
if not isinstance(model_config, configs.CalibratedLinearConfig):
raise ValueError('Invalid config type: {}'.format(type(model_config)))
# Verify that the config is fully specified.
premade_lib.verify_config(model_config)
# Get feature configs and construct model.
input_layer = premade_lib.build_input_layer(
feature_configs=model_config.feature_configs, dtype=dtype)
calibration_layer_output_range = (
premade_lib.LayerOutputRange.INPUT_TO_FINAL_CALIBRATION
if model_config.output_calibration else
premade_lib.LayerOutputRange.MODEL_OUTPUT)
submodels_inputs = premade_lib.build_calibration_layers(
calibration_input_layer=input_layer,
model_config=model_config,
layer_output_range=calibration_layer_output_range,
submodels=[[
feature_config.name
for feature_config in model_config.feature_configs
]],
separate_calibrators=False,
dtype=dtype)
weighted_average = (
model_config.output_min is not None or
model_config.output_max is not None or model_config.output_calibration)
linear_output = premade_lib.build_linear_layer(
linear_input=submodels_inputs[0],
feature_configs=model_config.feature_configs,
model_config=model_config,
weighted_average=weighted_average,
submodel_index=0,
dtype=dtype)
if model_config.output_calibration:
model_output = premade_lib.build_output_calibration_layer(
output_calibration_input=linear_output,
model_config=model_config,
dtype=dtype)
else:
model_output = linear_output
# Define inputs and initialize model.
inputs = [
input_layer[feature_config.name]
for feature_config in model_config.feature_configs
]
kwargs['inputs'] = inputs
kwargs['outputs'] = model_output
super(CalibratedLinear, self).__init__(**kwargs)
def get_config(self):
"""Returns a configuration dictionary."""
config = super(CalibratedLinear, self).get_config()
config['model_config'] = tf.keras.utils.serialize_keras_object(
self.model_config)
return config
@classmethod
def from_config(cls, config, custom_objects=None):
model = super(CalibratedLinear, cls).from_config(
config, custom_objects=custom_objects)
try:
model_config = tf.keras.utils.deserialize_keras_object(
config.get('model_config'), custom_objects=custom_objects)
premade_lib.verify_config(model_config)
model.model_config = model_config
except ValueError:
logging.warning(
'Could not load model_config. Constructing model without it: %s',
str(config.get('model_config')))
return model
# TODO: add support for tf.map_fn and inputs of shape (B, ?, input_dim)
# as well as non-ragged inputs using padding/mask.
class AggregateFunction(tf.keras.Model):
"""Premade model for Tensorflow aggregate function learning models.
Creates a `tf.keras.Model` for the model architecture specified by the
`model_config`, which should be a
`tfl.configs.AggregateFunctionConfig`. No
fields in the model config will be automatically filled in, so the config
must be fully specified. Note that the inputs to the model should match the
order in which they are defined in the feature configs. Features will be
considered ragged, so inputs to this model must be `tf.ragged` instances.
Example:
```python
model_config = tfl.configs.AggregateFunctionConfig(...)
agg_model = tfl.premade.AggregateFunction(
model_config=model_config)
agg_model.compile(...)
agg_model.fit(...)
```
"""
def __init__(self, model_config=None, dtype=tf.float32, **kwargs):
"""Initializes an `AggregateFunction` instance.
Args:
model_config: Model configuration object describing model architecutre.
Should be a `tfl.configs.AggregateFunctionConfig` instance.
dtype: dtype of layers used in the model.
**kwargs: Any additional `tf.keras.Model` arguments.
"""
# Set our model_config
self.model_config = model_config
# Check if we are constructing with already provided inputs/outputs, e.g.
# when we are loading a model.
if 'inputs' in kwargs and 'outputs' in kwargs:
super(AggregateFunction, self).__init__(**kwargs)
return
if model_config is None:
raise ValueError('Must provide a model_config.')
# Check that proper config has been given.
if not isinstance(model_config, configs.AggregateFunctionConfig):
raise ValueError('Invalid config type: {}'.format(type(model_config)))
# Verify that the config is fully specified.
premade_lib.verify_config(model_config)
# Get feature configs and construct model.
input_layer = premade_lib.build_input_layer(
feature_configs=model_config.feature_configs, dtype=dtype, ragged=True)
# We need to construct middle_dimension calibrated_lattices for the
# aggregation layer. Note that we cannot do this in premade_lib because
# importing premade in premade_lib would cause a dependency cycle. Also
# note that we only need to set the output initialization to the min and
# max since we are not using output calibration at this step of the
# aggregation.
calibrated_lattice_config = configs.CalibratedLatticeConfig(
feature_configs=model_config.feature_configs,
interpolation=model_config.aggregation_lattice_interpolation,
regularizer_configs=model_config.regularizer_configs,
output_min=-1.0,
output_max=1.0,
output_initialization=[-1.0, 1.0])
calibrated_lattice_models = [
CalibratedLattice(calibrated_lattice_config)
for _ in range(model_config.middle_dimension)
]
aggregation_layer_output_range = (
premade_lib.LayerOutputRange.INPUT_TO_FINAL_CALIBRATION
if model_config.output_calibration else
premade_lib.LayerOutputRange.MODEL_OUTPUT)
# Change input layer into a list based on model_config.feature_configs.
# This is the order of inputs expected by calibrated_lattice_models.
inputs = [
input_layer[feature_config.name]
for feature_config in model_config.feature_configs
]
aggregation_output = premade_lib.build_aggregation_layer(
aggregation_input_layer=inputs,
model_config=model_config,
calibrated_lattice_models=calibrated_lattice_models,
layer_output_range=aggregation_layer_output_range,
submodel_index=0,
dtype=dtype)
if model_config.output_calibration:
model_output = premade_lib.build_output_calibration_layer(
output_calibration_input=aggregation_output,
model_config=model_config,
dtype=dtype)
else:
model_output = aggregation_output
# Define inputs and initialize model.
kwargs['inputs'] = inputs
kwargs['outputs'] = model_output
super(AggregateFunction, self).__init__(**kwargs)
def get_config(self):
"""Returns a configuration dictionary."""
config = super(AggregateFunction, self).get_config()
config['model_config'] = tf.keras.utils.serialize_keras_object(
self.model_config)
return config
@classmethod
def from_config(cls, config, custom_objects=None):
model = super(AggregateFunction, cls).from_config(
config, custom_objects=custom_objects)
try:
model_config = tf.keras.utils.deserialize_keras_object(
config.get('model_config'), custom_objects=custom_objects)
premade_lib.verify_config(model_config)
model.model_config = model_config
except ValueError:
logging.warning(
'Could not load model_config. Constructing model without it: %s',
str(config.get('model_config')))
return model
def get_custom_objects(custom_objects=None):
"""Creates and returns a dictionary mapping names to custom objects.
Args:
custom_objects: Optional dictionary mapping names (strings) to custom
classes or functions to be considered during deserialization. If provided,
the returned mapping will be extended to contain this one.
Returns:
A dictionary mapping names (strings) to tensorflow lattice custom objects.
"""
tfl_custom_objects = {
'AggregateFunction':
AggregateFunction,
'AggregateFunctionConfig':
configs.AggregateFunctionConfig,
'Aggregation':
aggregation_layer.Aggregation,
'BiasInitializer':
kfll.BiasInitializer,
'CalibratedLatticeEnsemble':
CalibratedLatticeEnsemble,
'CalibratedLattice':
CalibratedLattice,
'CalibratedLatticeConfig':
configs.CalibratedLatticeConfig,
'CalibratedLatticeEnsembleConfig':
configs.CalibratedLatticeEnsembleConfig,
'CalibratedLinear':
CalibratedLinear,
'CalibratedLinearConfig':
configs.CalibratedLinearConfig,
'CategoricalCalibration':
categorical_calibration_layer.CategoricalCalibration,
'CategoricalCalibrationConstraints':
categorical_calibration_layer.CategoricalCalibrationConstraints,
'DominanceConfig':
configs.DominanceConfig,
'FeatureConfig':
configs.FeatureConfig,
'KFLRandomMonotonicInitializer':
kfll.KFLRandomMonotonicInitializer,
'KroneckerFactoredLattice':
kfll.KroneckerFactoredLattice,
'KroneckerFactoredLatticeConstraints':
kfll.KroneckerFactoredLatticeConstraints,
'LaplacianRegularizer':
lattice_layer.LaplacianRegularizer,
'Lattice':
lattice_layer.Lattice,
'LatticeConstraints':
lattice_layer.LatticeConstraints,
'Linear':
linear_layer.Linear,
'LinearConstraints':
linear_layer.LinearConstraints,
'LinearInitializer':
lattice_layer.LinearInitializer,
'NaiveBoundsConstraints':
pwl_calibration_layer.NaiveBoundsConstraints,
'ParallelCombination':
parallel_combination_layer.ParallelCombination,
'PWLCalibration':
pwl_calibration_layer.PWLCalibration,
'PWLCalibrationConstraints':
pwl_calibration_layer.PWLCalibrationConstraints,
'RandomMonotonicInitializer':
lattice_layer.RandomMonotonicInitializer,
'RegularizerConfig':
configs.RegularizerConfig,
'RTL':
rtl_layer.RTL,
'ScaleConstraints':
kfll.ScaleConstraints,
'ScaleInitializer':
kfll.ScaleInitializer,
'TorsionRegularizer':
lattice_layer.TorsionRegularizer,
'TrustConfig':
configs.TrustConfig,
}
if custom_objects is not None:
tfl_custom_objects.update(custom_objects)
return tfl_custom_objects