|
1
|
6
|
from __future__ import absolute_import, division, unicode_literals
|
|
2
|
|
|
|
3
|
6
|
import os
|
|
4
|
6
|
import sys
|
|
5
|
6
|
import traceback as tb
|
|
6
|
|
|
|
7
|
6
|
from collections import OrderedDict, defaultdict
|
|
8
|
|
|
|
9
|
6
|
import param
|
|
10
|
|
|
|
11
|
6
|
from .layout import Row, Column, HSpacer, VSpacer
|
|
12
|
6
|
from .pane import HoloViews, Pane, Markdown
|
|
13
|
6
|
from .widgets import Button, Select
|
|
14
|
6
|
from .param import Param
|
|
15
|
6
|
from .util import param_reprs
|
|
16
|
|
|
|
17
|
|
|
|
18
|
6
|
class PipelineError(RuntimeError):
|
|
19
|
|
"""
|
|
20
|
|
Custom error type which can be raised to display custom error
|
|
21
|
|
message in a Pipeline.
|
|
22
|
|
"""
|
|
23
|
|
|
|
24
|
|
|
|
25
|
6
|
def traverse(graph, v, visited):
|
|
26
|
|
"""
|
|
27
|
|
Traverse the graph from a node and mark visited vertices.
|
|
28
|
|
"""
|
|
29
|
6
|
visited[v] = True
|
|
30
|
|
# Recur for all the vertices adjacent to this vertex
|
|
31
|
6
|
for i in graph.get(v, []):
|
|
32
|
6
|
if visited[i] == False:
|
|
33
|
6
|
traverse(graph, i, visited)
|
|
34
|
|
|
|
35
|
|
|
|
36
|
6
|
def find_route(graph, current, target):
|
|
37
|
|
"""
|
|
38
|
|
Find a route to the target node from the current node.
|
|
39
|
|
"""
|
|
40
|
6
|
next_nodes = graph.get(current)
|
|
41
|
6
|
if next_nodes is None:
|
|
42
|
6
|
return None
|
|
43
|
6
|
elif target in next_nodes:
|
|
44
|
6
|
return [target]
|
|
45
|
|
else:
|
|
46
|
6
|
for n in next_nodes:
|
|
47
|
6
|
route = find_route(graph, n, target)
|
|
48
|
6
|
if route is None:
|
|
49
|
6
|
continue
|
|
50
|
6
|
return [n]+route
|
|
51
|
6
|
return None
|
|
52
|
|
|
|
53
|
|
|
|
54
|
6
|
def get_root(graph):
|
|
55
|
|
"""
|
|
56
|
|
Search for the root node by finding nodes without inputs.
|
|
57
|
|
"""
|
|
58
|
|
# Find root node
|
|
59
|
6
|
roots = []
|
|
60
|
6
|
targets = [t for ts in graph.values() for t in ts]
|
|
61
|
6
|
for src in graph:
|
|
62
|
6
|
if src not in targets:
|
|
63
|
6
|
roots.append(src)
|
|
64
|
|
|
|
65
|
6
|
if len(roots) > 1:
|
|
66
|
0
|
raise ValueError("Graph has more than one node with no "
|
|
67
|
|
"incoming edges. Ensure that the graph "
|
|
68
|
|
"only has a single source node.")
|
|
69
|
6
|
elif len(roots) == 0:
|
|
70
|
0
|
raise ValueError("Graph has no source node. Ensure that the "
|
|
71
|
|
"graph is not cyclic and has a single "
|
|
72
|
|
"starting point.")
|
|
73
|
6
|
return roots[0]
|
|
74
|
|
|
|
75
|
|
|
|
76
|
6
|
def is_traversable(root, graph, stages):
|
|
77
|
|
"""
|
|
78
|
|
Check if the graph is fully traversable from the root node.
|
|
79
|
|
"""
|
|
80
|
|
# Ensure graph is traverable from root
|
|
81
|
6
|
int_graph = {stages.index(s): tuple(stages.index(t) for t in tgts)
|
|
82
|
|
for s, tgts in graph.items()}
|
|
83
|
6
|
visited = [False]*len(stages)
|
|
84
|
6
|
traverse(int_graph, stages.index(root), visited)
|
|
85
|
6
|
return all(visited)
|
|
86
|
|
|
|
87
|
|
|
|
88
|
6
|
def get_depth(node, graph, depth=0):
|
|
89
|
6
|
depths = []
|
|
90
|
6
|
for sub in graph.get(node, []):
|
|
91
|
6
|
depths.append(get_depth(sub, graph, depth+1))
|
|
92
|
6
|
return max(depths) if depths else depth+1
|
|
93
|
|
|
|
94
|
|
|
|
95
|
6
|
def get_breadths(node, graph, depth=0, breadths=None):
|
|
96
|
6
|
if breadths is None:
|
|
97
|
6
|
breadths = defaultdict(list)
|
|
98
|
6
|
breadths[depth].append(node)
|
|
99
|
6
|
for sub in graph.get(node, []):
|
|
100
|
6
|
if sub not in breadths[depth+1]:
|
|
101
|
6
|
breadths[depth+1].append(sub)
|
|
102
|
6
|
get_breadths(sub, graph, depth+1, breadths)
|
|
103
|
6
|
return breadths
|
|
104
|
|
|
|
105
|
|
|
|
106
|
|
|
|
107
|
6
|
class Pipeline(param.Parameterized):
|
|
108
|
|
"""
|
|
109
|
|
A Pipeline represents a directed graph of stages, which each
|
|
110
|
|
return a panel object to render. A pipeline therefore represents
|
|
111
|
|
a UI workflow of multiple linear or branching stages.
|
|
112
|
|
|
|
113
|
|
The Pipeline layout consists of a number of sub-components:
|
|
114
|
|
|
|
115
|
|
* header:
|
|
116
|
|
|
|
117
|
|
* title: The name of the current stage.
|
|
118
|
|
* error: A field to display the error state.
|
|
119
|
|
* network: A network diagram representing the pipeline.
|
|
120
|
|
* buttons: All navigation buttons and selectors.
|
|
121
|
|
* prev_button: The button to go to the previous stage.
|
|
122
|
|
* prev_selector: The selector widget to select between
|
|
123
|
|
previous branching stages.
|
|
124
|
|
* next_button: The button to go to the previous stage
|
|
125
|
|
* next_selector: The selector widget to select the next
|
|
126
|
|
branching stages.
|
|
127
|
|
|
|
128
|
|
* stage: The contents of the current pipeline stage.
|
|
129
|
|
|
|
130
|
|
By default any outputs of one stage annotated with the
|
|
131
|
|
param.output decorator are fed into the next stage. Additionally,
|
|
132
|
|
if the inherit_params parameter is set any parameters which are
|
|
133
|
|
declared on both the previous and next stage are also inherited.
|
|
134
|
|
|
|
135
|
|
The stages are declared using the add_stage method and must each
|
|
136
|
|
be given a unique name. By default any stages will simply be
|
|
137
|
|
connected linearly, but an explicit graph can be declared using
|
|
138
|
|
the define_graph method.
|
|
139
|
|
"""
|
|
140
|
|
|
|
141
|
6
|
auto_advance = param.Boolean(default=False, doc="""
|
|
142
|
|
Whether to automatically advance if the ready parameter is True.""")
|
|
143
|
|
|
|
144
|
6
|
debug = param.Boolean(default=False, doc="""
|
|
145
|
|
Whether to raise errors, useful for debugging while building
|
|
146
|
|
an application.""")
|
|
147
|
|
|
|
148
|
6
|
inherit_params = param.Boolean(default=True, doc="""
|
|
149
|
|
Whether parameters should be inherited between pipeline
|
|
150
|
|
stages.""")
|
|
151
|
|
|
|
152
|
6
|
next_parameter = param.String(default=None, doc="""
|
|
153
|
|
Parameter name to watch to switch between different branching
|
|
154
|
|
stages""")
|
|
155
|
|
|
|
156
|
6
|
ready_parameter = param.String(default=None, doc="""
|
|
157
|
|
Parameter name to watch to check whether a stage is ready.""")
|
|
158
|
|
|
|
159
|
6
|
show_header = param.Boolean(default=True, doc="""
|
|
160
|
|
Whether to show the header with the title, network diagram,
|
|
161
|
|
and buttons.""")
|
|
162
|
|
|
|
163
|
6
|
next = param.Action(default=lambda x: x.param.trigger('next'))
|
|
164
|
|
|
|
165
|
6
|
previous = param.Action(default=lambda x: x.param.trigger('previous'))
|
|
166
|
|
|
|
167
|
6
|
def __init__(self, stages=[], graph={}, **params):
|
|
168
|
6
|
try:
|
|
169
|
6
|
import holoviews as hv
|
|
170
|
0
|
except Exception:
|
|
171
|
0
|
raise ImportError('Pipeline requires holoviews to be installed')
|
|
172
|
|
|
|
173
|
6
|
super(Pipeline, self).__init__(**params)
|
|
174
|
|
|
|
175
|
|
# Initialize internal state
|
|
176
|
6
|
self._stage = None
|
|
177
|
6
|
self._stages = OrderedDict()
|
|
178
|
6
|
self._states = {}
|
|
179
|
6
|
self._state = None
|
|
180
|
6
|
self._linear = True
|
|
181
|
6
|
self._block = False
|
|
182
|
6
|
self._error = None
|
|
183
|
6
|
self._graph = {}
|
|
184
|
6
|
self._route = []
|
|
185
|
|
|
|
186
|
|
# Declare UI components
|
|
187
|
6
|
self._progress_sel = hv.streams.Selection1D()
|
|
188
|
6
|
self._progress_sel.add_subscriber(self._set_stage)
|
|
189
|
6
|
self.prev_button = Param(self.param.previous).layout[0]
|
|
190
|
6
|
self.prev_button.width = 125
|
|
191
|
6
|
self.prev_selector = Select(width=125)
|
|
192
|
6
|
self.next_button = Param(self.param.next).layout[0]
|
|
193
|
6
|
self.next_button.width = 125
|
|
194
|
6
|
self.next_selector = Select(width=125)
|
|
195
|
6
|
self.prev_button.disabled = True
|
|
196
|
6
|
self.next_selector.param.watch(self._update_progress, 'value')
|
|
197
|
6
|
self.network = HoloViews(backend='bokeh')
|
|
198
|
6
|
self.title = Markdown('# Header', margin=(0, 0, 0, 5))
|
|
199
|
6
|
self.error = Row(width=100)
|
|
200
|
6
|
self.buttons = Row(self.prev_button, self.next_button)
|
|
201
|
6
|
self.header = Row(
|
|
202
|
|
Column(self.title, self.error),
|
|
203
|
|
self.network,
|
|
204
|
|
self.buttons,
|
|
205
|
|
sizing_mode='stretch_width'
|
|
206
|
|
)
|
|
207
|
6
|
self.network.object = self._make_progress()
|
|
208
|
6
|
spinner = Pane(os.path.join(os.path.dirname(__file__), 'assets', 'spinner.gif'))
|
|
209
|
6
|
self._spinner_layout = Row(
|
|
210
|
|
HSpacer(),
|
|
211
|
|
Column(VSpacer(), spinner, VSpacer()),
|
|
212
|
|
HSpacer()
|
|
213
|
|
)
|
|
214
|
6
|
self.stage = Row()
|
|
215
|
6
|
self.layout = Column(self.header, self.stage, sizing_mode='stretch_width')
|
|
216
|
|
|
|
217
|
|
# Initialize stages and the graph
|
|
218
|
6
|
for stage in stages:
|
|
219
|
6
|
kwargs = {}
|
|
220
|
6
|
if len(stage) == 2:
|
|
221
|
6
|
name, stage = stage
|
|
222
|
0
|
elif len(stage) == 3:
|
|
223
|
0
|
name, stage, kwargs = stage
|
|
224
|
6
|
self.add_stage(name, stage, **kwargs)
|
|
225
|
6
|
self.define_graph(graph)
|
|
226
|
|
|
|
227
|
6
|
def _validate(self, stage):
|
|
228
|
6
|
if any(stage is s for n, (s, kw) in self._stages.items()):
|
|
229
|
6
|
raise ValueError('Stage %s is already in pipeline' % stage)
|
|
230
|
6
|
elif not ((isinstance(stage, type) and issubclass(stage, param.Parameterized))
|
|
231
|
|
or isinstance(stage, param.Parameterized)):
|
|
232
|
6
|
raise ValueError('Pipeline stages must be Parameterized classes or instances.')
|
|
233
|
|
|
|
234
|
6
|
def __repr__(self):
|
|
235
|
6
|
repr_str = 'Pipeline:'
|
|
236
|
6
|
for i, (name, (stage, _)) in enumerate(self._stages.items()):
|
|
237
|
6
|
if isinstance(stage, param.Parameterized):
|
|
238
|
0
|
cls_name = type(stage).__name__
|
|
239
|
|
else:
|
|
240
|
6
|
cls_name = stage.__name__
|
|
241
|
6
|
params = ', '.join(param_reprs(stage))
|
|
242
|
6
|
repr_str += '\n [%d] %s: %s(%s)' % (i, name, cls_name, params)
|
|
243
|
6
|
return repr_str
|
|
244
|
|
|
|
245
|
6
|
def __str__(self):
|
|
246
|
0
|
return self.__repr__()
|
|
247
|
|
|
|
248
|
6
|
def __getitem__(self, index):
|
|
249
|
6
|
return self._stages[index][0]
|
|
250
|
|
|
|
251
|
6
|
def _unblock(self, event):
|
|
252
|
6
|
if self._state is not event.obj or self._block:
|
|
253
|
0
|
self._block = False
|
|
254
|
0
|
return
|
|
255
|
|
|
|
256
|
6
|
button = self.next_button
|
|
257
|
6
|
if button.disabled and event.new:
|
|
258
|
6
|
button.disabled = False
|
|
259
|
0
|
elif not button.disabled and not event.new:
|
|
260
|
0
|
button.disabled = True
|
|
261
|
|
|
|
262
|
6
|
stage_kwargs = self._stages[self._stage][-1]
|
|
263
|
6
|
if event.new and stage_kwargs.get('auto_advance', self.auto_advance):
|
|
264
|
6
|
self._next()
|
|
265
|
|
|
|
266
|
6
|
def _select_next(self, event):
|
|
267
|
6
|
if self._state is not event.obj:
|
|
268
|
0
|
return
|
|
269
|
6
|
self.next_selector.value = event.new
|
|
270
|
6
|
self._update_progress()
|
|
271
|
|
|
|
272
|
6
|
def _init_stage(self):
|
|
273
|
6
|
stage, stage_kwargs = self._stages[self._stage]
|
|
274
|
|
|
|
275
|
6
|
previous = []
|
|
276
|
6
|
for src, tgts in self._graph.items():
|
|
277
|
6
|
if self._stage in tgts:
|
|
278
|
6
|
previous.append(src)
|
|
279
|
6
|
prev_states = [self._states[prev] for prev in previous if prev in self._states]
|
|
280
|
|
|
|
281
|
6
|
outputs = []
|
|
282
|
6
|
kwargs, results = {}, {}
|
|
283
|
6
|
for state in prev_states:
|
|
284
|
6
|
for name, (_, method, index) in state.param.outputs().items():
|
|
285
|
6
|
if name not in stage.param:
|
|
286
|
0
|
continue
|
|
287
|
6
|
if method not in results:
|
|
288
|
6
|
results[method] = method()
|
|
289
|
6
|
result = results[method]
|
|
290
|
6
|
if index is not None:
|
|
291
|
0
|
result = result[index]
|
|
292
|
6
|
kwargs[name] = result
|
|
293
|
6
|
outputs.append(name)
|
|
294
|
6
|
if stage_kwargs.get('inherit_params', self.inherit_params):
|
|
295
|
6
|
ignored = [stage_kwargs.get(p) or getattr(self, p, None)
|
|
296
|
|
for p in ('ready_parameter', 'next_parameter')]
|
|
297
|
6
|
params = [k for k, v in state.param.objects('existing').items()
|
|
298
|
|
if k not in ignored]
|
|
299
|
6
|
kwargs.update({k: v for k, v in state.param.get_param_values()
|
|
300
|
|
if k in stage.param and k != 'name' and k in params})
|
|
301
|
|
|
|
302
|
6
|
if isinstance(stage, param.Parameterized):
|
|
303
|
6
|
stage.param.set_param(**kwargs)
|
|
304
|
6
|
self._state = stage
|
|
305
|
|
else:
|
|
306
|
6
|
self._state = stage(**kwargs)
|
|
307
|
|
|
|
308
|
|
# Hide widgets for parameters that are supplied by the previous stage
|
|
309
|
6
|
for output in outputs:
|
|
310
|
6
|
self._state.param[output].precedence = -1
|
|
311
|
|
|
|
312
|
6
|
ready_param = stage_kwargs.get('ready_parameter', self.ready_parameter)
|
|
313
|
6
|
if ready_param and ready_param in stage.param:
|
|
314
|
6
|
self._state.param.watch(self._unblock, ready_param, onlychanged=False)
|
|
315
|
|
|
|
316
|
6
|
next_param = stage_kwargs.get('next_parameter', self.next_parameter)
|
|
317
|
6
|
if next_param and next_param in stage.param:
|
|
318
|
6
|
self._state.param.watch(self._select_next, next_param, onlychanged=False)
|
|
319
|
|
|
|
320
|
6
|
self._states[self._stage] = self._state
|
|
321
|
6
|
return self._state.panel()
|
|
322
|
|
|
|
323
|
6
|
def _set_stage(self, index):
|
|
324
|
6
|
if not index:
|
|
325
|
0
|
return
|
|
326
|
6
|
stage = self._progress_sel.source.iloc[index[0], 2]
|
|
327
|
6
|
if stage in self.next_selector.options:
|
|
328
|
6
|
self.next_selector.value = stage
|
|
329
|
6
|
self.param.trigger('next')
|
|
330
|
6
|
elif stage in self.prev_selector.options:
|
|
331
|
6
|
self.prev_selector.value = stage
|
|
332
|
6
|
self.param.trigger('previous')
|
|
333
|
6
|
elif stage in self._route:
|
|
334
|
0
|
while len(self._route) > 1:
|
|
335
|
0
|
self.param.trigger('previous')
|
|
336
|
|
else:
|
|
337
|
|
# Try currently selected route
|
|
338
|
6
|
route = find_route(self._graph, self._next_stage, stage)
|
|
339
|
6
|
if route is None:
|
|
340
|
|
# Try alternate route
|
|
341
|
6
|
route = find_route(self._graph, self._stage, stage)
|
|
342
|
6
|
if route is None:
|
|
343
|
0
|
raise ValueError('Could not find route to target node.')
|
|
344
|
|
else:
|
|
345
|
0
|
route = [self._next_stage] + route
|
|
346
|
6
|
for r in route:
|
|
347
|
6
|
if r not in self.next_selector.options:
|
|
348
|
0
|
break
|
|
349
|
6
|
self.next_selector.value = r
|
|
350
|
6
|
self.param.trigger('next')
|
|
351
|
|
|
|
352
|
|
|
|
353
|
6
|
@property
|
|
354
|
1
|
def _next_stage(self):
|
|
355
|
6
|
return self.next_selector.value
|
|
356
|
|
|
|
357
|
6
|
@property
|
|
358
|
1
|
def _prev_stage(self):
|
|
359
|
6
|
return self.prev_selector.value
|
|
360
|
|
|
|
361
|
6
|
def _update_button(self):
|
|
362
|
6
|
stage, kwargs = self._stages[self._stage]
|
|
363
|
6
|
options = list(self._graph.get(self._stage, []))
|
|
364
|
6
|
next_param = kwargs.get('next_parameter', self.next_parameter)
|
|
365
|
6
|
option = getattr(self._state, next_param) if next_param and next_param in stage.param else None
|
|
366
|
6
|
if option is None:
|
|
367
|
6
|
option = options[0] if options else None
|
|
368
|
6
|
self.next_selector.options = options
|
|
369
|
6
|
self.next_selector.value = option
|
|
370
|
6
|
self.next_selector.disabled = not bool(options)
|
|
371
|
6
|
previous = []
|
|
372
|
6
|
for src, tgts in self._graph.items():
|
|
373
|
6
|
if self._stage in tgts:
|
|
374
|
6
|
previous.append(src)
|
|
375
|
6
|
self.prev_selector.options = previous
|
|
376
|
6
|
self.prev_selector.value = self._route[-1] if previous else None
|
|
377
|
6
|
self.prev_selector.disabled = not bool(previous)
|
|
378
|
|
|
|
379
|
|
# Disable previous button
|
|
380
|
6
|
if self._prev_stage is None:
|
|
381
|
6
|
self.prev_button.disabled = True
|
|
382
|
|
else:
|
|
383
|
6
|
self.prev_button.disabled = False
|
|
384
|
|
|
|
385
|
|
# Disable next button
|
|
386
|
6
|
if self._next_stage is None:
|
|
387
|
6
|
self.next_button.disabled = True
|
|
388
|
|
else:
|
|
389
|
6
|
ready = kwargs.get('ready_parameter', self.ready_parameter)
|
|
390
|
6
|
disabled = (not getattr(stage, ready)) if ready in stage.param else False
|
|
391
|
6
|
self.next_button.disabled = disabled
|
|
392
|
|
|
|
393
|
6
|
def _get_error_button(self, e):
|
|
394
|
6
|
msg = str(e) if isinstance(e, PipelineError) else ""
|
|
395
|
6
|
if self.debug:
|
|
396
|
0
|
type, value, trb = sys.exc_info()
|
|
397
|
0
|
tb_list = tb.format_tb(trb, None) + tb.format_exception_only(type, value)
|
|
398
|
0
|
traceback = (("%s\n\nTraceback (innermost last):\n" + "%-20s %s") %
|
|
399
|
|
(msg, ''.join(tb_list[-5:-1]), tb_list[-1]))
|
|
400
|
|
else:
|
|
401
|
6
|
traceback = msg or "Undefined error, enable debug mode."
|
|
402
|
6
|
button = Button(name='Error', button_type='danger', width=100,
|
|
403
|
|
align='center', margin=(0, 0, 0, 5))
|
|
404
|
6
|
button.js_on_click(code="alert(`{tb}`)".format(tb=traceback))
|
|
405
|
6
|
return button
|
|
406
|
|
|
|
407
|
6
|
@param.depends('next', watch=True)
|
|
408
|
1
|
def _next(self):
|
|
409
|
6
|
prev_state, prev_stage = self._state, self._stage
|
|
410
|
6
|
self._stage = self._next_stage
|
|
411
|
6
|
self.stage[0] = self._spinner_layout
|
|
412
|
6
|
try:
|
|
413
|
6
|
self.stage[0] = self._init_stage()
|
|
414
|
6
|
except Exception as e:
|
|
415
|
6
|
self._error = self._stage
|
|
416
|
6
|
self._stage = prev_stage
|
|
417
|
6
|
self._state = prev_state
|
|
418
|
6
|
self.stage[0] = prev_state.panel()
|
|
419
|
6
|
self.error[:] = [self._get_error_button(e)]
|
|
420
|
6
|
if self.debug:
|
|
421
|
0
|
raise e
|
|
422
|
6
|
return e
|
|
423
|
|
else:
|
|
424
|
6
|
self.error[:] = []
|
|
425
|
6
|
self._error = None
|
|
426
|
6
|
self._update_button()
|
|
427
|
6
|
self._route.append(self._stage)
|
|
428
|
6
|
stage_kwargs = self._stages[self._stage][-1]
|
|
429
|
6
|
ready_param = stage_kwargs.get('ready_parameter', self.ready_parameter)
|
|
430
|
6
|
if (ready_param and getattr(self._state, ready_param, False) and
|
|
431
|
|
stage_kwargs.get('auto_advance', self.auto_advance)):
|
|
432
|
0
|
self._next()
|
|
433
|
|
finally:
|
|
434
|
6
|
self._update_progress()
|
|
435
|
|
|
|
436
|
6
|
@param.depends('previous', watch=True)
|
|
437
|
1
|
def _previous(self):
|
|
438
|
6
|
prev_state, prev_stage = self._state, self._stage
|
|
439
|
6
|
self._stage = self._prev_stage
|
|
440
|
6
|
try:
|
|
441
|
6
|
if self._stage in self._states:
|
|
442
|
6
|
self._state = self._states[self._stage]
|
|
443
|
6
|
self.stage[0] = self._state.panel()
|
|
444
|
|
else:
|
|
445
|
0
|
self.stage[0] = self._init_stage()
|
|
446
|
6
|
self._block = True
|
|
447
|
0
|
except Exception as e:
|
|
448
|
0
|
self.error[:] = [self._get_error_button(e)]
|
|
449
|
0
|
self._error = self._stage
|
|
450
|
0
|
self._stage = prev_stage
|
|
451
|
0
|
self._state = prev_state
|
|
452
|
0
|
if self.debug:
|
|
453
|
0
|
raise e
|
|
454
|
|
else:
|
|
455
|
6
|
self.error[:] = []
|
|
456
|
6
|
self._error = None
|
|
457
|
6
|
self._update_button()
|
|
458
|
6
|
self._route.pop()
|
|
459
|
|
finally:
|
|
460
|
6
|
self._update_progress()
|
|
461
|
|
|
|
462
|
6
|
def _update_progress(self, *args):
|
|
463
|
6
|
self.title.object = '## Stage: ' + self._stage
|
|
464
|
6
|
self.network.object = self._make_progress()
|
|
465
|
|
|
|
466
|
6
|
def _make_progress(self):
|
|
467
|
6
|
import holoviews as hv
|
|
468
|
6
|
import holoviews.plotting.bokeh # noqa
|
|
469
|
|
|
|
470
|
6
|
if self._graph:
|
|
471
|
6
|
root = get_root(self._graph)
|
|
472
|
6
|
depth = get_depth(root, self._graph)
|
|
473
|
6
|
breadths = get_breadths(root, self._graph)
|
|
474
|
6
|
max_breadth = max(len(v) for v in breadths.values())
|
|
475
|
|
else:
|
|
476
|
6
|
root = None
|
|
477
|
6
|
max_breadth, depth = 0, 0
|
|
478
|
6
|
breadths = {}
|
|
479
|
|
|
|
480
|
6
|
height = 80 + (max_breadth-1) * 20
|
|
481
|
|
|
|
482
|
6
|
edges = []
|
|
483
|
6
|
for src, tgts in self._graph.items():
|
|
484
|
6
|
for t in tgts:
|
|
485
|
6
|
edges.append((src, t))
|
|
486
|
|
|
|
487
|
6
|
nodes = []
|
|
488
|
6
|
for depth, subnodes in breadths.items():
|
|
489
|
6
|
breadth = len(subnodes)
|
|
490
|
6
|
step = 1./breadth
|
|
491
|
6
|
for i, n in enumerate(subnodes[::-1]):
|
|
492
|
6
|
if n == self._stage:
|
|
493
|
6
|
state = 'active'
|
|
494
|
6
|
elif n == self._error:
|
|
495
|
6
|
state = 'error'
|
|
496
|
6
|
elif n == self._next_stage:
|
|
497
|
6
|
state = 'next'
|
|
498
|
|
else:
|
|
499
|
6
|
state = 'inactive'
|
|
500
|
6
|
nodes.append((depth, step/2.+i*step, n, state))
|
|
501
|
|
|
|
502
|
6
|
cmap = {'inactive': 'white', 'active': '#5cb85c', 'error': 'red',
|
|
503
|
|
'next': 'yellow'}
|
|
504
|
|
|
|
505
|
6
|
def tap_renderer(plot, element):
|
|
506
|
0
|
from bokeh.models import TapTool
|
|
507
|
0
|
gr = plot.handles['glyph_renderer']
|
|
508
|
0
|
tap = plot.state.select_one(TapTool)
|
|
509
|
0
|
tap.renderers = [gr]
|
|
510
|
|
|
|
511
|
6
|
nodes = hv.Nodes(nodes, ['x', 'y', 'Stage'], 'State').opts(
|
|
512
|
|
alpha=0, default_tools=['tap'], hooks=[tap_renderer],
|
|
513
|
|
hover_alpha=0, selection_alpha=0, nonselection_alpha=0,
|
|
514
|
|
axiswise=True, size=10, backend='bokeh'
|
|
515
|
|
)
|
|
516
|
6
|
self._progress_sel.source = nodes
|
|
517
|
6
|
graph = hv.Graph((edges, nodes)).opts(
|
|
518
|
|
edge_hover_line_color='black', node_color='State', cmap=cmap,
|
|
519
|
|
tools=[], default_tools=['hover'], selection_policy=None,
|
|
520
|
|
node_hover_fill_color='gray', axiswise=True, backend='bokeh')
|
|
521
|
6
|
labels = hv.Labels(nodes, ['x', 'y'], 'Stage').opts(
|
|
522
|
|
yoffset=-.30, default_tools=[], axiswise=True, backend='bokeh'
|
|
523
|
|
)
|
|
524
|
6
|
plot = (graph * labels * nodes) if self._linear else (graph * nodes)
|
|
525
|
6
|
plot.opts(
|
|
526
|
|
xaxis=None, yaxis=None, min_width=400, responsive=True,
|
|
527
|
|
show_frame=False, height=height, xlim=(-0.25, depth+0.25),
|
|
528
|
|
ylim=(0, 1), default_tools=['hover'], toolbar=None, backend='bokeh'
|
|
529
|
|
)
|
|
530
|
6
|
return plot
|
|
531
|
|
|
|
532
|
6
|
def _repr_mimebundle_(self, include=None, exclude=None):
|
|
533
|
0
|
return self.layout._repr_mimebundle_(include, exclude)
|
|
534
|
|
|
|
535
|
|
#----------------------------------------------------------------
|
|
536
|
|
# Public API
|
|
537
|
|
#----------------------------------------------------------------
|
|
538
|
|
|
|
539
|
6
|
def add_stage(self, name, stage, **kwargs):
|
|
540
|
|
"""
|
|
541
|
|
Adds a new, named stage to the Pipeline.
|
|
542
|
|
|
|
543
|
|
Arguments
|
|
544
|
|
---------
|
|
545
|
|
name: str
|
|
546
|
|
A string name for the Pipeline stage
|
|
547
|
|
stage: param.Parameterized
|
|
548
|
|
A Parameterized object which represents the Pipeline stage.
|
|
549
|
|
**kwargs: dict
|
|
550
|
|
Additional arguments declaring the behavior of the stage.
|
|
551
|
|
"""
|
|
552
|
6
|
self._validate(stage)
|
|
553
|
6
|
for k in kwargs:
|
|
554
|
6
|
if k not in self.param:
|
|
555
|
0
|
raise ValueError("Keyword argument %s is not a valid parameter. " % k)
|
|
556
|
|
|
|
557
|
6
|
if not self._linear and self._graph:
|
|
558
|
0
|
raise RuntimeError("Cannot add stage after graph has been defined.")
|
|
559
|
|
|
|
560
|
6
|
self._stages[name] = (stage, kwargs)
|
|
561
|
6
|
if len(self._stages) == 1:
|
|
562
|
6
|
self._stage = name
|
|
563
|
6
|
self._route = [name]
|
|
564
|
6
|
self._graph = {}
|
|
565
|
6
|
self.stage[:] = [self._init_stage()]
|
|
566
|
|
else:
|
|
567
|
6
|
previous = [s for s in self._stages if s not in self._graph][0]
|
|
568
|
6
|
self._graph[previous] = (name,)
|
|
569
|
6
|
self._update_progress()
|
|
570
|
6
|
self._update_button()
|
|
571
|
|
|
|
572
|
6
|
def define_graph(self, graph, force=False):
|
|
573
|
|
"""
|
|
574
|
|
Declares a custom graph structure for the Pipeline overriding
|
|
575
|
|
the default linear flow. The graph should be defined as an
|
|
576
|
|
adjacency mapping.
|
|
577
|
|
|
|
578
|
|
Arguments
|
|
579
|
|
---------
|
|
580
|
|
graph: dict
|
|
581
|
|
Dictionary declaring the relationship between different
|
|
582
|
|
pipeline stages. Should map from a single stage name to
|
|
583
|
|
one or more stage names.
|
|
584
|
|
"""
|
|
585
|
6
|
stages = list(self._stages)
|
|
586
|
6
|
if not stages:
|
|
587
|
6
|
self._graph = {}
|
|
588
|
6
|
return
|
|
589
|
|
|
|
590
|
6
|
graph = {k: v if isinstance(v, tuple) else (v,) for k, v in graph.items()}
|
|
591
|
|
|
|
592
|
6
|
not_found = []
|
|
593
|
6
|
for source, targets in graph.items():
|
|
594
|
6
|
if source not in stages:
|
|
595
|
0
|
not_found.append(source)
|
|
596
|
6
|
not_found += [t for t in targets if t not in stages]
|
|
597
|
6
|
if not_found:
|
|
598
|
6
|
raise ValueError(
|
|
599
|
|
'Pipeline stage(s) %s not found, ensure all stages '
|
|
600
|
|
'referenced in the graph have been added.' %
|
|
601
|
|
(not_found[0] if len(not_found) == 1 else not_found)
|
|
602
|
|
)
|
|
603
|
|
|
|
604
|
6
|
if graph:
|
|
605
|
6
|
if not (self._linear or force):
|
|
606
|
0
|
raise ValueError("Graph has already been defined, "
|
|
607
|
|
"cannot override existing graph.")
|
|
608
|
6
|
self._linear = False
|
|
609
|
|
else:
|
|
610
|
6
|
graph = {s: (t,) for s, t in zip(stages[:-1], stages[1:])}
|
|
611
|
|
|
|
612
|
6
|
root = get_root(graph)
|
|
613
|
6
|
if not is_traversable(root, graph, stages):
|
|
614
|
0
|
raise ValueError('Graph is not fully traversable from stage: %s.'
|
|
615
|
|
% root)
|
|
616
|
|
|
|
617
|
6
|
reinit = root is not self._stage
|
|
618
|
6
|
self._stage = root
|
|
619
|
6
|
self._graph = graph
|
|
620
|
6
|
self._route = [root]
|
|
621
|
6
|
if not self._linear:
|
|
622
|
6
|
self.buttons[:] = [
|
|
623
|
|
Column(self.prev_selector, self.prev_button),
|
|
624
|
|
Column(self.next_selector, self.next_button)
|
|
625
|
|
]
|
|
626
|
6
|
if reinit:
|
|
627
|
6
|
self.stage[:] = [self._init_stage()]
|
|
628
|
6
|
self._update_progress()
|
|
629
|
6
|
self._update_button()
|
MarcSkovMadsen