diff --git a/tensorboard/webapp/metrics/internal_types.ts b/tensorboard/webapp/metrics/internal_types.ts
index f8e65711ae..6057028220 100644
--- a/tensorboard/webapp/metrics/internal_types.ts
+++ b/tensorboard/webapp/metrics/internal_types.ts
@@ -30,8 +30,9 @@ export enum PluginType {
export enum XAxisType {
STEP = 'step',
- RELATIVE = 'relative',
+ RELATIVE_STEP = 'relative_step',
WALL_TIME = 'walltime',
+ RELATIVE_TIME = 'relative_time',
}
export interface CardMetadata {
diff --git a/tensorboard/webapp/metrics/views/card_renderer/histogram_card_component.ts b/tensorboard/webapp/metrics/views/card_renderer/histogram_card_component.ts
index 5e9944e939..3c211c286e 100644
--- a/tensorboard/webapp/metrics/views/card_renderer/histogram_card_component.ts
+++ b/tensorboard/webapp/metrics/views/card_renderer/histogram_card_component.ts
@@ -63,10 +63,12 @@ export class HistogramCardComponent {
switch (xAxisType) {
case XAxisType.STEP:
return TimeProperty.STEP;
+ case XAxisType.RELATIVE_STEP:
+ return TimeProperty.RELATIVE_STEP;
case XAxisType.WALL_TIME:
return TimeProperty.WALL_TIME;
- case XAxisType.RELATIVE:
- return TimeProperty.RELATIVE;
+ case XAxisType.RELATIVE_TIME:
+ return TimeProperty.RELATIVE_TIME;
default:
throw new Error('Invalid xAxisType for histogram time property.');
}
diff --git a/tensorboard/webapp/metrics/views/card_renderer/histogram_card_test.ts b/tensorboard/webapp/metrics/views/card_renderer/histogram_card_test.ts
index 89db48768f..5f12f3f8dd 100644
--- a/tensorboard/webapp/metrics/views/card_renderer/histogram_card_test.ts
+++ b/tensorboard/webapp/metrics/views/card_renderer/histogram_card_test.ts
@@ -277,6 +277,30 @@ describe('histogram card', () => {
expect(histogramEl.componentInstance.timeProperty).toBe(
TimeProperty.WALL_TIME
);
+
+ store.overrideSelector(
+ selectors.getMetricsXAxisType,
+ XAxisType.RELATIVE_STEP
+ );
+ store.refreshState();
+
+ fixture.detectChanges();
+
+ expect(histogramEl.componentInstance.timeProperty).toBe(
+ TimeProperty.RELATIVE_STEP
+ );
+
+ store.overrideSelector(
+ selectors.getMetricsXAxisType,
+ XAxisType.RELATIVE_TIME
+ );
+ store.refreshState();
+
+ fixture.detectChanges();
+
+ expect(histogramEl.componentInstance.timeProperty).toBe(
+ TimeProperty.RELATIVE_TIME
+ );
});
describe('full size', () => {
diff --git a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_component.ng.html b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_component.ng.html
index 3b980b6278..1f0785a81e 100644
--- a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_component.ng.html
+++ b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_component.ng.html
@@ -138,7 +138,7 @@
Run |
Smoothed |
Value |
- Step |
+ {{ getStepTooltipHeader() }} |
Time |
Relative |
@@ -168,7 +168,7 @@
{{ valueFormatter.formatShort(datum.dataPoint.value) }} |
- {{ stepFormatter.formatShort(datum.dataPoint.step) }} |
+ {{ getStepTooltipValue(datum.dataPoint) }} |
{{ datum.dataPoint.wallTime | date: 'short' }} |
{{
diff --git a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_component.ts b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_component.ts
index e12b5c0bab..bdaa4965be 100644
--- a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_component.ts
+++ b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_component.ts
@@ -88,6 +88,7 @@ export class ScalarCardComponent {
readonly DataLoadState = DataLoadState;
readonly RendererType = RendererType;
readonly ScaleType = ScaleType;
+ readonly XAxisType = XAxisType;
@Input() cardId!: string;
@Input() chartMetadataMap!: ScalarCardSeriesMetadataMap;
@@ -184,8 +185,9 @@ export class ScalarCardComponent {
getCustomXFormatter(): Formatter | undefined {
switch (this.xAxisType) {
- case XAxisType.RELATIVE:
+ case XAxisType.RELATIVE_TIME:
return relativeTimeFormatter;
+ case XAxisType.RELATIVE_STEP:
case XAxisType.STEP:
return siNumberFormatter;
case XAxisType.WALL_TIME:
@@ -194,6 +196,20 @@ export class ScalarCardComponent {
}
}
+ getStepTooltipHeader(): string {
+ return this.xAxisType === XAxisType.RELATIVE_STEP
+ ? 'Relative Step'
+ : 'Step';
+ }
+
+ getStepTooltipValue(point: ScalarCardPoint): string {
+ const step =
+ this.xAxisType === XAxisType.RELATIVE_STEP
+ ? point.relativeStep ?? point.step
+ : point.step;
+ return this.stepFormatter.formatShort(step);
+ }
+
getCursorAwareTooltipData(
tooltipData: TooltipDatum[],
cursorLocationInDataCoord: {x: number; y: number},
diff --git a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_container.ts b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_container.ts
index e0ed55cc12..40328977f9 100644
--- a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_container.ts
+++ b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_container.ts
@@ -264,7 +264,8 @@ export class ScalarCardContainer implements CardRenderer, OnInit, OnDestroy {
map((xAxisType) => {
switch (xAxisType) {
case XAxisType.STEP:
- case XAxisType.RELATIVE:
+ case XAxisType.RELATIVE_STEP:
+ case XAxisType.RELATIVE_TIME:
return ScaleType.LINEAR;
case XAxisType.WALL_TIME:
return ScaleType.TIME;
@@ -418,12 +419,14 @@ export class ScalarCardContainer implements CardRenderer, OnInit, OnDestroy {
map((partitionedSeriesList) => {
return partitionedSeriesList.map((partitionedSeries) => {
const firstWallTime = partitionedSeries.points[0]?.wallTime;
+ const firstStep = partitionedSeries.points[0]?.step;
return {
...partitionedSeries,
points: partitionedSeries.points.map((point) => {
return {
...point,
relativeTimeInMs: point.wallTime - firstWallTime,
+ relativeStep: point.step - firstStep,
};
}),
};
@@ -437,7 +440,10 @@ export class ScalarCardContainer implements CardRenderer, OnInit, OnDestroy {
points: series.points.map((point) => {
let x: number;
switch (xAxisType) {
- case XAxisType.RELATIVE:
+ case XAxisType.RELATIVE_STEP:
+ x = point.relativeStep;
+ break;
+ case XAxisType.RELATIVE_TIME:
x = point.relativeTimeInMs;
break;
case XAxisType.WALL_TIME:
@@ -721,7 +727,8 @@ export class ScalarCardContainer implements CardRenderer, OnInit, OnDestroy {
stepSeries: ScalarStepDatum[],
xAxisType: XAxisType
): ScalarCardPoint[] {
- const isStepBased = xAxisType === XAxisType.STEP;
+ const isStepBased =
+ xAxisType === XAxisType.STEP || xAxisType === XAxisType.RELATIVE_STEP;
return stepSeries.map((stepDatum) => {
// Normalize data and convert wallTime in seconds to milliseconds.
// TODO(stephanwlee): when the legacy line chart is removed, do the conversion
diff --git a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_line_chart_component.ts b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_line_chart_component.ts
index 999eda5745..e06026cff1 100644
--- a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_line_chart_component.ts
+++ b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_line_chart_component.ts
@@ -102,8 +102,9 @@ export class ScalarCardLineChartComponent {
getCustomXFormatter(): Formatter | undefined {
switch (this.xAxisType) {
- case XAxisType.RELATIVE:
+ case XAxisType.RELATIVE_TIME:
return relativeTimeFormatter;
+ case XAxisType.RELATIVE_STEP:
case XAxisType.STEP:
return siNumberFormatter;
case XAxisType.WALL_TIME:
diff --git a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_line_chart_container.ts b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_line_chart_container.ts
index 8cb2d4df52..eb2b08feaf 100644
--- a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_line_chart_container.ts
+++ b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_line_chart_container.ts
@@ -123,7 +123,8 @@ export class ScalarCardLineChartContainer
map((xAxisType) => {
switch (xAxisType) {
case XAxisType.STEP:
- case XAxisType.RELATIVE:
+ case XAxisType.RELATIVE_STEP:
+ case XAxisType.RELATIVE_TIME:
return ScaleType.LINEAR;
case XAxisType.WALL_TIME:
return ScaleType.TIME;
diff --git a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_line_chart_test.ts b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_line_chart_test.ts
index 25eb78f104..b40748f024 100644
--- a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_line_chart_test.ts
+++ b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_line_chart_test.ts
@@ -86,7 +86,7 @@ import {
} from './scalar_card_types';
@Component({
- changeDetection: ChangeDetectionStrategy.Default,
+ changeDetection: ChangeDetectionStrategy.Eager,
standalone: false,
selector: 'line-chart',
template: `
@@ -168,7 +168,7 @@ class TestableLineChart {
}
@Component({
- changeDetection: ChangeDetectionStrategy.Default,
+ changeDetection: ChangeDetectionStrategy.Eager,
standalone: false,
selector: 'test-scalar-card-line-chart',
template: `
@@ -538,10 +538,23 @@ describe('scalar card line chart', () => {
).toBe(siNumberFormatter);
}));
- it('uses relative time formatter when xAxisType is RELATIVE', fakeAsync(() => {
+ it('uses SI unit formatter when xAxisType is RELATIVE_STEP', fakeAsync(() => {
store.overrideSelector(
selectors.getMetricsXAxisType,
- XAxisType.RELATIVE
+ XAxisType.RELATIVE_STEP
+ );
+ const fixture = createComponent();
+
+ expect(
+ fixture.debugElement.query(Selector.LINE_CHART).componentInstance
+ .customXFormatter
+ ).toBe(siNumberFormatter);
+ }));
+
+ it('uses relative time formatter when xAxisType is RELATIVE_TIME', fakeAsync(() => {
+ store.overrideSelector(
+ selectors.getMetricsXAxisType,
+ XAxisType.RELATIVE_TIME
);
const fixture = createComponent();
@@ -958,8 +971,11 @@ describe('scalar card line chart', () => {
]);
}));
- it('shows relative time when XAxisType is RELATIVE', fakeAsync(() => {
- store.overrideSelector(selectors.getMetricsXAxisType, XAxisType.RELATIVE);
+ it('shows relative time when XAxisType is RELATIVE_TIME', fakeAsync(() => {
+ store.overrideSelector(
+ selectors.getMetricsXAxisType,
+ XAxisType.RELATIVE_TIME
+ );
const fixture = createComponent();
setTooltipData(fixture, [
buildTooltipDatum(
@@ -1398,10 +1414,31 @@ describe('scalar card line chart', () => {
).toEqual(1);
}));
- it('does not render fobs when axis type is RELATIVE', fakeAsync(() => {
+ it('does not render fobs when axis type is RELATIVE_STEP', fakeAsync(() => {
+ store.overrideSelector(
+ selectors.getMetricsXAxisType,
+ XAxisType.RELATIVE_STEP
+ );
+ const fixture = createComponent();
+ fixture.componentInstance.minMaxStep = {
+ minStep: 0,
+ maxStep: 100,
+ };
+ fixture.componentInstance.stepOrLinkedTimeSelection = {
+ start: {step: 20},
+ end: null,
+ };
+ fixture.detectChanges();
+
+ expect(
+ fixture.debugElement.queryAll(By.directive(CardFobComponent)).length
+ ).toEqual(0);
+ }));
+
+ it('does not render fobs when axis type is RELATIVE_TIME', fakeAsync(() => {
store.overrideSelector(
selectors.getMetricsXAxisType,
- XAxisType.RELATIVE
+ XAxisType.RELATIVE_TIME
);
const fixture = createComponent();
fixture.detectChanges();
diff --git a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_test.ts b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_test.ts
index 7dc7cb0fe9..293f9a767c 100644
--- a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_test.ts
+++ b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_test.ts
@@ -140,7 +140,7 @@ import {
import {VisLinkedTimeSelectionWarningModule} from './vis_linked_time_selection_warning_module';
@Component({
- changeDetection: ChangeDetectionStrategy.Default,
+ changeDetection: ChangeDetectionStrategy.Eager,
standalone: false,
selector: 'line-chart',
template: `
@@ -225,7 +225,7 @@ class TestableLineChart {
// DataDownloadContainer pulls in entire redux and, for this test, we don't want to
// know about their data requirements.
@Component({
- changeDetection: ChangeDetectionStrategy.Default,
+ changeDetection: ChangeDetectionStrategy.Eager,
standalone: false,
selector: 'testable-data-download-dialog',
template: `{{ cardId }}`,
@@ -569,10 +569,37 @@ describe('scalar card', () => {
).toBe(siNumberFormatter);
}));
- it('uses relative time formatter when xAxisType is RELATIVE', fakeAsync(() => {
+ it('uses SI unit formatter when xAxisType is RELATIVE_STEP', fakeAsync(() => {
store.overrideSelector(
selectors.getMetricsXAxisType,
- XAxisType.RELATIVE
+ XAxisType.RELATIVE_STEP
+ );
+
+ const cardMetadata = {
+ plugin: PluginType.SCALARS,
+ tag: 'tagA',
+ run: null,
+ };
+ provideMockCardRunToSeriesData(
+ selectSpy,
+ PluginType.SCALARS,
+ 'card1',
+ cardMetadata,
+ null /* runToSeries */
+ );
+
+ const fixture = createComponent('card1');
+
+ expect(
+ fixture.debugElement.query(Selector.LINE_CHART).componentInstance
+ .customXFormatter
+ ).toBe(siNumberFormatter);
+ }));
+
+ it('uses relative time formatter when xAxisType is RELATIVE_TIME', fakeAsync(() => {
+ store.overrideSelector(
+ selectors.getMetricsXAxisType,
+ XAxisType.RELATIVE_TIME
);
const cardMetadata = {
@@ -800,6 +827,10 @@ describe('scalar card', () => {
{x: 333, y: 1},
{x: 555, y: 2},
],
+ relativeStep: [
+ {x: 0, y: 1},
+ {x: 222, y: 2},
+ ],
wallTime: [
{x: 100000, y: 1},
{x: 101000, y: 2},
@@ -816,6 +847,11 @@ describe('scalar card', () => {
xType: XAxisType.STEP,
expectedPoints: expectedPoints.step,
},
+ {
+ name: 'relative_step',
+ xType: XAxisType.RELATIVE_STEP,
+ expectedPoints: expectedPoints.relativeStep,
+ },
{
name: 'wall_time',
xType: XAxisType.WALL_TIME,
@@ -823,7 +859,7 @@ describe('scalar card', () => {
},
{
name: 'relative',
- xType: XAxisType.RELATIVE,
+ xType: XAxisType.RELATIVE_TIME,
expectedPoints: expectedPoints.relative,
},
];
@@ -1101,10 +1137,19 @@ describe('scalar card', () => {
points: [
// Keeps the data structure as is but do notice adjusted wallTime and
// line_chart_v2 required "x" and "y" props.
- {wallTime: 2000, relativeTimeInMs: 0, value: 1, step: 1, x: 1, y: 1},
+ {
+ wallTime: 2000,
+ relativeTimeInMs: 0,
+ relativeStep: 0,
+ value: 1,
+ step: 1,
+ x: 1,
+ y: 1,
+ },
{
wallTime: 4000,
relativeTimeInMs: 2000,
+ relativeStep: 1,
value: 10,
step: 2,
x: 2,
@@ -1115,17 +1160,34 @@ describe('scalar card', () => {
{
id: 'run2',
points: [
- {wallTime: 2000, relativeTimeInMs: 0, value: 1, step: 1, x: 1, y: 1},
+ {
+ wallTime: 2000,
+ relativeTimeInMs: 0,
+ relativeStep: 0,
+ value: 1,
+ step: 1,
+ x: 1,
+ y: 1,
+ },
],
},
{
id: '["smoothed","run1"]',
points: [
- {wallTime: 2000, relativeTimeInMs: 0, value: 1, step: 1, x: 1, y: 1},
+ {
+ wallTime: 2000,
+ relativeTimeInMs: 0,
+ relativeStep: 0,
+ value: 1,
+ step: 1,
+ x: 1,
+ y: 1,
+ },
// Exact smoothed value is not too important.
{
wallTime: 4000,
relativeTimeInMs: 2000,
+ relativeStep: 1,
value: 10,
step: 2,
x: 2,
@@ -1136,7 +1198,15 @@ describe('scalar card', () => {
{
id: '["smoothed","run2"]',
points: [
- {wallTime: 2000, relativeTimeInMs: 0, value: 1, step: 1, x: 1, y: 1},
+ {
+ wallTime: 2000,
+ relativeTimeInMs: 0,
+ relativeStep: 0,
+ value: 1,
+ step: 1,
+ x: 1,
+ y: 1,
+ },
],
},
]);
@@ -1216,7 +1286,15 @@ describe('scalar card', () => {
id: 'run1',
points: [
// Keeps the data structure as is but requires "x" and "y" props.
- {wallTime: 2000, value: 1, step: 1, x: 1, y: 1, relativeTimeInMs: 0},
+ {
+ wallTime: 2000,
+ value: 1,
+ step: 1,
+ x: 1,
+ y: 1,
+ relativeTimeInMs: 0,
+ relativeStep: 0,
+ },
{
wallTime: 4000,
value: 10,
@@ -1224,13 +1302,22 @@ describe('scalar card', () => {
x: 2,
y: 10,
relativeTimeInMs: 2000,
+ relativeStep: 1,
},
],
},
{
id: 'run2',
points: [
- {wallTime: 2000, value: 1, step: 1, x: 1, y: 1, relativeTimeInMs: 0},
+ {
+ wallTime: 2000,
+ value: 1,
+ step: 1,
+ x: 1,
+ y: 1,
+ relativeTimeInMs: 0,
+ relativeStep: 0,
+ },
],
},
]);
@@ -1470,8 +1557,11 @@ describe('scalar card', () => {
]);
}));
- it('shows relative time when XAxisType is RELATIVE', fakeAsync(() => {
- store.overrideSelector(selectors.getMetricsXAxisType, XAxisType.RELATIVE);
+ it('shows relative time when XAxisType is RELATIVE_TIME', fakeAsync(() => {
+ store.overrideSelector(
+ selectors.getMetricsXAxisType,
+ XAxisType.RELATIVE_TIME
+ );
store.overrideSelector(selectors.getMetricsScalarSmoothing, 0);
const fixture = createComponent('card1');
setTooltipData(fixture, [
@@ -1544,6 +1634,87 @@ describe('scalar card', () => {
]);
}));
+ it('shows relative step when XAxisType is RELATIVE_STEP', fakeAsync(() => {
+ store.overrideSelector(
+ selectors.getMetricsXAxisType,
+ XAxisType.RELATIVE_STEP
+ );
+ store.overrideSelector(selectors.getMetricsScalarSmoothing, 0);
+ const fixture = createComponent('card1');
+ setTooltipData(fixture, [
+ buildTooltipDatum(
+ {
+ id: 'smoothed_row1',
+ type: SeriesType.DERIVED,
+ displayName: 'Row 1',
+ alias: null,
+ visible: true,
+ color: '#00f',
+ aux: false,
+ originalSeriesId: 'row1',
+ },
+ {
+ x: 980,
+ step: 5980,
+ relativeStep: 980,
+ y: 1000,
+ value: 1000,
+ wallTime: new Date('2020-01-01').getTime(),
+ relativeTimeInMs: 10,
+ }
+ ),
+ buildTooltipDatum(
+ {
+ id: 'smoothed_row2',
+ type: SeriesType.DERIVED,
+ displayName: 'Row 2',
+ alias: null,
+ visible: true,
+ color: '#0f0',
+ aux: false,
+ originalSeriesId: 'row2',
+ },
+ {
+ x: 1980,
+ step: 12980,
+ relativeStep: 1980,
+ y: -1000,
+ value: -1000,
+ wallTime: new Date('2020-01-05').getTime(),
+ relativeTimeInMs: 432000000,
+ }
+ ),
+ ]);
+ fixture.detectChanges();
+
+ const headerCols = fixture.debugElement.queryAll(
+ Selector.TOOLTIP_HEADER_COLUMN
+ );
+ const headerText = headerCols.map((col) =>
+ col.nativeElement.textContent.trim()
+ );
+ expect(headerText).toEqual([
+ '',
+ 'Run',
+ 'Value',
+ 'Relative Step', // or 'Step' if you keep the original | header
+ 'Time',
+ 'Relative',
+ ]);
+
+ const rows = fixture.debugElement.queryAll(Selector.TOOLTIP_ROW);
+ const tableContent = rows.map((row) => {
+ return row
+ .queryAll(By.css('td'))
+ .map((td) => td.nativeElement.textContent.trim());
+ });
+
+ expect(tableContent).toEqual([
+ ['', 'Row 1', '1000', '980', '1/1/20, 12:00\u202fAM', '10 ms'],
+ ['', 'Row 2', '-1000', '1,980', '1/5/20, 12:00\u202fAM', '5 day'],
+ ]);
+ }));
+
it('renders alias when alias is non-null', fakeAsync(() => {
const fixture = createComponent('card1');
setTooltipData(fixture, [
@@ -2080,6 +2251,7 @@ describe('scalar card', () => {
x: 1,
y: 1,
relativeTimeInMs: 0,
+ relativeStep: 0,
},
{
wallTime: 4000,
@@ -2088,6 +2260,7 @@ describe('scalar card', () => {
x: 2,
y: 10,
relativeTimeInMs: 2000,
+ relativeStep: 1,
},
{
wallTime: 6000,
@@ -2096,6 +2269,7 @@ describe('scalar card', () => {
x: 2,
y: 30,
relativeTimeInMs: 4000,
+ relativeStep: 1,
},
],
},
@@ -2109,6 +2283,7 @@ describe('scalar card', () => {
x: 1,
y: 10,
relativeTimeInMs: 0,
+ relativeStep: 0,
},
{
wallTime: 3000,
@@ -2117,6 +2292,7 @@ describe('scalar card', () => {
x: 4,
y: 20,
relativeTimeInMs: -3000,
+ relativeStep: 3,
},
],
},
@@ -2130,6 +2306,7 @@ describe('scalar card', () => {
x: 1,
y: 1,
relativeTimeInMs: 0,
+ relativeStep: 0,
},
],
},
@@ -2210,6 +2387,7 @@ describe('scalar card', () => {
{
wallTime: 2000,
relativeTimeInMs: 0,
+ relativeStep: 0,
value: 1,
step: 1,
x: 2000,
@@ -2218,6 +2396,7 @@ describe('scalar card', () => {
{
wallTime: 4000,
relativeTimeInMs: 2000,
+ relativeStep: 1,
value: 10,
step: 2,
x: 4000,
@@ -2226,6 +2405,7 @@ describe('scalar card', () => {
{
wallTime: 6000,
relativeTimeInMs: 4000,
+ relativeStep: 1,
value: 30,
step: 2,
x: 6000,
@@ -2234,6 +2414,7 @@ describe('scalar card', () => {
{
wallTime: 6000,
relativeTimeInMs: 4000,
+ relativeStep: 0,
value: 10,
step: 1,
x: 6000,
@@ -2247,6 +2428,7 @@ describe('scalar card', () => {
{
wallTime: 3000,
relativeTimeInMs: 0,
+ relativeStep: 0,
value: 20,
step: 4,
x: 3000,
@@ -2516,14 +2698,31 @@ describe('scalar card', () => {
).toEqual(1);
}));
- it('does not render fobs when axis type is RELATIVE', fakeAsync(() => {
+ it('does not render fobs when axis type is RELATIVE_STEP', fakeAsync(() => {
store.overrideSelector(getMetricsLinkedTimeSelection, {
start: {step: 20},
end: null,
});
store.overrideSelector(
selectors.getMetricsXAxisType,
- XAxisType.RELATIVE
+ XAxisType.RELATIVE_STEP
+ );
+ const fixture = createComponent('card1');
+ fixture.detectChanges();
+
+ expect(
+ fixture.debugElement.queryAll(By.directive(CardFobComponent)).length
+ ).toEqual(0);
+ }));
+
+ it('does not render fobs when axis type is RELATIVE_TIME', fakeAsync(() => {
+ store.overrideSelector(getMetricsLinkedTimeSelection, {
+ start: {step: 20},
+ end: null,
+ });
+ store.overrideSelector(
+ selectors.getMetricsXAxisType,
+ XAxisType.RELATIVE_TIME
);
const fixture = createComponent('card1');
fixture.detectChanges();
@@ -2781,14 +2980,33 @@ describe('scalar card', () => {
expect(dataTableComponent).toBeFalsy();
}));
- it('does not render table when axis type is RELATIVE', fakeAsync(() => {
+ it('does not render table when axis type is RELATIVE_STEP', fakeAsync(() => {
+ store.overrideSelector(getMetricsLinkedTimeSelection, {
+ start: {step: 20},
+ end: null,
+ });
+ store.overrideSelector(
+ selectors.getMetricsXAxisType,
+ XAxisType.RELATIVE_STEP
+ );
+ const fixture = createComponent('card1');
+ fixture.detectChanges();
+
+ const dataTableComponent = fixture.debugElement.query(
+ By.directive(DataTableComponent)
+ );
+
+ expect(dataTableComponent).toBeFalsy();
+ }));
+
+ it('does not render table when axis type is RELATIVE_TIME', fakeAsync(() => {
store.overrideSelector(getMetricsLinkedTimeSelection, {
start: {step: 20},
end: null,
});
store.overrideSelector(
selectors.getMetricsXAxisType,
- XAxisType.RELATIVE
+ XAxisType.RELATIVE_TIME
);
const fixture = createComponent('card1');
fixture.detectChanges();
diff --git a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_types.ts b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_types.ts
index a901e61c9e..98b77ed2eb 100644
--- a/tensorboard/webapp/metrics/views/card_renderer/scalar_card_types.ts
+++ b/tensorboard/webapp/metrics/views/card_renderer/scalar_card_types.ts
@@ -65,6 +65,7 @@ export interface ScalarCardPoint extends Point {
value: number;
step: number;
relativeTimeInMs: number;
+ relativeStep?: number;
}
export type ScalarCardDataSeries = DataSeries;
diff --git a/tensorboard/webapp/metrics/views/right_pane/settings_view_component.ts b/tensorboard/webapp/metrics/views/right_pane/settings_view_component.ts
index e90c634561..88da9f3de7 100644
--- a/tensorboard/webapp/metrics/views/right_pane/settings_view_component.ts
+++ b/tensorboard/webapp/metrics/views/right_pane/settings_view_component.ts
@@ -124,8 +124,9 @@ export class SettingsViewComponent {
readonly XAxisType = XAxisType;
readonly XAxisTypeDropdownOptions: DropdownOption[] = [
{value: XAxisType.STEP, displayText: 'Step'},
- {value: XAxisType.RELATIVE, displayText: 'Relative'},
+ {value: XAxisType.RELATIVE_STEP, displayText: 'Relative Step'},
{value: XAxisType.WALL_TIME, displayText: 'Wall'},
+ {value: XAxisType.RELATIVE_TIME, displayText: 'Relative Time'},
];
@Input() xAxisType!: XAxisType;
@Output() xAxisTypeChanged = new EventEmitter();
diff --git a/tensorboard/webapp/tb_polymer_interop_types.ts b/tensorboard/webapp/tb_polymer_interop_types.ts
index af232827a1..f7c2433605 100644
--- a/tensorboard/webapp/tb_polymer_interop_types.ts
+++ b/tensorboard/webapp/tb_polymer_interop_types.ts
@@ -74,8 +74,9 @@ export declare interface VzHistogramDatum {
export enum TimeProperty {
STEP = 'step',
+ RELATIVE_STEP = 'relative_step',
WALL_TIME = 'wall_time',
- RELATIVE = 'relative',
+ RELATIVE_TIME = 'relative_time',
}
export enum HistogramMode {
diff --git a/tensorboard/webapp/widgets/histogram/histogram_component.ts b/tensorboard/webapp/widgets/histogram/histogram_component.ts
index 8ed8d61eab..5383bf7aba 100644
--- a/tensorboard/webapp/widgets/histogram/histogram_component.ts
+++ b/tensorboard/webapp/widgets/histogram/histogram_component.ts
@@ -345,11 +345,13 @@ export class HistogramComponent implements AfterViewInit, OnChanges, OnDestroy {
private getTimeValue(datum: HistogramDatum): number {
switch (this.timeProperty) {
- case TimeProperty.WALL_TIME:
- return datum.wallTime;
case TimeProperty.STEP:
return datum.step;
- case TimeProperty.RELATIVE:
+ case TimeProperty.RELATIVE_STEP:
+ return datum.step - this.data[0].step;
+ case TimeProperty.WALL_TIME:
+ return datum.wallTime;
+ case TimeProperty.RELATIVE_TIME:
return datum.wallTime - this.data[0].wallTime;
}
}
@@ -456,12 +458,15 @@ export class HistogramComponent implements AfterViewInit, OnChanges, OnDestroy {
return this.formatters.count;
}
switch (this.timeProperty) {
- case TimeProperty.WALL_TIME:
- return this.formatters.wallTime;
case TimeProperty.STEP: {
return this.formatters.step;
}
- case TimeProperty.RELATIVE: {
+ case TimeProperty.RELATIVE_STEP: {
+ return this.formatters.step;
+ }
+ case TimeProperty.WALL_TIME:
+ return this.formatters.wallTime;
+ case TimeProperty.RELATIVE_TIME: {
return this.formatters.relative;
}
default:
@@ -473,7 +478,10 @@ export class HistogramComponent implements AfterViewInit, OnChanges, OnDestroy {
private getMaxTicks(yScale: Scales[keyof Scales]) {
const {height} = this.layout.contentClientRect;
const maxPerHeight = height / 15;
- if (this.timeProperty === TimeProperty.STEP) {
+ if (
+ this.timeProperty === TimeProperty.STEP ||
+ this.timeProperty === TimeProperty.RELATIVE_STEP
+ ) {
const [min, max] = yScale.domain() as [number, number];
const numberOfSteps = Math.max(max - min + 1, 1);
return Math.min(numberOfSteps, maxPerHeight);
diff --git a/tensorboard/webapp/widgets/histogram/histogram_test.ts b/tensorboard/webapp/widgets/histogram/histogram_test.ts
index e176b3f74f..09230b35d4 100644
--- a/tensorboard/webapp/widgets/histogram/histogram_test.ts
+++ b/tensorboard/webapp/widgets/histogram/histogram_test.ts
@@ -396,7 +396,7 @@ describe('histogram test', () => {
]);
});
- it('renders relative time from first data in RELATIVE mode', () => {
+ it('renders relative time from first data in RELATIVE_TIME mode', () => {
const fixture = createComponent('foo', [
buildHistogramDatum({
step: 0,
@@ -412,7 +412,7 @@ describe('histogram test', () => {
}),
]);
fixture.componentInstance.mode = HistogramMode.OFFSET;
- fixture.componentInstance.timeProperty = TimeProperty.RELATIVE;
+ fixture.componentInstance.timeProperty = TimeProperty.RELATIVE_TIME;
fixture.detectChanges();
mockContentRect(fixture);
intersectionObserver.simulateVisibilityChange(fixture, true);
@@ -421,6 +421,28 @@ describe('histogram test', () => {
getAxisLabelText(fixture.debugElement.query(byCss.Y_AXIS))
).toEqual(['0h', '600h', '1000h']);
});
+
+ it('renders relative step from first data in RELATIVE_STEP mode', () => {
+ const fixture = createComponent('foo', [
+ buildHistogramDatum({step: 1000}),
+ buildHistogramDatum({step: 1001}),
+ buildHistogramDatum({step: 1002}),
+ buildHistogramDatum({step: 1003}),
+ buildHistogramDatum({step: 1004}),
+ buildHistogramDatum({step: 1005}),
+ buildHistogramDatum({step: 1006}),
+ buildHistogramDatum({step: 1007}),
+ ]);
+ fixture.componentInstance.mode = HistogramMode.OFFSET;
+ fixture.componentInstance.timeProperty = TimeProperty.RELATIVE_STEP;
+ fixture.detectChanges();
+ mockContentRect(fixture);
+ intersectionObserver.simulateVisibilityChange(fixture, true);
+
+ expect(
+ getAxisLabelText(fixture.debugElement.query(byCss.Y_AXIS))
+ ).toEqual(['0', '2', '4', '6']);
+ });
});
describe('overlay mode', () => {
@@ -517,9 +539,9 @@ describe('histogram test', () => {
'translate(0px, 50px)',
]);
- fixture.componentInstance.timeProperty = TimeProperty.RELATIVE;
+ fixture.componentInstance.timeProperty = TimeProperty.RELATIVE_TIME;
fixture.detectChanges();
- // Even the RELATIVE time property takes minimum relative value to the
+ // Even the RELATIVE_TIME time property takes minimum relative value to the
// max (-300, 300) which has the same spacing as the WALL_TIME.
expect(
getGroupTransforms(fixture.debugElement.query(byCss.HISTOGRAMS))
@@ -763,7 +785,7 @@ describe('histogram test', () => {
);
});
- it('shows relative time on yAxis for TimeProperty.RELATIVE', () => {
+ it('shows relative time on yAxis for TimeProperty.RELATIVE_TIME', () => {
const data = [
buildHistogramDatum({
step: 1,
@@ -779,7 +801,7 @@ describe('histogram test', () => {
const fixture = createComponent('foo', data);
fixture.componentInstance.mode = HistogramMode.OFFSET;
- fixture.componentInstance.timeProperty = TimeProperty.RELATIVE;
+ fixture.componentInstance.timeProperty = TimeProperty.RELATIVE_TIME;
fixture.detectChanges();
intersectionObserver.simulateVisibilityChange(fixture, true);
@@ -797,6 +819,36 @@ describe('histogram test', () => {
);
});
+ it('shows relative step on yAxis for TimeProperty.RELATIVE_STEP', () => {
+ const data = [
+ buildHistogramDatum({
+ step: 1000,
+ bins: [buildBin({x: 0, dx: 10, y: 100})],
+ }),
+ buildHistogramDatum({
+ step: 2500,
+ bins: [buildBin({x: 0, dx: 10, y: 100})],
+ }),
+ ];
+
+ const fixture = createComponent('foo', data);
+ fixture.componentInstance.mode = HistogramMode.OFFSET;
+ fixture.componentInstance.timeProperty = TimeProperty.RELATIVE_STEP;
+ fixture.detectChanges();
+ intersectionObserver.simulateVisibilityChange(fixture, true);
+
+ const tooltipData = simulateMouseMove(fixture, 1, 5, 10);
+
+ expect(tooltipData).toEqual(
+ buildTooltipData({
+ yAxis: {
+ position: 0,
+ label: '1500',
+ },
+ })
+ );
+ });
+
it('shows count value on value tooltip', () => {
const data = [
buildHistogramDatum({
| |