forked from Hydrospheredata/hydro-visualization
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
436 lines (409 loc) · 10.3 KB
/
openapi.yaml
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
openapi: 3.0.1
info:
title: Hydro-visualization
description: Visualiation service api description
termsOfService: a
contact:
email: apiteam@swagger.io
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 0.1.0
externalDocs:
description: Find out more about Swagger
url: http://swagger.io
servers:
- url: https://localhost/
- url: http://localhost:5000/
tags:
- name: Projection
description: projection requests
- name: Jobs
description: request jobs for background refitting and inference
- name: Params
description: set/get projector parameters
paths:
/visualization/plottable_embeddings/{method}:
post:
tags:
- Projection
summary: creates task to transform data
parameters:
- name: method
in: path
required: true
schema:
type: string
description: Transformer name from ["umap", "trimap","tsne"]. For now only ["umap"].
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestModelID'
description: transformer - manifold learning transformer from ["umap", "trimap",
"tsne"]. For now only ["umap"].
operationId: transform
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/TaskResponse'
400:
description: Wrong request body or method name
content: {}
405:
description: Invalid input
content: {}
404:
description: Model not found
content: {}
500:
description: Couldn't create model/servable
content: {}
/visualization/jobs/{method}:
post:
tags:
- Jobs
summary: Send request to refit embedding model on new data
parameters:
- name: method
in: path
required: true
schema:
type: string
description: Transformer name from ["umap", "trimap","tsne"]. For now only ["umap"].
requestBody:
content:
application/json:
schema:
type: object
properties:
model_version_id:
type: integer
refit_transformer:
type: boolean
default: true
required:
- model_version_id
description: Starts job on inferencing new data or refitting transformer model.
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/TaskResponse'
400:
description: Wrong request body or method name
content: {}
get:
tags:
- Jobs
summary: Get result of fitting transformer from requests jobs/{method} and plottable_embeddings/{method}
parameters:
- name: method
in: path
required: true
schema:
type: string
description: Transformer name from ["umap", "trimap","tsne"]. For now only ["umap"].
- name: task_id
in: query
required: true
schema:
type: string
responses:
200:
description: successfully started task
content:
application/json:
schema:
$ref: '#/components/schemas/TaskResult'
404:
description: Invalid Input
content:
application/json:
schema:
$ref: '#/components/schemas/TaskResult'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/TaskResult'
/visualization/params/{method}:
post:
tags:
- Params
summary: Submit new configuration
parameters:
- name: method
in: path
required: true
schema:
type: string
description: Transformer name from ["umap", "trimap","tsne"]. For now only ["umap"].
- name: model_version_id
in: query
required: true
schema:
type: integer
description: ModelVersion id
description: Submit new configuration
operationId: set_params
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ProjectorParameters'
- type: object
required:
- model_version_id
properties:
model_version_id:
type: integer
required: true
responses:
200:
description: success
content: {}
get:
tags:
- Params
summary: Get current parameters of Projector
parameters:
- name: method
in: path
required: true
schema:
type: string
description: Transformer name from ["umap", "trimap","tsne"]. For now only ["umap"].
- name: model_version_id
in: query
required: true
schema:
type: integer
description: ModelVersion id
operationId: get_params
responses:
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectorParameters'
/visualization/supported:
get:
tags:
- Helper
parameters:
- name: model_version_id
in: query
required: true
schema:
type: integer
description: ModelVersion id
responses:
200:
description: Analyzed model
content:
application/json:
schema:
type: object
properties:
supported:
type: boolean
message:
description: Explanation why not supported, if supported, then empty
type: string
components:
schemas:
TransformerProperties:
type: object
properties:
metric:
type: string
allOf:
- $ref: '#/components/schemas/TransformerPropertiresMetrics'
min_dist:
type: number
n_components:
type: integer
n_neighbours:
type: integer
TransformerPropertiresMetrics:
type: string
enum:
- euclidean
- manhattan
- chebyshev
- minkowski
- canberra
- braycurtis
- haversine
- mahalanobis
- wminkowski
- seuclidean
- cosine
- correlation
- hamming
- jaccard
- dice
- russellrao
- kulsinski
- rogerstanimoto
- sokalmichener
- sokalsneath
- yule
ProjectorParameters:
type: object
properties:
properties:
type: object
allOf:
- $ref: '#/components/schemas/TransformerProperties'
production_data_sample_size:
type: integer
training_data_sample_size:
type: integer
visualization_metrics:
type: array
items:
allOf:
- $ref: '#/components/schemas/VisualizationMetrics'
required:
- properties
TaskStates:
type: string
enum:
- PENDING
- STARTED
- SUCCESS
- NOT_SUPPORTED
- ERROR
- NO_DATA
VisualizationMetrics:
type: string
enum:
- global_score
- sammon_error
- auc_score
- stability_score
- msid
- clustering
OneOutputInfo:
type: object
properties:
coloring_type:
type: string
data:
type: array
items:
anyOf:
- type: number
- type: string
- type: integer
dtype:
type: integer
classes:
anyOf:
- type: number
- type: string
- type: integer
required:
- coloring_type
- data
- dtype
TaskResponse:
type: object
properties:
task_id:
type: string
required:
- task_id
PlottableResult:
type: object
required:
- data_shape
- data
- request_ids
- class_labels
- visualization_metrics
- top_N
- counterfactuals
properties:
data_shape:
type: array
items:
type: integer
data:
type: array
items:
type: object
training_data_shape:
type: array
items:
type: integer
training_data:
type: array
items:
type: object
request_ids:
type: array
items:
type: integer
output_info:
type: object
description: key is output name, value is it's info - values, coloring and dtype
additionalProperties:
$ref: '#/components/schemas/OneOutputInfo'
visualization_metrics:
type: object
properties:
anomality:
type: object
properties:
scores:
type: array
items:
type: number
threshold:
type: number
operation:
type: string
top_N:
type: array
items:
type: array
items:
type: integer
counterfactuals:
type: array
items:
type: array
items:
type: integer
RequestModelID:
type: object
properties:
model_version_id:
type: integer
TaskResult:
type: object
properties:
result:
type: object
$ref: '#/components/schemas/PlottableResult'
state:
type: string
$ref: '#/components/schemas/TaskStates'
task_id:
type: string
message:
type: string
required:
- state
- task_id