Skip to content

Commit

Permalink
Add state attribute to Experiment interface (tensorflow#6222)
Browse files Browse the repository at this point in the history
* Motivation for features / changes
This attribute is used internally to determine if the experiment is
active or hidden.
  • Loading branch information
JamesHollyer authored Mar 13, 2023
1 parent a3ab7f8 commit 968120d
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions tensorboard/webapp/experiments/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down

0 comments on commit 968120d

Please sign in to comment.