From 968120d352d33b6c034d5a9f7379c979cd01d4fa Mon Sep 17 00:00:00 2001 From: James Date: Mon, 13 Mar 2023 13:21:50 -0700 Subject: [PATCH] Add state attribute to Experiment interface (#6222) * Motivation for features / changes This attribute is used internally to determine if the experiment is active or hidden. --- tensorboard/webapp/experiments/types.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/tensorboard/webapp/experiments/types.ts b/tensorboard/webapp/experiments/types.ts index 722ad29704..700279013b 100644 --- a/tensorboard/webapp/experiments/types.ts +++ b/tensorboard/webapp/experiments/types.ts @@ -22,6 +22,12 @@ export declare interface Experiment { hparams?: string; tags?: string[]; related_links?: Array<{name: string; url: string}>; + // These state values were chosen to follow these AIPs + // https://google.aip.dev/164 and https://google.aip.dev/216. + // However, we replaced 'delete' with 'hidden' as this feature is different + // from the soft delete described in the AIP. In this case 'hidden' simply + // means that the experiment is not shown in the experiment list. + state?: 'active' | 'hidden' | 'unspecified'; } export interface ExperimentAlias {