package determined.project.v1

Get desktop application:
View/edit binary Protocol Buffers messages

ColumnType indicates the type of data under the column

Used in: ProjectColumn

• COLUMN_TYPE_UNSPECIFIED = 0

  data type is unknown/mixed

• COLUMN_TYPE_TEXT = 1

  data type is textual

• COLUMN_TYPE_NUMBER = 2

  data type is numeric

• COLUMN_TYPE_DATE = 3

  data type is a date

• COLUMN_TYPE_ARRAY = 4

  data type is an array

LocationType indicates where a column comes from

Used in: ProjectColumn

• LOCATION_TYPE_UNSPECIFIED = 0

  Location unknown

• LOCATION_TYPE_EXPERIMENT = 1

  Column is located on the experiment

• LOCATION_TYPE_HYPERPARAMETERS = 2

  Column is located in the hyperparameter config of the experiment

• LOCATION_TYPE_VALIDATIONS = 3

  Column is located on the experiment's validation metrics

• LOCATION_TYPE_TRAINING = 4

  Column is located on the experiment's training steps

• LOCATION_TYPE_CUSTOM_METRIC = 5

  Column is located on the experiment's custom metric

• LOCATION_TYPE_RUN = 6

  Column is located on the run

• LOCATION_TYPE_RUN_HYPERPARAMETERS = 7

  Column is located in the hyperparameter of the run

• LOCATION_TYPE_RUN_METADATA = 8

  Column is located on the run's arbitrary metadata

MetricsRange represents the range of a metrics. Range is a in the format of [min, max].

Used in: api.v1.GetProjectNumericMetricsRangeResponse

• string metrics_name = 1

  The name of metrics formatted as <type>.<name>.

• double min = 2

  The min of metrics values.

• double max = 3

  The max of metrics values.

Note is a user comment connected to a project.

Used in: api.v1.AddProjectNoteRequest, api.v1.AddProjectNoteResponse, api.v1.PutProjectNotesRequest, api.v1.PutProjectNotesResponse, Project

• string name = 1

  The name or title of the note.

• string contents = 2

  The text contents of the note.

PatchProject is a partial update to a project with all optional fields.

Used in: api.v1.PatchProjectRequest

• optional google.protobuf.StringValue name = 1

  The new name for the project.

• optional google.protobuf.StringValue description = 2

  The new description for the project.

• optional google.protobuf.StringValue key = 3

  The new key for the project.

Project is a named collection of experiments.

Used in: api.v1.GetProjectByKeyResponse, api.v1.GetProjectResponse, api.v1.GetProjectsByUserActivityResponse, api.v1.GetWorkspaceProjectsResponse, api.v1.PatchProjectResponse, api.v1.PostProjectResponse

• int32 id = 1

  The unique id of the project.

• string name = 2

  The unique name of the project.

• int32 workspace_id = 3

  The id of the associated workspace.

• string description = 4

  The description of the project.

• optional google.protobuf.Timestamp last_experiment_started_at = 5

  Time of most recently started experiment within this project.

• repeated Note notes = 6

  Notes associated with this project.

• int32 num_experiments = 7

  Count of experiments associated with this project.

• int32 num_active_experiments = 8

  Count of active experiments associated with this project.

• bool archived = 9

  Whether this project is archived or not.

• string username = 10

  User who created this project.

• bool immutable = 11

  Whether this project is immutable (default uncategorized project).

• int32 user_id = 12

  ID of the user who created this project.

• string workspace_name = 13

  The name of the associated workspace.

• workspace.v1.WorkspaceState state = 14

  State of project during deletion.

• string error_message = 15

  Message stored from errors on async-deleting a project.

• string key = 16

  The key of the project.

• int32 num_runs = 17

  Count of runs associated with this project.

Project Column is a description of a column used on experiments in the project.

Used in: api.v1.GetProjectColumnsResponse

• string column = 1

  Raw column name.

• LocationType location = 2

  Where the column comes from.

• ColumnType type = 3

  Type of data in the column.

• string display_name = 4

  Human-friendly name.