-
Notifications
You must be signed in to change notification settings - Fork 5
/
_schemas.py
430 lines (321 loc) · 13.1 KB
/
_schemas.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
# Copyright 2018-2020 Faculty Science Limited
#
# 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.
from marshmallow import fields, post_load, pre_dump, ValidationError
from marshmallow_enum import EnumField
from faculty._oneofschema import OneOfSchema
from faculty.clients.base import BaseSchema
from faculty.clients.experiment._models import (
ComparisonOperator,
DeleteExperimentRunsResponse,
Experiment,
ExperimentRun,
ExperimentRunStatus,
ListExperimentRunsResponse,
LogicalOperator,
Metric,
MetricDataPoint,
MetricHistory,
Page,
Pagination,
Param,
RestoreExperimentRunsResponse,
SortOrder,
Tag,
)
class _OptionalField(fields.Field):
"""Wrap another field, passing through Nones."""
def __init__(self, nested, *args, **kwargs):
self.nested = nested
super(_OptionalField, self).__init__(*args, **kwargs)
def _deserialize(self, value, *args, **kwargs):
if value is None:
return None
else:
return self.nested._deserialize(value, *args, **kwargs)
def _serialize(self, value, *args, **kwargs):
if value is None:
return None
else:
return self.nested._serialize(value, *args, **kwargs)
class _OneOfSchemaWithoutType(OneOfSchema):
def dump(self, *args, **kwargs):
data = super(_OneOfSchemaWithoutType, self).dump(*args, **kwargs)
# Remove the type field added by marshmallow-oneofschema
return {k: v for k, v in data.items() if k != "type"}
class PageSchema(BaseSchema):
start = fields.Integer(required=True)
limit = fields.Integer(required=True)
@post_load
def make_page(self, data):
return Page(**data)
class PaginationSchema(BaseSchema):
start = fields.Integer(required=True)
size = fields.Integer(required=True)
previous = fields.Nested(PageSchema, missing=None)
next = fields.Nested(PageSchema, missing=None)
@post_load
def make_pagination(self, data):
return Pagination(**data)
class MetricSchema(BaseSchema):
key = fields.String(required=True)
value = fields.Float(required=True)
timestamp = fields.DateTime(required=True)
step = fields.Integer(required=True)
@post_load
def make_metric(self, data):
return Metric(**data)
class ParamSchema(BaseSchema):
key = fields.String(required=True)
value = fields.String(required=True)
@post_load
def make_param(self, data):
return Param(**data)
class TagSchema(BaseSchema):
key = fields.String(required=True)
value = fields.String(required=True)
@post_load
def make_tag(self, data):
return Tag(**data)
class ExperimentSchema(BaseSchema):
id = fields.Integer(data_key="experimentId", required=True)
name = fields.String(required=True)
description = fields.String(required=True)
artifact_location = fields.String(
data_key="artifactLocation", required=True
)
created_at = fields.DateTime(data_key="createdAt", required=True)
last_updated_at = fields.DateTime(data_key="lastUpdatedAt", required=True)
deleted_at = fields.DateTime(data_key="deletedAt", missing=None)
@post_load
def make_experiment(self, data):
return Experiment(**data)
class ExperimentRunSchema(BaseSchema):
id = fields.UUID(data_key="runId", required=True)
run_number = fields.Integer(data_key="runNumber", required=True)
experiment_id = fields.Integer(data_key="experimentId", required=True)
name = fields.String(required=True)
parent_run_id = fields.UUID(data_key="parentRunId", missing=None)
artifact_location = fields.String(
data_key="artifactLocation", required=True
)
status = EnumField(ExperimentRunStatus, by_value=True, required=True)
started_at = fields.DateTime(data_key="startedAt", required=True)
ended_at = fields.DateTime(data_key="endedAt", missing=None)
deleted_at = fields.DateTime(data_key="deletedAt", missing=None)
tags = fields.Nested(TagSchema, many=True, required=True)
params = fields.Nested(ParamSchema, many=True, required=True)
metrics = fields.Nested(MetricSchema, many=True, required=True)
@post_load
def make_experiment_run(self, data):
return ExperimentRun(**data)
# Schemas for payloads sent to API:
class ExperimentRunDataSchema(BaseSchema):
metrics = fields.List(fields.Nested(MetricSchema))
params = fields.List(fields.Nested(ParamSchema))
tags = fields.List(fields.Nested(TagSchema))
class ExperimentRunInfoSchema(BaseSchema):
status = EnumField(ExperimentRunStatus, by_value=True, required=True)
ended_at = fields.DateTime(data_key="endedAt", missing=None)
class ListExperimentRunsResponseSchema(BaseSchema):
pagination = fields.Nested(PaginationSchema, required=True)
runs = fields.Nested(ExperimentRunSchema, many=True, required=True)
@post_load
def make_list_runs_response_schema(self, data):
return ListExperimentRunsResponse(**data)
class CreateRunSchema(BaseSchema):
name = fields.String()
parent_run_id = fields.UUID(data_key="parentRunId")
started_at = fields.DateTime(data_key="startedAt")
artifact_location = fields.String(data_key="artifactLocation")
tags = fields.Nested(TagSchema, many=True, required=True)
class _ParamFilterValueField(fields.Field):
"""Field that passes through strings or numbers."""
default_error_messages = {
"unsupported_type": "Param values must be of type str, int or float."
}
def _serialize(self, value, attr, obj, **kwargs):
if isinstance(value, str):
field = fields.String()
elif isinstance(value, int) or isinstance(value, float):
field = fields.Number()
else:
self.fail("unsupported_type")
return field._serialize(value, attr, obj, **kwargs)
class _FilterValueField(fields.Field):
def __init__(self, other_field_type, *args, **kwargs):
self.other_field_type = other_field_type
super(_FilterValueField, self).__init__(*args, **kwargs)
def _serialize(self, value, attr, obj, **kwargs):
if obj.operator == ComparisonOperator.DEFINED:
field = fields.Boolean()
else:
field = self.other_field_type
return field._serialize(value, attr, obj, **kwargs)
def _validate_discrete(operator):
if operator not in {
ComparisonOperator.DEFINED,
ComparisonOperator.EQUAL_TO,
ComparisonOperator.NOT_EQUAL_TO,
}:
raise ValidationError({"operator": "Not a discrete operator."})
class _ProjectIdFilterSchema(BaseSchema):
operator = EnumField(ComparisonOperator, by_value=True)
value = _FilterValueField(fields.UUID())
by = fields.Constant("projectId", dump_only=True)
@pre_dump
def check_operator(self, obj):
_validate_discrete(obj.operator)
return obj
class _ExperimentIdFilterSchema(BaseSchema):
operator = EnumField(ComparisonOperator, by_value=True)
value = _FilterValueField(fields.Integer())
by = fields.Constant("experimentId", dump_only=True)
@pre_dump
def check_operator(self, obj):
_validate_discrete(obj.operator)
return obj
class _RunIdFilterSchema(BaseSchema):
operator = EnumField(ComparisonOperator, by_value=True)
value = _FilterValueField(fields.UUID())
by = fields.Constant("runId", dump_only=True)
@pre_dump
def check_operator(self, obj):
_validate_discrete(obj.operator)
return obj
class _RunStatusFilterSchema(BaseSchema):
operator = EnumField(ComparisonOperator, by_value=True)
value = _FilterValueField(EnumField(ExperimentRunStatus, by_value=True))
by = fields.Constant("status", dump_only=True)
@pre_dump
def check_operator(self, obj):
_validate_discrete(obj.operator)
return obj
class _DeletedAtFilterSchema(BaseSchema):
operator = EnumField(ComparisonOperator, by_value=True)
value = _FilterValueField(fields.DateTime())
by = fields.Constant("deletedAt", dump_only=True)
class _TagFilterSchema(BaseSchema):
key = fields.String()
operator = EnumField(ComparisonOperator, by_value=True)
value = _FilterValueField(fields.String())
by = fields.Constant("tag", dump_only=True)
@pre_dump
def check_operator(self, obj):
_validate_discrete(obj.operator)
return obj
class _ParamFilterSchema(BaseSchema):
key = fields.String()
operator = EnumField(ComparisonOperator, by_value=True)
value = _FilterValueField(_ParamFilterValueField())
by = fields.Constant("param", dump_only=True)
@pre_dump
def check_operator(self, obj):
if isinstance(obj.value, str):
_validate_discrete(obj.operator)
return obj
class _MetricFilterSchema(BaseSchema):
key = fields.String()
operator = EnumField(ComparisonOperator, by_value=True)
value = _FilterValueField(fields.Float())
by = fields.Constant("metric", dump_only=True)
class _CompoundFilterSchema(BaseSchema):
operator = EnumField(LogicalOperator, by_value=True)
conditions = fields.List(fields.Nested("FilterSchema"))
class FilterSchema(_OneOfSchemaWithoutType):
type_schemas = {
"ProjectIdFilter": _ProjectIdFilterSchema,
"ExperimentIdFilter": _ExperimentIdFilterSchema,
"RunIdFilter": _RunIdFilterSchema,
"RunStatusFilter": _RunStatusFilterSchema,
"DeletedAtFilter": _DeletedAtFilterSchema,
"TagFilter": _TagFilterSchema,
"ParamFilter": _ParamFilterSchema,
"MetricFilter": _MetricFilterSchema,
"CompoundFilter": _CompoundFilterSchema,
}
class _StartedAtSortSchema(BaseSchema):
order = EnumField(SortOrder, by_value=True)
by = fields.Constant("startedAt", dump_only=True)
class _RunNumberSortSchema(BaseSchema):
order = EnumField(SortOrder, by_value=True)
by = fields.Constant("runNumber", dump_only=True)
class _DurationSortSchema(BaseSchema):
order = EnumField(SortOrder, by_value=True)
by = fields.Constant("duration", dump_only=True)
class _TagSortSchema(BaseSchema):
key = fields.String()
order = EnumField(SortOrder, by_value=True)
by = fields.Constant("tag", dump_only=True)
class _ParamSortSchema(BaseSchema):
key = fields.String()
order = EnumField(SortOrder, by_value=True)
by = fields.Constant("param", dump_only=True)
class _MetricSortSchema(BaseSchema):
key = fields.String()
order = EnumField(SortOrder, by_value=True)
by = fields.Constant("metric", dump_only=True)
class SortSchema(_OneOfSchemaWithoutType):
type_schemas = {
"StartedAtSort": _StartedAtSortSchema,
"RunNumberSort": _RunNumberSortSchema,
"DurationSort": _DurationSortSchema,
"TagSort": _TagSortSchema,
"ParamSort": _ParamSortSchema,
"MetricSort": _MetricSortSchema,
}
class RunQuerySchema(BaseSchema):
filter = _OptionalField(fields.Nested(FilterSchema))
sort = fields.List(fields.Nested(SortSchema))
page = fields.Nested(PageSchema, missing=None)
# Schemas for responses returned from API:
class DeleteExperimentRunsResponseSchema(BaseSchema):
deleted_run_ids = fields.List(
fields.UUID(), data_key="deletedRunIds", required=True
)
conflicted_run_ids = fields.List(
fields.UUID(), data_key="conflictedRunIds", required=True
)
@post_load
def make_delete_runs_response(self, data):
return DeleteExperimentRunsResponse(**data)
class RestoreExperimentRunsResponseSchema(BaseSchema):
restored_run_ids = fields.List(
fields.UUID(), data_key="restoredRunIds", required=True
)
conflicted_run_ids = fields.List(
fields.UUID(), data_key="conflictedRunIds", required=True
)
@post_load
def make_restore_runs_response(self, data):
return RestoreExperimentRunsResponse(**data)
class _MetricDataPointSchema(BaseSchema):
"""Deserialise a data point from the metric history endpoint.
This schema is written with the expectation that it is not used
alongside the metric subsampling feature, which can result in null
timestamp or step, or a non-integer step.
"""
value = fields.Float(required=True)
timestamp = fields.DateTime(required=True)
step = fields.Integer(required=True)
@post_load
def make_metric(self, data):
return MetricDataPoint(**data)
class MetricHistorySchema(BaseSchema):
original_size = fields.Integer(data_key="originalSize", required=True)
subsampled = fields.Boolean(required=True)
key = fields.String(required=True)
history = fields.Nested(_MetricDataPointSchema, many=True, required=True)
@post_load
def make_history(self, data):
return MetricHistory(**data)