forked from tensorflow/tensorboard
-
Notifications
You must be signed in to change notification settings - Fork 0
/
runs_table_container.ts
671 lines (618 loc) · 20.8 KB
/
runs_table_container.ts
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
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
/* Copyright 2020 The TensorFlow Authors. All Rights Reserved.
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.
==============================================================================*/
import {
ChangeDetectionStrategy,
Component,
Input,
OnDestroy,
OnInit,
} from '@angular/core';
import {createSelector, Store} from '@ngrx/store';
import {combineLatest, Observable, of, Subject} from 'rxjs';
import {
distinctUntilChanged,
filter,
map,
shareReplay,
startWith,
switchMap,
take,
takeUntil,
} from 'rxjs/operators';
import * as alertActions from '../../../alert/actions';
import {areSameRouteKindAndExperiments} from '../../../app_routing';
import {State} from '../../../app_state';
import {ExperimentAlias} from '../../../experiments/types';
import {
actions as hparamsActions,
selectors as hparamsSelectors,
} from '../../../hparams';
import {
DiscreteFilter,
DiscreteHparamValue,
DiscreteHparamValues,
DomainType,
IntervalFilter,
} from '../../../hparams/types';
import {
getActiveRoute,
getCurrentRouteRunSelection,
getEnabledColorGroup,
getExperiment,
getExperimentIdToExperimentAliasMap,
getRunColorMap,
getRuns,
getRunSelectorPaginationOption,
getRunSelectorRegexFilter,
getRunSelectorSort,
getRunsLoadState,
} from '../../../selectors';
import {DataLoadState, LoadState} from '../../../types/data';
import {SortDirection} from '../../../types/ui';
import {matchRunToRegex} from '../../../util/matcher';
import {
runColorChanged,
runPageSelectionToggled,
runSelectionToggled,
runSelectorPaginationOptionChanged,
runSelectorRegexFilterChanged,
runSelectorSortChanged,
runTableShown,
singleRunSelected,
} from '../../actions';
import {MAX_NUM_RUNS_TO_ENABLE_BY_DEFAULT} from '../../store/runs_types';
import {SortKey, SortType} from '../../types';
import {
HparamColumn,
IntervalFilterChange,
MetricColumn,
} from './runs_table_component';
import {RunsTableColumn, RunTableItem} from './types';
const getRunsLoading = createSelector<
State,
{experimentId: string},
LoadState,
boolean
>(getRunsLoadState, (loadState) => loadState.state === DataLoadState.LOADING);
function getPropsForSort(
item: RunTableItem,
key: SortKey
): Array<ExperimentAlias | string | number | boolean | undefined> {
switch (key.type) {
case SortType.EXPERIMENT_NAME:
return [item.experimentAlias, item.run.name, item.run.id];
case SortType.RUN_NAME:
return [item.run.name, item.experimentAlias, item.run.id];
case SortType.HPARAM:
return [
item.hparams.get(key.name),
item.run.name,
item.experimentAlias,
item.run.id,
];
case SortType.METRIC:
return [
item.metrics.get(key.tag),
item.run.name,
item.experimentAlias,
item.run.id,
];
default:
const _ = key as never;
throw new Error(`Not yet implemented: ${_}`);
}
}
function sortRunTableItems(
items: RunTableItem[],
sort: {key: SortKey | null; direction: SortDirection}
): RunTableItem[] {
const sortKey = sort.key;
const sortedItems = [...items];
if (sortKey === null || sort.direction === SortDirection.UNSET) {
return sortedItems;
}
sortedItems.sort((a, b) => {
const aProps = getPropsForSort(a, sortKey);
const bProps = getPropsForSort(b, sortKey);
if (aProps.length !== bProps.length) {
throw new Error(
'Invariant error: a given sort should result in same number of ' +
`items: ${sort}`
);
}
for (let index = 0; index < aProps.length; index++) {
const valA = aProps[index];
const valB = bProps[index];
if (valA === valB) {
continue;
}
if (valA === undefined || valB === undefined) {
return valB === undefined ? -1 : 1;
}
if (typeof valA !== typeof valB) {
throw new Error(
`Cannot compare values of different types: ` +
`${typeof valA} vs. ${typeof valB}`
);
}
return valA < valB === (sort.direction === SortDirection.ASC) ? -1 : 1;
}
return 0;
});
return sortedItems;
}
function matchFilter(
filter: DiscreteFilter | IntervalFilter,
value: number | DiscreteHparamValue | undefined
): boolean {
if (value === undefined) {
return filter.includeUndefined;
}
if (filter.type === DomainType.DISCRETE) {
// (upcast to work around bad TypeScript libdefs)
const values: Readonly<Array<typeof filter.filterValues[number]>> =
filter.filterValues;
return values.includes(value);
} else if (filter.type === DomainType.INTERVAL) {
return filter.filterLowerValue <= value && value <= filter.filterUpperValue;
}
return false;
}
/**
* Renders list of experiments.
*
* Note: all @Inputs are read once upon initialization. This component does not
* update when input bindings change.
*/
@Component({
selector: 'runs-table',
template: `
<runs-table-component
[experimentIds]="experimentIds"
[useFlexibleLayout]="useFlexibleLayout"
[numSelectedItems]="numSelectedItems$ | async"
[columns]="columns"
[hparamColumns]="hparamColumns$ | async"
[metricColumns]="metricColumns$ | async"
[showExperimentName]="isExperimentNameVisible()"
[pageItems]="pageItems$ | async"
[filteredItemsLength]="filteredItemsLength$ | async"
[allItemsLength]="allItemsLength$ | async"
[loading]="loading$ | async"
[paginationOption]="paginationOption$ | async"
[regexFilter]="regexFilter$ | async"
[showGroupControl]="showGroupControl$ | async"
[sortOption]="sortOption$ | async"
[usePagination]="usePagination"
(onSelectionToggle)="onRunSelectionToggle($event)"
(onSelectionDblClick)="onRunSelectionDblClick($event)"
(onPageSelectionToggle)="onPageSelectionToggle($event)"
(onPaginationChange)="onPaginationChange($event)"
(onRegexFilterChange)="onRegexFilterChange($event)"
(onSortChange)="onSortChange($event)"
(onRunColorChange)="onRunColorChange($event)"
(onHparamIntervalFilterChanged)="onHparamIntervalFilterChanged($event)"
(onHparamDiscreteFilterChanged)="onHparamDiscreteFilterChanged($event)"
(onMetricFilterChanged)="onMetricFilterChanged($event)"
></runs-table-component>
`,
host: {
'[class.flex-layout]': 'useFlexibleLayout',
},
styles: [
`
:host.flex-layout {
display: flex;
}
:host.flex-layout > runs-table-component {
width: 100%;
}
`,
],
changeDetection: ChangeDetectionStrategy.OnPush,
})
export class RunsTableContainer implements OnInit, OnDestroy {
private allUnsortedRunTableItems$?: Observable<RunTableItem[]>;
loading$: Observable<boolean> | null = null;
filteredItemsLength$?: Observable<number>;
allItemsLength$?: Observable<number>;
pageItems$?: Observable<RunTableItem[]>;
numSelectedItems$?: Observable<number>;
showGroupControl$?: Observable<boolean>;
hparamColumns$: Observable<HparamColumn[]> = of([]);
metricColumns$: Observable<MetricColumn[]> = of([]);
/**
* Enables a layout mode intended for scenarios when changing the # of runs
* should have no effect on the table's size.
*
* - height and width span the container height and width
* - run list scrolls vertically, not horizontally
* - 'name' cells wrap text
*/
@Input() useFlexibleLayout?: boolean = false;
/**
* Whether to use pagination options from the store. If false, the table will
* show a single page with all runs.
*/
@Input() usePagination?: boolean = false;
// Column to disable in the table. The columns are rendered in the order as
// defined by this input.
@Input()
columns: RunsTableColumn[] = [RunsTableColumn.RUN_NAME];
@Input() experimentIds!: string[];
@Input() showHparamsAndMetrics = false;
sortOption$ = this.store.select(getRunSelectorSort);
paginationOption$ = this.store.select(getRunSelectorPaginationOption);
regexFilter$ = this.store.select(getRunSelectorRegexFilter);
private readonly ngUnsubscribe = new Subject<void>();
constructor(private readonly store: Store<State>) {}
isExperimentNameVisible() {
return this.columns.some((column) => {
return column === RunsTableColumn.EXPERIMENT_NAME;
});
}
ngOnInit() {
const getRunTableItemsPerExperiment = this.experimentIds.map((id) =>
this.getRunTableItemsForExperiment(id)
);
const rawAllUnsortedRunTableItems$ = combineLatest(
getRunTableItemsPerExperiment
).pipe(
map((itemsForExperiments: RunTableItem[][]) => {
const items = [] as RunTableItem[];
return items.concat(...itemsForExperiments);
})
);
this.allUnsortedRunTableItems$ = rawAllUnsortedRunTableItems$.pipe(
takeUntil(this.ngUnsubscribe),
shareReplay(1)
);
this.allItemsLength$ = this.allUnsortedRunTableItems$.pipe(
map((items) => items.length)
);
const getFilteredItems$ = this.getFilteredItems$(
this.allUnsortedRunTableItems$
).pipe(takeUntil(this.ngUnsubscribe), shareReplay(1));
this.filteredItemsLength$ = getFilteredItems$.pipe(
map((items) => items.length)
);
this.pageItems$ = this.sortedAndSlicedItems$(getFilteredItems$);
this.numSelectedItems$ = this.allUnsortedRunTableItems$.pipe(
map((items) => {
return items.reduce((count, item) => {
return count + Number(item.selected);
}, 0);
})
);
const getRunsLoadingPerExperiment = this.experimentIds.map((id) => {
return this.store.select(getRunsLoading, {experimentId: id});
});
this.loading$ = combineLatest(getRunsLoadingPerExperiment).pipe(
map((experimentsLoading) => {
return experimentsLoading.some((isLoading) => isLoading);
})
);
if (this.showHparamsAndMetrics) {
const getHparamAndMetrics$ = this.store.select(
hparamsSelectors.getExperimentsHparamsAndMetricsSpecs,
{experimentIds: this.experimentIds}
);
// combineLatest, when initializing, emits twice
this.hparamColumns$ = combineLatest([
this.store.select(
hparamsSelectors.getHparamFilterMap,
this.experimentIds
),
getHparamAndMetrics$,
]).pipe(
map(([filterMap, {hparams}]) => {
return hparams.map(({name, displayName, domain}) => {
const filter = filterMap.get(name);
if (!filter) {
throw new RangeError(
`Invariant error: a filter for ${name} must exist` +
` when the hparam exists`
);
}
return {displayName, name, filter};
});
})
);
this.metricColumns$ = combineLatest([
this.store.select(
hparamsSelectors.getMetricFilterMap,
this.experimentIds
),
getHparamAndMetrics$,
]).pipe(
map(([filterMap, {metrics}]) => {
return metrics.map(({tag, displayName}) => {
const filter = filterMap.get(tag);
if (!filter) {
throw new RangeError(
`Invariant error: a filter for ${tag} must exist ` +
`when the metric exists`
);
}
return {displayName, tag, filter};
});
})
);
}
/**
* For consumers who show checkboxes, notify users that new runs may not be
* selected by default.
*
* Warning: this pattern is not recommended in general. Dispatching
* `alertReported` would be better handled in a Ngrx Reducer in response
* to `fetchRunsSucceeded` or via the declared alert registrations using
* `alertFromAction`. Unfortunately, those currently have no way of knowing
* whether a run table is actually shown (with checkboxes), so we make a
* special exception here. A more 'Ngrx pure' approach would require making
* the store aware of the visibility of any run tables.
*/
if (this.columns.includes(RunsTableColumn.CHECKBOX)) {
const runsExceedLimitForRoute$ = this.store.select(getActiveRoute).pipe(
takeUntil(this.ngUnsubscribe),
distinctUntilChanged((prevRoute, currRoute) => {
// Avoid showing it more than once per route, since it would be
// annoying to see the alert on every auto-reload or when user
// changes tabs.
return areSameRouteKindAndExperiments(prevRoute, currRoute);
}),
switchMap(() => {
return rawAllUnsortedRunTableItems$.pipe(
filter((runTableItems: RunTableItem[]) => {
return runTableItems.length > MAX_NUM_RUNS_TO_ENABLE_BY_DEFAULT;
}),
take(1)
);
})
);
runsExceedLimitForRoute$.subscribe(() => {
const text =
`The number of runs exceeds ` +
`${MAX_NUM_RUNS_TO_ENABLE_BY_DEFAULT}. New runs are unselected ` +
`for performance reasons.`;
this.store.dispatch(
alertActions.alertReported({localizedMessage: text})
);
});
}
this.showGroupControl$ = this.store.select(getEnabledColorGroup).pipe(
map((featureEnabled) => {
return (
featureEnabled && this.columns.includes(RunsTableColumn.RUN_COLOR)
);
})
);
this.store.dispatch(runTableShown({experimentIds: this.experimentIds}));
}
ngOnDestroy() {
this.ngUnsubscribe.next();
this.ngUnsubscribe.complete();
}
private getFilteredItems$(runItems$: Observable<RunTableItem[]>) {
return combineLatest([
runItems$,
this.store.select(getRunSelectorRegexFilter),
]).pipe(
map(([items, regexString]) => {
if (!regexString) {
return items;
}
const shouldIncludeExperimentName = this.columns.includes(
RunsTableColumn.EXPERIMENT_NAME
);
return items.filter((item) => {
return matchRunToRegex(
{
runName: item.run.name,
experimentAlias: item.experimentAlias,
},
regexString,
shouldIncludeExperimentName
);
});
}),
switchMap((items) => {
if (!this.showHparamsAndMetrics) {
return of(items);
}
return combineLatest(
this.store.select(
hparamsSelectors.getHparamFilterMap,
this.experimentIds
),
this.store.select(
hparamsSelectors.getMetricFilterMap,
this.experimentIds
)
).pipe(
map(([hparamFilters, metricFilters]) => {
return items.filter(({hparams, metrics}) => {
const hparamMatches = [...hparamFilters.entries()].every(
([hparamName, filter]) => {
const value = hparams.get(hparamName);
return matchFilter(filter, value);
}
);
return (
hparamMatches &&
[...metricFilters.entries()].every(([metricTag, filter]) => {
const value = metrics.get(metricTag);
return matchFilter(filter, value);
})
);
});
})
);
})
);
}
private sortedAndSlicedItems$(filteredItems$: Observable<RunTableItem[]>) {
const sortedItems = combineLatest([
filteredItems$,
this.store.select(getRunSelectorSort),
]).pipe(
map(([items, sort]) => {
return sortRunTableItems(items, sort);
})
);
const slicedItems = combineLatest([
sortedItems,
this.store.select(getRunSelectorPaginationOption),
]).pipe(
map(([items, paginationOption]) => {
if (!this.usePagination) {
return items.slice();
}
const {pageSize, pageIndex} = paginationOption;
return items.slice(pageIndex * pageSize, (pageIndex + 1) * pageSize);
}),
startWith([])
);
return slicedItems;
}
private getRunTableItemsForExperiment(
experimentId: string
): Observable<RunTableItem[]> {
return combineLatest([
this.store.select(getRuns, {experimentId}),
this.store.select(getExperiment, {experimentId}),
this.store.select(getCurrentRouteRunSelection),
this.store.select(getRunColorMap),
this.store.select(getExperimentIdToExperimentAliasMap),
]).pipe(
map(([runs, experiment, selectionMap, colorMap, experimentIdToAlias]) => {
return runs.map((run) => {
const hparamMap: RunTableItem['hparams'] = new Map();
(run.hparams || []).forEach((hparam) => {
hparamMap.set(hparam.name, hparam.value);
});
const metricMap: RunTableItem['metrics'] = new Map();
(run.metrics || []).forEach((metric) => {
metricMap.set(metric.tag, metric.value);
});
return {
run,
experimentName: experiment?.name || '',
experimentAlias: experimentIdToAlias[experimentId],
selected: Boolean(selectionMap && selectionMap.get(run.id)),
runColor: colorMap[run.id],
hparams: hparamMap,
metrics: metricMap,
};
});
})
);
}
onRunSelectionToggle(item: RunTableItem) {
this.store.dispatch(
runSelectionToggled({
runId: item.run.id,
})
);
}
onRunSelectionDblClick(item: RunTableItem) {
// Note that a user's double click will trigger both 'change' and 'dblclick'
// events so onRunSelectionToggle() will also be called and we will fire
// two somewhat conflicting actions: runSelectionToggled and
// singleRunSelected. This is ok as long as singleRunSelected is fired last.
//
// We are therefore relying on the mat-checkbox 'change' event consistently
// being fired before the 'dblclick' event. Although we don't have any
// documentation that guarantees this order, we do have documentation that
// states that 'click' is guaranteed to occur before 'dblclick'
// (see https://www.quirksmode.org/dom/events/click.html). We presume, then,
// that we can rely on the 'change' event being fired before the 'dblclick'
// event.
this.store.dispatch(
singleRunSelected({
runId: item.run.id,
})
);
}
// When `usePagination` is false, page selection affects the single page,
// containing all items.
onPageSelectionToggle(event: {items: RunTableItem[]}) {
const {items} = event;
const runIds = items.map(({run}) => run.id);
this.store.dispatch(
runPageSelectionToggled({
runIds,
})
);
}
onPaginationChange(event: {pageIndex: number; pageSize: number}) {
if (!this.usePagination) {
throw new Error(
'Pagination events cannot be dispatched when pagination is disabled'
);
}
const {pageIndex, pageSize} = event;
this.store.dispatch(
runSelectorPaginationOptionChanged({pageIndex, pageSize})
);
}
onSortChange(sort: {key: SortKey; direction: SortDirection}) {
this.store.dispatch(runSelectorSortChanged(sort));
}
onRegexFilterChange(regexString: string) {
this.store.dispatch(runSelectorRegexFilterChanged({regexString}));
}
onRunColorChange({runId, newColor}: {runId: string; newColor: string}) {
this.store.dispatch(runColorChanged({runId, newColor}));
}
onHparamDiscreteFilterChanged(event: {
hparamName: string;
includeUndefined: boolean;
filterValues: DiscreteHparamValues;
}) {
const {hparamName, filterValues, includeUndefined} = event;
this.store.dispatch(
hparamsActions.hparamsDiscreteHparamFilterChanged({
experimentIds: this.experimentIds,
hparamName,
filterValues,
includeUndefined,
})
);
}
onHparamIntervalFilterChanged(event: IntervalFilterChange) {
const {name, filterLowerValue, filterUpperValue, includeUndefined} = event;
this.store.dispatch(
hparamsActions.hparamsIntervalHparamFilterChanged({
experimentIds: this.experimentIds,
hparamName: name,
filterLowerValue,
filterUpperValue,
includeUndefined,
})
);
}
onMetricFilterChanged(event: IntervalFilterChange) {
const {name, includeUndefined, filterLowerValue, filterUpperValue} = event;
this.store.dispatch(
hparamsActions.hparamsMetricFilterChanged({
experimentIds: this.experimentIds,
metricTag: name,
includeUndefined,
filterLowerValue,
filterUpperValue,
})
);
}
}
export const TEST_ONLY = {
getRunsLoading,
};