package determined.api.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service Determined
api.proto:82Determined is the official v1 of the Determined API.
rpc Login (, )
api.proto:84Login the user.
message
auth.proto:10Login the user.
string username = 1
The username of the user.
string password = 2
The password of the user.
bool is_hashed = 3
Indicate whether the provided password is pre-salted & hashed or not.
message
auth.proto:22Response to LoginRequest.
string token = 1
The token to be used when sending results.
optional user = 2
The logged in user.
rpc CurrentUser (, )
api.proto:95Get the current user.
message
auth.proto:33Get the current user.
(message has no fields)
message
auth.proto:35Response to CurrentUserRequest.
optional user = 1
The currently logged in user.
rpc Logout (, )
api.proto:104Logout the user.
message
auth.proto:44Logout the user.
(message has no fields)
message
auth.proto:46Response to LogoutRequest.
(message has no fields)
rpc GetUsers (, )
api.proto:114Get a list of users.
message
user.proto:22Get a list of users.
GetUsersRequest.SortBy sort_by = 1
Sort users by the given field.
OrderBy order_by = 2
Order users in either ascending or descending order.
int32 offset = 3
Skip the number of projects before returning results. Negative values denote number of projects to skip from the end before returning results.
int32 limit = 4
Limit the number of projects. A value of 0 denotes no limit.
string name = 5
Filter by username or display name.
optional bool active = 6
Filter by status.
optional bool admin = 7
Filter by roles.
repeated int32 role_id_assigned_directly_to_user = 8
Filter by roles id assigned directly to user for EE.
message
user.proto:65Response to GetUsersRequest.
repeated users = 1
The list of requested users.
optional pagination = 2
Pagination information of the full dataset.
rpc GetUserSetting (, )
api.proto:123Get a user's settings for website
message
user.proto:187Get user settings.
(message has no fields)
message
user.proto:189Response to GetUserSettingRequest.
repeated settings = 1
List of user settings.
rpc ResetUserSetting (, )
api.proto:132Reset a user's settings for website
message
user.proto:207Reset user setting.
(message has no fields)
message
user.proto:209Response to ResetUserSettingRequest.
(message has no fields)
rpc PostUserSetting (, )
api.proto:142Post a user's settings for website
message
user.proto:197Update user settings.
repeated settings = 1
Setting key value pair.
message
user.proto:205Response to PostUserSettingRequest.
(message has no fields)
rpc GetUser (, )
api.proto:153Get the requested user.
message
user.proto:73Get the requested user by user id.
int32 user_id = 1
The id of the user.
message
user.proto:78Response to GetUserRequest.
optional user = 1
The requested user.
rpc GetUserByUsername (, )
api.proto:163Get the requested user with username.
message
user.proto:87Get the requested user by username.
string username = 1
The string of the username.
message
user.proto:92Response to GetUserByUsernameRequest.
optional user = 1
The requested user.
rpc GetMe (, )
api.proto:174Get the current user.
message
user.proto:101Get the requested current user.
(message has no fields)
message
user.proto:103Response to GetMeRequest.
optional user = 1
The requested user.
rpc PostUser (, )
api.proto:184Create a new user.
message
user.proto:112Create a new user.
optional user = 1
The user to create.
string password = 2
The password of the user.
bool is_hashed = 3
Indicate whether the provided password is pre-salted & hashed or not.
message
user.proto:121Response to PostUserRequest.
optional user = 1
The created user.
rpc SetUserPassword (, )
api.proto:194Set the requested user's password.
message
user.proto:127Set the requested user's passwords.
int32 user_id = 3
The id of the user.
string password = 2
The password of the user.
message
user.proto:134Response to SetUserPasswordRequest.
optional user = 1
The updated user.
rpc AssignMultipleGroups (, )
api.proto:205Assign multiple users to multiple groups.
message
group.proto:119Add and remove multiple users from multiple groups.
repeated int32 user_ids = 1
The user ids of users to edit group associations.
repeated int32 add_groups = 2
The ids of groups to associate with users.
repeated int32 remove_groups = 3
The ids of groups to disassociate from users.
message
group.proto:132Response to AssignMultipleGroupsRequest.
(message has no fields)
rpc PatchUser (, )
api.proto:216Patch a user's fields.
message
user.proto:140Edit fields for a user.
int32 user_id = 2
The id of the user.
optional user = 1
The updated user.
message
user.proto:147Response to PatchUserRequest.
optional user = 1
The updated user.
rpc PatchUsers (, )
api.proto:226Patch multiple users' activation status.
message
user.proto:164Update activation status for multiple users.
repeated int32 user_ids = 1
A list of user IDs to update.
bool activate = 2
Intended status (true to activate, false to deactivate).
optional filters = 3
Option to filter to users with these properties.
message
user.proto:177Response to PatchUsersRequest.
repeated results = 1
Details on success or error for each user.
rpc GetTelemetry (, )
api.proto:236Get telemetry information.
message
master.proto:104Get telemetry information.
(message has no fields)
message
master.proto:106Response to GetTelemetryRequest.
bool enabled = 1
Whether telemetry is enabled or not.
string segment_key = 2
The key used for analytics in the UI.
rpc GetMaster (, )
api.proto:246Get master information.
message
master.proto:47Get master information.
(message has no fields)
message
master.proto:49Response to GetMasterRequest.
string version = 1
The current version of the master.
string master_id = 2
The current instance id of the master.
string cluster_id = 3
The global cluster id of the master.
string cluster_name = 4
The cluster name.
bool telemetry_enabled = 5
Telemetry status.
repeated sso_providers = 6
SSO providers.
string external_login_uri = 7
Redirect for starting internal sessions..
string external_logout_uri = 8
Redirect for ending external sessions.
string branding = 9
Branding style to use on front-end.
bool rbac_enabled = 10
Feature flag for RBAC and user groups.
GetMasterResponse.Product product = 11
What kind of product offering the cluster is part of, if any
repeated string feature_switches = 12
List of features that is on.
bool user_management_enabled = 13
Feature flag for user management.
bool strict_job_queue_control = 14
Feature flag for strict job queue control.
optional cluster_message = 15
Active server cluster-wide message if any.
bool has_custom_logo = 16
Whether the cluster has a user-submitted custom logo.
rpc GetMasterConfig (, )
api.proto:256Get master config.
message
master.proto:117Get master config.
(message has no fields)
message
master.proto:119Response to GetMasterRequest.
optional config = 1
The config file loaded by the master.
rpc PatchMasterConfig (, )
api.proto:266Patch master config.
message
master.proto:128Patch master config.
optional config = 1
The new config that the user wants to patch into the master config.
optional field_mask = 2
The fields from the master config that the user wants to patch.
message
master.proto:135Response to PatchMasterConfigRequest.
(message has no fields)
rpc MasterLogs (, stream )
api.proto:277Stream master logs.
message
master.proto:172Stream master logs.
int32 offset = 3
Skip the number of master logs before returning results. Negative values denote number of master logs to skip from the end before returning results.
int32 limit = 4
Limit the number of master logs. A value of 0 denotes no limit.
bool follow = 5
Continue following logs until the master stops or the limit is reached.
message
master.proto:182Response to MasterLogsRequest.
optional log_entry = 1
The log entry.
rpc GetClusterMessage (, )
api.proto:286Get the currently configured cluster-wide message.
message
master.proto:139GetClusterMessageRequest is used to get the current cluster message by admins.
(message has no fields)
message
master.proto:143GetClusterMessageResponse is the response that contains the current cluster message.
optional cluster_message = 1
cluster_message is the current cluster message.
rpc SetClusterMessage (, )
api.proto:297Set the cluster-wide message shown to users. Only one can be set at at time, so any existing message will be disabled.
message
master.proto:149Set the cluster-wide message.
string message = 1
Text content of message.
optional start_time = 2
Time to begin showing message.
optional end_time = 3
Time to stop showing message.
optional string duration = 4
Duration expressing how long the message should last. Should be a Go-format duration (e.g. 24h, 2w, 5d)
message
master.proto:164Response to SetClusterMessageRequest.
(message has no fields)
rpc DeleteClusterMessage (, )
api.proto:308Clear the cluster-wide message shown to all users.
message
master.proto:167Clear the configured cluster-wide message.
(message has no fields)
message
master.proto:169Response to DeleteClusterMessageRequest.
(message has no fields)
rpc GetAgents (, )
api.proto:318Get a set of agents from the cluster.
message
agent.proto:12Get a set of agents from the cluster.
GetAgentsRequest.SortBy sort_by = 1
Sort agents by the given field.
OrderBy order_by = 2
Order agents in either ascending or descending order.
int32 offset = 3
Skip the number of agents before returning results. Negative values denote number of agents to skip from the end before returning results.
int32 limit = 4
Limit the number of agents. A value of 0 denotes no limit.
bool exclude_slots = 6
exclude slots
bool exclude_containers = 7
exclude containers
message
agent.proto:39Response to GetAgentsRequest.
repeated agents = 1
The list of returned agents.
optional pagination = 2
Pagination information of the full dataset.
rpc GetAgent (, )
api.proto:327Get the requested agent.
message
agent.proto:51Get the requested agent.
string agent_id = 1
The id of the agent.
message
agent.proto:56Response to GetAgentRequest.
optional agent = 1
The requested agent.
rpc GetSlots (, )
api.proto:336Get all the slots for an agent.
message
agent.proto:65Get the set of slots for the agent with the given id.
string agent_id = 1
The id of the agent.
message
agent.proto:70Response to GetSlotsRequest.
repeated slots = 1
The requested slots.
rpc GetSlot (, )
api.proto:345Get the requested slot for an agent.
message
agent.proto:76Get the requested slot for the agent with the given id.
string agent_id = 1
The id of the agent.
string slot_id = 2
The id of the slot.
message
agent.proto:83Response to GetSlotRequest.
optional slot = 1
The requested slot.
rpc EnableAgent (, )
api.proto:354Enable the agent.
message
agent.proto:89Enable the agent.
string agent_id = 1
The id of the agent.
message
agent.proto:94Response to EnableAgentRequest.
optional agent = 1
The enabled agent.
rpc DisableAgent (, )
api.proto:363Disable the agent.
message
agent.proto:100Disable the agent.
string agent_id = 1
The id of the agent.
bool drain = 2
If true, wait for running tasks to finish.
message
agent.proto:107Response to DisableAgentRequest.
optional agent = 1
The disabled agent.
rpc EnableSlot (, )
api.proto:373Enable the slot.
message
agent.proto:113Enable the slot.
string agent_id = 1
The id of the agent.
string slot_id = 2
The id of the slot.
message
agent.proto:120Response to EnableSlotRequest.
optional slot = 1
The enabled slot.
rpc DisableSlot (, )
api.proto:382Disable the slot.
message
agent.proto:126Disable the slot.
string agent_id = 1
The id of the agent.
string slot_id = 2
The id of the slot.
bool drain = 3
If true, wait for running task to finish.
message
agent.proto:135Response to DisableSlotRequest.
optional slot = 1
The disabled slot.
rpc CreateGenericTask (, )
api.proto:393Create an experiment.
message
task.proto:17Request to create a new generic task.
repeated context_directory = 1
Generic task context.
string config = 2
Generic task config (YAML).
optional int32 project_id = 3
Project id to contain the experiment.
optional string parent_id = 4
Parent ID of new task
optional bool inherit_context = 5
If True inherits the context directory from the paren task (requires parent_id)
optional string forked_from = 6
Id of the task that this task is forked from
optional bool no_pause = 7
Flag for whether task can be paused or not.
message
task.proto:39Response to CreateExperimentRequest.
string task_id = 1
The created generic taskID.
repeated LaunchWarning warnings = 2
List of any related warnings.
rpc CreateExperiment (, )
api.proto:405Create an experiment.
message
experiment.proto:599Response to CreateExperimentRequest.
optional experiment = 1
The created experiment.
optional config = 2
The created experiment config.
repeated LaunchWarning warnings = 3
List of any related warnings.
rpc PutExperiment (, )
api.proto:416Put an experiment by external id.
message
experiment.proto:613PutExperimentRequest is CreateExperimentRequest with external_experiment_id field added. Use for unmanaged experiments only.
optional create_experiment_request = 1
CreateExperimentRequest payload.
string external_experiment_id = 41
External experiment id.
message
experiment.proto:622Response to PutExperimentRequest.
optional experiment = 1
The created experiment.
optional config = 2
The created experiment config.
Note: no LaunchWarnings.
rpc ContinueExperiment (, )
api.proto:427Continues an experiment either to make the existing experiment train longer or to retry it.
message
experiment.proto:634Request to continue an experiment.
int32 id = 1
Experiment ID to continue.
string override_config = 2
Experiment config (YAML) to merge with the experiment's config.
message
experiment.proto:645Request to continue an experiment.
optional experiment = 1
The created experiment.
repeated LaunchWarning warnings = 2
List of any related warnings.
rpc GetExperiment (, )
api.proto:438Get the requested experiment.
message
experiment.proto:38Get a single experiment.
int32 experiment_id = 1
The id of the experiment.
message
experiment.proto:43Response to GetExperimentRequest.
optional experiment = 1
The requested experiment.
optional job_summary = 3
Associated job summary.
optional config = 4
The experiment's config.
rpc GetExperiments (, )
api.proto:447Get a list of experiments.
message
experiment.proto:56Get a list of experiments.
GetExperimentsRequest.SortBy sort_by = 1
Sort experiments by the given field.
OrderBy order_by = 2
Order experiments in either ascending or descending order.
int32 offset = 3
Skip the number of experiments before returning results. Negative values denote number of experiments to skip from the end before returning results.
int32 limit = 4
Limit the number of experiments. 0 or Unspecified - returns a default of 100. -1 - returns everything. -2 - returns pagination info but no experiments.
string description = 5
Limit experiments to those that match the description.
string name = 10
Limit experiments to those that match the name.
repeated string labels = 6
Limit experiments to those that match the provided labels.
optional archived = 7
Limit experiments to those that are archived.
repeated experiment.v1.State states = 8
Limit experiments to those that match the provided state.
repeated string users = 9
Limit experiments to those that are owned by users with the specified usernames.
repeated int32 user_ids = 11
Limit experiments to those that are owned by users with the specified userIds.
int32 project_id = 12
Limit experiments to those within a specified project, or 0 for all projects.
optional experiment_id_filter = 13
filtering by experiment ids
bool show_trial_data = 14
whether to surface trial specific data from the best trial
message
experiment.proto:130Response to GetExperimentsRequest.
repeated experiments = 1
The list of returned experiments.
optional pagination = 2
Pagination information of the full dataset.
rpc PutExperimentRetainLogs (, )
api.proto:457Retain logs for an experiment.
message
experiment.proto:152Request for changing the log retention policy for the an experiment.
int32 experiment_id = 1
The ID of the experiment.
int32 num_days = 2
The number of days to retain logs, starting from the end time of the task.
message
experiment.proto:164Response to PutExperimentRetainLogsRequest.
(message has no fields)
Retain logs for an experiment.
message
experiment.proto:167Request for changing the log retention policy for the an experiment.
repeated int32 experiment_ids = 1
The ids of the experiments being moved.
int32 num_days = 2
The number of days to retain logs, starting from the end time of the task.
optional filters = 3
Targets all experiments matching filters.
int32 project_id = 4
Project id that the experiments belong to.
message
experiment.proto:182Response to PutExperimentRetainLogsRequest.
repeated results = 1
Details on success or error for each experiment.
rpc PutTrialRetainLogs (, )
api.proto:481Retain logs for a Trial.
message
trial.proto:470Request for changing the log retention policy for the an experiment.
int32 trial_id = 1
The ID of the trial.
int32 num_days = 2
The number of days to retain logs, starting from the end time of the task.
message
trial.proto:482Response to PutExperimentRetainLogsRequest.
(message has no fields)
rpc GetModelDef (, )
api.proto:492Get the model definition of an experiment.
message
experiment.proto:833Request for an experiment model definition.
int32 experiment_id = 1
The id of the experiment.
message
experiment.proto:839Response to GetModelDefRequest.
string b64_tgz = 1
The base64-encoded, gzipped, tarball.
rpc GetTaskContextDirectory (, )
api.proto:502Get the model definition of a task.
message
task.proto:68Request for an task's context directory.
string task_id = 1
The id of the experiment.
message
task.proto:74Response to GetTaskContextDirectoryRequest.
string b64_tgz = 1
The base64-encoded, gzipped, tarball.
rpc GetModelDefTree (, )
api.proto:512Get the model definition file tree of an experiment.
message
experiment.proto:891Request to get model definition file tree of an experiment.
int32 experiment_id = 1
The id of the experiment.
message
experiment.proto:897Response to GetModelDefTreeRequest.
repeated files = 1
File tree of an experiment.
rpc GetModelDefFile (, )
api.proto:522Get one file content of model definition of an experiment.
message
experiment.proto:903Request to get a file of model definition.
int32 experiment_id = 1
The id of the experiment.
string path = 2
The path of file.
message
experiment.proto:911Response to GetModelDefFileRequest.
bytes file = 1
Content of file.
rpc GetExperimentLabels (, )
api.proto:533Get a list of unique experiment labels (sorted by popularity).
message
experiment.proto:141Get a list of experiment labels.
int32 project_id = 1
Filter experiments by project.
message
experiment.proto:146Response to GetExperimentsLabelsRequest.
repeated string labels = 1
The list of labels used across all experiments.
Get the validation history for an experiment.
message
experiment.proto:564Get the validation history for the requested experiment. The validation history is a time ordered list of the historical best validations.
int32 experiment_id = 1
The id of the experiment.
message
experiment.proto:570Response to GetExperimentValidationHistoryRequest.
repeated validation_history = 1
validation_history is a collection of zero or more validation metrics for an experiment, describing the best metrics as they were reported through the lifetime of an experiment. The historical list of best validations.
rpc ActivateExperiment (, )
api.proto:553Activate an experiment.
message
experiment.proto:293Activate an experiment.
int32 id = 1
The experiment id.
message
experiment.proto:298Response to ActivateExperimentRequest.
(message has no fields)
rpc ActivateExperiments (, )
api.proto:563Activate multiple experiments.
message
experiment.proto:312Activate multiple experiments.
repeated int32 experiment_ids = 1
Select experiments by id.
optional filters = 2
Targets all experiments matching filters.
int32 project_id = 3
Project id that the experiments belong to.
message
experiment.proto:325Response to ActivateExperimentsRequest.
repeated results = 1
Details on success or error for each experiment.
rpc PauseExperiment (, )
api.proto:574Pause an experiment.
message
experiment.proto:335Pause an experiment.
int32 id = 1
The experiment id.
message
experiment.proto:340Response to PauseExperimentRequest.
(message has no fields)
rpc PauseExperiments (, )
api.proto:584Pause multiple experiments.
message
experiment.proto:365Pause multiple experiments.
repeated int32 experiment_ids = 1
Selecting experiments by id.
optional filters = 2
Targets all experiments matching filters.
int32 project_id = 3
Project id that the experiments belong to.
message
experiment.proto:379Response to PauseExperimentsRequest.
repeated results = 1
Details on success or error for each experiment.
rpc CancelExperiment (, )
api.proto:595Cancel an experiment.
message
experiment.proto:389Cancel an experiment.
int32 id = 1
The experiment id.
message
experiment.proto:394Response to CancelExperimentRequest.
(message has no fields)
rpc CancelExperiments (, )
api.proto:605Cancel multiple experiments.
message
experiment.proto:397Cancel multiple experiments.
repeated int32 experiment_ids = 1
Selecting experiments by id.
optional filters = 2
Targets all experiments matching filters.
int32 project_id = 3
Project id that the experiments belong to.
message
experiment.proto:410Response to CancelExperimentsRequest.
repeated results = 1
Details on success or error for each experiment.
rpc KillExperiment (, )
api.proto:616Kill an experiment.
message
experiment.proto:420Kill an experiment.
int32 id = 1
The experiment id.
message
experiment.proto:425Response to KillExperimentRequest.
(message has no fields)
rpc KillExperiments (, )
api.proto:625Kill multiple experiments.
message
experiment.proto:428Kill multiple experiments.
repeated int32 experiment_ids = 1
Selecting experiments by id.
optional filters = 2
Targets all experiments matching filters.
int32 project_id = 3
Project id that the experiments belong to.
message
experiment.proto:441Response to KillExperimentsRequest.
repeated results = 1
Details on success or error for each experiment.
rpc ArchiveExperiment (, )
api.proto:636Archive an experiment.
message
experiment.proto:451Archive an experiment.
int32 id = 1
The experiment id.
message
experiment.proto:456Response to ArchiveExperimentRequest.
(message has no fields)
rpc ArchiveExperiments (, )
api.proto:646Archive multiple experiments.
message
experiment.proto:459Archive multiple experiments.
repeated int32 experiment_ids = 1
Selecting experiments by id.
optional filters = 2
Targets all experiments matching filters.
int32 project_id = 3
Project id that the experiments belong to.
message
experiment.proto:472Response to ArchiveExperimentsRequest.
repeated results = 1
Details on success or error for each experiment.
rpc UnarchiveExperiment (, )
api.proto:657Unarchive an experiment.
message
experiment.proto:482Unarchive an experiment.
int32 id = 1
The experiment id.
message
experiment.proto:487Response to UnarchiveExperimentRequest.
(message has no fields)
rpc UnarchiveExperiments (, )
api.proto:667Unarchive multiple experiments.
message
experiment.proto:490Unarchive multiple experiments.
repeated int32 experiment_ids = 1
Selecting experiments by id.
optional filters = 2
Targets all experiments matching filters.
int32 project_id = 3
Project id that the experiments belong to.
message
experiment.proto:503Response to UnarchiveExperimentsRequest.
repeated results = 1
Details on success or error for each experiment.
rpc PatchExperiment (, )
api.proto:678Patch an experiment's fields.
message
experiment.proto:515Patch an experiment by providing the updated attributes. Only description, label, name, and notes fields will be updated through this endpoint, and others will be ignored.
optional experiment = 2
Patched experiment attributes.
message
experiment.proto:521Response to PatchExperimentRequest.
optional experiment = 1
Patched experiment.
rpc DeleteExperiments (, )
api.proto:689Delete multiple experiments.
message
experiment.proto:245Delete multiple experiments.
repeated int32 experiment_ids = 1
Selecting experiments by id.
optional filters = 2
Targets all experiments matching filters.
int32 project_id = 3
Project id that the experiments belong to.
message
experiment.proto:259Response to DeleteExperimentsRequest.
repeated results = 1
Details on success or error for each experiment.
rpc DeleteExperiment (, )
api.proto:700Delete the requested experiment.
message
experiment.proto:237Delete a single experiment.
int32 experiment_id = 1
The ID of the experiment.
message
experiment.proto:242Response to DeleteExperimentRequest.
(message has no fields)
Get the best searcher validation for an experiment by the given metric.
message
experiment.proto:269Get the best searcher validation.
int32 experiment_id = 1
The ID of the experiment.
message
experiment.proto:274Response to GetBestSearcherValidationMetricRequest.
float metric = 1
The value of the metric.
Get a list of checkpoints for an experiment.
message
experiment.proto:527Get a list of checkpoints for an experiment.
int32 id = 1
The experiment id.
oneof sort_by
Sort checkpoints by the given field.
checkpoint.v1.SortBy sort_by_attr = 2
Sort by preset checkpoint attribute.
string sort_by_metric = 3
Sort by custom validation metric name.
OrderBy order_by = 4
Order checkpoints in either ascending or descending order.
int32 offset = 5
Skip the number of checkpoints before returning results. Negative values denote number of checkpoints to skip from the end before returning results.
int32 limit = 6
Limit the number of checkpoints. A value of 0 denotes no limit.
repeated checkpoint.v1.State states = 7
Limit the checkpoints to those that match the states.
message
experiment.proto:550Response to GetExperimentCheckpointsRequest.
repeated checkpoints = 1
The list of returned checkpoints.
optional pagination = 2
Pagination information of the full dataset.
rpc PutExperimentLabel (, )
api.proto:732Put a new label on the experiment.
message
experiment.proto:191Request for adding a new experiment label.
int32 experiment_id = 1
The ID of the experiment.
string label = 2
The label to add.
message
experiment.proto:204Response to PutExperimentLabelRequest.
repeated string labels = 1
The complete list of labels associated with the experiment.
rpc DeleteExperimentLabel (, )
api.proto:743Delete a label from the experiment.
message
experiment.proto:214Request for deleting an experiment label.
int32 experiment_id = 1
The ID of the experiment.
string label = 2
The label to delete.
message
experiment.proto:227Response to DeleteExperimentLabelRequest.
repeated string labels = 1
The complete list of labels associated with the experiment.
rpc PreviewHPSearch (, )
api.proto:754Preview hyperparameter search.
message
experiment.proto:280Preview hyperparameter search.
optional config = 1
The experiment config to simulate.
uint32 seed = 2
The searcher simulation seed.
message
experiment.proto:287Response to PreviewSearchRequest.
optional summary = 1
The resulting summary.
rpc GetExperimentTrials (, )
api.proto:766Get the list of trials for an experiment.
message
trial.proto:229Get the list of trials for an experiment.
GetExperimentTrialsRequest.SortBy sort_by = 1
Sort trials by the given field.
OrderBy order_by = 2
Order trials in either ascending or descending order.
int32 offset = 3
Skip the number of trials before returning results. Negative values denote number of trials to skip from the end before returning results.
int32 limit = 4
Limit the number of trials. A value of 0 denotes no limit.
repeated experiment.v1.State states = 5
Limit trials to those that match the provided state.
int32 experiment_id = 6
Limit trials to those that are owned by the specified experiments.
message
trial.proto:278Response to GetExperimentTrialsRequest.
repeated trials = 1
The list of returned trials.
optional pagination = 2
Pagination information of the full dataset.
Get the list of trials for an experiment.
message
trial.proto:289Get the remaining log retention days for a trial id.
int32 id = 1
The trial id.
message
trial.proto:295Response to GetTrialRemainingLogRetentionDaysRequest.
optional int32 remaining_days = 1
The remaining log retention days for the trial id.
rpc CompareTrials (, )
api.proto:790Return a downsampled time series of metrics from multiple trials to compare them side-by-side.
message
trial.proto:445Get time-series downsampled metrics from multiple trials.
repeated int32 trial_ids = 1
The requested trial ids.
int32 max_datapoints = 2
The maximum number of data points to return after downsampling.
repeated string metric_names = 3
The names of selected metrics.
int32 start_batches = 4
Sample from metrics after this batch number.
int32 end_batches = 5
Sample from metrics before this batch number.
MetricType metric_type = 6
Metric group.
string group = 11
Metric group (training, validation, etc).
repeated string metric_ids = 9
metric ids for the query. must be in the form group.metric_name.
optional time_series_filter = 10
The metric and range filter for a time series
message
trial.proto:485Response to CompareTrialsRequest.
repeated trials = 1
A list of objects containing trial and metrics information.
rpc ReportTrialSourceInfo (, )
api.proto:800Reports a TrialSourceInfo entry for tracking inference or fine-tuning runs
message
trial.proto:876Create a TrialSourceInfo
optional trial_source_info = 1
Type of the TrialSourceInfo
message
trial.proto:885Response to making a TrialSourceInfo
int32 trial_id = 1
Trial ID of the created
string checkpoint_uuid = 2
UUID of the checkpoint.
rpc CreateTrial (, )
api.proto:812Create unmanaged trial.
message
trial.proto:805Response to CreateTrialRequest.
optional trial = 1
The requested trial.
rpc PutTrial (, )
api.proto:823Put a trial.
message
trial.proto:814Put a trial.
optional create_trial_request = 1
CreateTrialRequest payload.
string external_trial_id = 41
External trial id.
message
trial.proto:823Response to PutTrialRequest.
optional trial = 1
The requested trial.
rpc PatchTrial (, )
api.proto:834Patch (an unmanaged) trial.
message
trial.proto:832Patch a trial.
int32 trial_id = 1
Trial id.
optional trial.v1.State state = 2
The state of the trial.
message
trial.proto:843Response to PatchTrialRequest.
optional trial = 1
The requested trial.
rpc StartTrial (, )
api.proto:845Start (an unmanaged) trial.
message
trial.proto:852Start a trial.
int32 trial_id = 1
Trial id.
bool resume = 2
Whether resume is allowed.
message
trial.proto:863Response to StartTrialRequest.
int32 trial_run_id = 1
Trial run id.
optional string latest_checkpoint = 2
Latest checkpoint.
int32 steps_completed = 3
Steps completed.
rpc RunPrepareForReporting (, )
api.proto:857Start syncing and prepare to be able to report to a run. This should be called once per task that will report to the run.
message
run.proto:12Request to prepare to start reporting to a run.
int32 run_id = 1
RunID to sync to.
optional checkpoint_storage = 2
Checkpoint storage config.
message
run.proto:22Response to prepare to start reporting to a run.
optional int32 storage_id = 1
The storage_id to be used when creating new checkpoints. This will be returned always when checkpoint storage is set in the request.
rpc GetTrial (, )
api.proto:869Get a single trial.
message
trial.proto:301Get trial details.
int32 trial_id = 1
The requested trial's id.
message
trial.proto:306Response to GetTrialRequest.
optional trial = 1
The requested trial.
rpc GetTrialByExternalID (, )
api.proto:879Get a single trial by external id.
message
trial.proto:315Get trial details by external experiment and trial ids.
string external_experiment_id = 1
External experiment id.
string external_trial_id = 2
External trial id.
message
trial.proto:323Response to GetTrialByExternalIDRequest.
optional trial = 1
The requested trial.
rpc GetTrialWorkloads (, )
api.proto:890Get the list of workloads for a trial.
message
trial.proto:332Get the list of workloads for a trial.
OrderBy order_by = 1
Order workloads in either ascending or descending order.
int32 offset = 2
Skip the number of workloads before returning results. Negative values denote number of workloads to skip from the end before returning results.
int32 limit = 3
Limit the number of workloads. A value of 0 denotes no limit.
int32 trial_id = 4
Limit workloads to those that are owned by the specified trial.
string sort_key = 5
Sort workloads by batches, a training metric, or a validation metric.
GetTrialWorkloadsRequest.FilterOption filter = 6
Filter workloads with validation and/or checkpoint information.
bool include_batch_metrics = 7
Include per-batch metrics.
MetricType metric_type = 8
When sorting workloads by sort_key, specify training or validation form of a metric.
string group = 9
Metric group (training, validation, etc).
bool remove_deleted_checkpoints = 10
Remove deleted checkpoints.
message
trial.proto:373Response to GetTrialWorkloadsRequest.
repeated workloads = 1
The list of returned workloads.
optional pagination = 2
Pagination information of the full dataset.
rpc TrialLogs (, stream )
api.proto:900Stream trial logs.
message
trial.proto:94Stream trial logs.
int32 trial_id = 1
The id of the trial.
int32 limit = 4
Limit the number of trial logs. A value of 0 denotes no limit.
bool follow = 5
Continue following logs until the trial stops.
repeated string agent_ids = 6
Limit the trial logs to a subset of agents.
repeated string container_ids = 7
Limit the trial logs to a subset of containers.
repeated int32 rank_ids = 8
Limit the trial logs to a subset of ranks.
repeated log.v1.LogLevel levels = 9
Limit the trial logs to a subset of agents.
repeated string stdtypes = 10
Limit the trial logs to a subset of output streams.
repeated string sources = 11
Limit the trial logs to a subset of sources.
optional timestamp_before = 12
Limit the trial logs to ones with a timestamp before a given time.
optional timestamp_after = 13
Limit the trial logs to ones with a timestamp after a given time.
OrderBy order_by = 14
Order logs in either ascending or descending order by timestamp.
string search_text = 15
Search the logs by whether the text contains a substring.
bool enable_regex = 16
Search text is regex. Default to false.
message
trial.proto:129Response to TrialLogsRequest.
string id = 1
The ID of the trial log.
optional timestamp = 2
The timestamp of the log.
string message = 3
The flat version of the log that UIs have shown historically.
log.v1.LogLevel level = 4
The level of the log.
int32 trial_id = 5
The ID of the trial associated with this log entry.
optional string agent_id = 6
The ID of the agent that logged this.
optional string container_id = 7
The ID of the container or, in the case of k8s, the pod name.
optional int32 rank_id = 8
The rank ID.
optional string log = 9
The text of the log entry.
optional string source = 10
The source of the log entry.
optional string stdtype = 11
The output stream (e.g. stdout, stderr).
rpc TrialLogsFields (, stream )
api.proto:910Stream trial log fields.
message
trial.proto:160Stream distinct trial log fields.
int32 trial_id = 1
The ID of the trial.
bool follow = 2
Continue following fields until the trial stops.
message
trial.proto:171Response to TrialLogFieldsRequest.
repeated string agent_ids = 1
The distinct agent IDs present in the logs.
repeated string container_ids = 2
The distinct container IDs present in the logs.
repeated int32 rank_ids = 3
The distinct rank IDs present in the logs.
repeated string stdtypes = 4
The distinct stdtypes present in the logs.
repeated string sources = 5
The distinct sources present in the logs.
rpc AllocationReady (, )
api.proto:921Set allocation to ready state.
message
task.proto:116Mark the given task as ready.
string allocation_id = 1
The id of the allocation.
message
task.proto:121Response to AllocationReadyRequest.
(message has no fields)
rpc GetAllocation (, )
api.proto:932Get details about an Allocation.
message
task.proto:270Gets some allocation.
string allocation_id = 1
The id of the allocation.
message
task.proto:278Response to GetAllocationRequest
optional allocation = 1
The id of the allocation.
rpc AllocationWaiting (, )
api.proto:941Set allocation to waiting state.
message
task.proto:124Mark the given task as waiting.
string allocation_id = 1
The id of the allocation.
message
task.proto:129Response to AllocationWaitingRequest.
(message has no fields)
rpc PostTaskLogs (, )
api.proto:953Persist the given task logs.
message
task.proto:83Request to PostTaskLogs.
repeated logs = 1
The logs to persist.
message
task.proto:92Response to PostTaskLogs.
(message has no fields)
rpc TaskLogs (, stream )
api.proto:964Stream task logs.
message
task.proto:132Stream task logs.
string task_id = 1
The id of the task.
int32 limit = 4
Limit the number of trial logs. A value of 0 denotes no limit.
bool follow = 5
Continue following logs until the trial stops.
repeated string allocation_ids = 6
Limit the task logs to particular allocations.
repeated string agent_ids = 7
Limit the trial logs to a subset of agents.
repeated string container_ids = 8
Limit the trial logs to a subset of containers.
repeated int32 rank_ids = 9
Limit the trial logs to a subset of ranks.
repeated log.v1.LogLevel levels = 10
Limit the trial logs to a subset of agents.
repeated string stdtypes = 11
Limit the trial logs to a subset of output streams.
repeated string sources = 12
Limit the trial logs to a subset of sources.
optional timestamp_before = 13
Limit the trial logs to ones with a timestamp before a given time.
optional timestamp_after = 14
Limit the trial logs to ones with a timestamp after a given time.
OrderBy order_by = 15
Order logs in either ascending or descending order by timestamp.
string search_text = 16
Search the logs by whether the text contains a substring.
bool enable_regex = 17
Search text is regex. Default to false.
message
task.proto:169Response to TaskLogsRequest.
string id = 1
The ID of the log.
optional timestamp = 2
The timestamp of the log.
string message = 3
The flat version of the log that UIs have shown historically.
log.v1.LogLevel level = 4
The level of the log.
string task_id = 5
The ID of the task.
optional string allocation_id = 6
The ID of the allocation.
optional string agent_id = 7
The agent the logs came from.
optional string container_id = 8
The ID of the container or, in the case of k8s, the pod name.
optional int32 rank_id = 9
The rank ID.
string log = 10
The text of the log entry.
optional string source = 11
The source of the log entry.
optional string stdtype = 12
The output stream (e.g. stdout, stderr).
rpc TaskLogsFields (, stream )
api.proto:973Stream task log fields.
message
task.proto:202Stream distinct task log fields.
string task_id = 1
The ID of the task.
bool follow = 2
Continue following fields until the task stops.
message
task.proto:213Response to TaskLogsFieldsRequest.
repeated string allocation_ids = 1
The distint allocation IDs present in the logs.
repeated string agent_ids = 2
The distinct agent IDs present in the logs.
repeated string container_ids = 3
The distinct container IDs present in the logs.
repeated int32 rank_ids = 4
The distinct rank IDs present in the logs.
repeated string stdtypes = 5
The distinct stdtypes present in the logs.
repeated string sources = 6
The distinct sources present in the logs.
rpc GetTrialProfilerMetrics (, stream )
api.proto:983Stream trial profiler metrics.
message
trial.proto:384Stream trial profiler metrics.
optional labels = 1
The labels for the series requested.
bool follow = 2
Continue streaming metrics until the trial stops. Defaults to False.
message
trial.proto:394Response to TrialProfilerMetricsResponse
optional batch = 1
A batch matching the series requested.
rpc GetTrialProfilerAvailableSeries (, stream )
api.proto:993Stream the available series in a trial's profiler metrics.
message
trial.proto:403Stream distinct available profiler metric label sets.
int32 trial_id = 1
The requested trial's id.
bool follow = 2
Continue streaming labels until the trial stops. Defaults to False.
message
trial.proto:413Response to TrialProfilerAvailableSeriesRequest.
repeated labels = 1
The labels for the series.
Persist the given TrialProfilerMetricsBatch. The trial ID is in the labels.
message
trial.proto:422Create a batch of trial profiler metrics.
repeated batches = 1
The batches to create.
message
trial.proto:430Response to PostTrialProfilerMetricsBatchRequest
(message has no fields)
rpc GetMetrics (, stream )
api.proto:1014Stream one or more trial's metrics.
message
trial.proto:734Stream training metrics.
repeated int32 trial_ids = 1
Trial IDs to get metrics for.
string group = 2
The group of metrics to get eg 'training', 'validation', etc.
message
trial.proto:752Response to GetMetricsRequest.
repeated metrics = 1
Metric response.
rpc GetTrainingMetrics (, stream )
api.proto:1023Stream one or more trial's training metrics.
message
trial.proto:761Stream training metrics.
repeated int32 trial_ids = 1
Trial IDs to get metrics for.
message
trial.proto:769Response to GetTrainingMetricsRequest.
repeated metrics = 1
Metric response.
rpc GetValidationMetrics (, stream )
api.proto:1033Stream one or more trial's validation metrics.
message
trial.proto:778Stream validation metrics.
repeated int32 trial_ids = 1
Trial IDs to get metrics for.
message
trial.proto:786Response to GetTrainingMetricsRequest.
repeated metrics = 1
Metric response.
rpc KillTrial (, )
api.proto:1044Kill a trial.
message
trial.proto:221Kill an trial.
int32 id = 1
The trial id
message
trial.proto:226Response to KillTrialRequest.
(message has no fields)
rpc GetTrialCheckpoints (, )
api.proto:1054Get a list of checkpoints for a trial.
message
trial.proto:188Get a list of checkpoints for a trial.
int32 id = 1
The trial id.
oneof sort_by
Sort checkpoints by the given field.
checkpoint.v1.SortBy sort_by_attr = 2
Sort by preset checkpoint attribute.
string sort_by_metric = 3
Sort by custom validation metric name.
OrderBy order_by = 4
Order checkpoints in either ascending or descending order.
int32 offset = 5
Skip the number of checkpoints before returning results. Negative values denote number of checkpoints to skip from the end before returning results.
int32 limit = 6
Limit the number of checkpoints. A value of 0 denotes no limit.
repeated checkpoint.v1.State states = 7
Limit the checkpoints to those that match the states.
message
trial.proto:210Response to GetTrialCheckpointsRequest.
repeated checkpoints = 1
The list of returned checkpoints.
optional pagination = 2
Pagination information of the full dataset.
rpc CleanupLogs (, )
api.proto:1065Cleanup task logs according to the retention policy.
message
master.proto:247Get telemetry information.
(message has no fields)
message
master.proto:249Response to CleanupLogsRequest.
int64 removed_count = 1
How many row of logs were removed.
Long poll preemption signals for the given allocation. If the allocation has been preempted when called, it will return so immediately. Otherwise, the connection will be kept open until the timeout is reached or the allocation is preempted.
message
trial.proto:494Long poll for updates to the preemption status for an allocation.
string allocation_id = 1
The id of the allocation.
int32 timeout_seconds = 2
The timeout in seconds.
message
trial.proto:504Response to AllocationPreemptionSignalRequest.
bool preempt = 1
True if signaling preempt, otherwise just a synchronization marker.
Report the receipt of a signal to stop the given allocation early. This is used to communicate back from a SLURM job that it has been notified of a pending preememption. Upon a call to this API the RM should then trigger a checkpoint and immediate exit.
message
trial.proto:517Allocation has been notified of a pending preemption
string allocation_id = 1
The id of the allocation.
message
trial.proto:526Response to AllocationPendingPreemptionSignalRequest
(message has no fields)
Acknowledge the receipt of a signal to stop the given allocation early. This is used indicate and exit 0 isn't final; specifically, it is used for HP search directed early stops and preemption signals (not necessarily just scheduler preemption).
message
trial.proto:509Acknowledge the receipt of some stop signal.
string allocation_id = 1
The allocation that is acknowledging the request.
message
trial.proto:529Response to AckAllocationPreemptionSignalRequest.
(message has no fields)
Mark the given reservation (container, pod, etc) within an allocation as a daemon reservation. In the exit of a successful exit, Determined will wait for all resources to exit - unless they are marked as daemon resources, in which case Determined will clean them up regardless of exit status after all non-daemon resources have exited.
message
trial.proto:532Mark some reservation as a daemon.
string allocation_id = 1
The id of the allocation.
string resources_id = 2
The id of the clump of resources to mark as daemon.
message
trial.proto:542Response to MarkAllocationResourcesDaemonRequest.
(message has no fields)
Gather an allocation's rendezvous info. Blocks until all trial containers connect to gather their rendezvous information and responds to them all at once.
message
trial.proto:545Gathers the rendezvous info for an allocation.
string allocation_id = 1
The id of the allocation.
string resources_id = 2
The id of the clump of resources.
message
trial.proto:555Response to AllocationRendezvousInfoRequest
optional rendezvous_info = 1
The rendezvous information.
PostAllocationProxyAddress sets the proxy address to use when proxying to services provided by an allocation. Upon receipt, the master will also register any proxies specified by the task.
message
trial.proto:564Set the proxy address for some allocation.
string allocation_id = 1
The id of the allocation.
string proxy_address = 2
The address of the host where the service is, w.r.t. the master.
message
trial.proto:571Response to PostAllocationProxyAddressRequest
(message has no fields)
rpc GetTaskAcceleratorData (, )
api.proto:1159GetTaskAcceleratorData gets the accelerator data for each allocation associated with a task.
message
task.proto:253Get the accelerator data for each allocation associated with a task.
string task_id = 1
The id of the task.
message
task.proto:261Response to GetTaskAcceleratorDataResponse
repeated accelerator_data = 1
The accelerator data for each allocation associated with the task.
PostAllocationAcceleratorData sets the accelerator for a given allocation.
message
trial.proto:574Set the accelerator data for some allocation.
string allocation_id = 1
The id of the allocation.
optional accelerator_data = 2
The accelerator data used by the allocation.
message
trial.proto:584Response to PostAllocationAcceleratorDataRequest
(message has no fields)
rpc AllocationAllGather (, )
api.proto:1183AllocationAllGather performs an all gather through the master. An allocation can only perform once all gather at a time.
message
trial.proto:605Arguments to an all gather.
string allocation_id = 1
The ID of the allocation.
string request_uuid = 2
The UUID of the participant in an all gather.
int32 num_peers = 3
The number of process to wait for.
optional data = 4
The data from this process.
message
trial.proto:619Response to AllocationAllGatherResponse
repeated data = 1
The data for all the processes.
rpc NotifyContainerRunning (, )
api.proto:1200NotifyContainterRunning is used to notify the master that the container is running. On HPC, the launcher will report a state of "Running" as soon as Slurm starts the job, but the container may be in the process of getting pulled down from the Internet, so the experiment is not really considered to be in a "Running" state until all the containers that are part of the experiment are running and not being pulled.
message
trial.proto:628Arguments to a notify container running.
string allocation_id = 1
The ID of the allocation.
string request_uuid = 2
The UUID of the participant in a notify container running message.
int32 num_peers = 3
The number of process to wait for.
int32 rank = 4
The container's rank.
string node_name = 5
The name of the node who sent the request
optional data = 6
The data from this process.
message
trial.proto:646Response to NotifyContainerRunningResponse
repeated data = 1
The data for all the processes.
Reports to the searcher that the trial has completed the current requested amount of training with the given searcher validation metric.
message
trial.proto:655Report a voluntary, permanent early exit to the searcher.
int32 trial_id = 1
The id of the trial.
optional early_exit = 2
The exit reason.
message
trial.proto:665Response to ReportTrialSearcherEarlyExitRequest
(message has no fields)
rpc ReportTrialProgress (, )
api.proto:1226For bookkeeping, updates the progress towards to current requested searcher training length.
message
trial.proto:669For bookkeeping, updates the progress of the trial as a percent torwards the training length requested of it by the searcher.
int32 trial_id = 1
The id of the trial.
double progress = 2
Total units completed by the trial, in terms of the unit used to configure the searcher.
bool is_raw = 3
Indicator for if the passed progress is raw and we want to skip any calculation by searcher. Default to false.
message
trial.proto:683Response to ReportTrialProgressRequest
(message has no fields)
For bookkeeping, update trial runner metadata (currently just state).
message
trial.proto:721Partially update the trial metadata.
int32 trial_id = 1
The id of the trial.
optional metadata = 2
The state for the trial runner.
message
trial.proto:731Response to PatchTrialMetadataRequest
(message has no fields)
rpc ReportTrialMetrics (, )
api.proto:1248Record metrics for specified trial.
message
trial.proto:686Persist the given metrics for the trial.
optional metrics = 1
The metrics to persist.
string group = 2
The type of metrics to persist eg 'training', 'validation', etc.
message
trial.proto:696Response to ReportTrialMetricsRequest
(message has no fields)
Record training metrics for specified training.
message
trial.proto:699Persist the given training metrics for the trial.
optional training_metrics = 1
The training metrics to persist.
message
trial.proto:707Response to ReportTrialTrainingMetricsRequest
(message has no fields)
Record validation metrics.
message
trial.proto:710Persist the given validation metrics for the trial.
optional validation_metrics = 1
The training metrics to persist.
message
trial.proto:718Response to ReportTrialValidationMetricsRequest
(message has no fields)
rpc ReportCheckpoint (, )
api.proto:1283Record a checkpoint.
message
task.proto:232Report the given checkpoint for the task.
optional checkpoint = 1
The training metrics to persist.
message
task.proto:240Response to ReportCheckpointRequest.
(message has no fields)
rpc GetJobs (, )
api.proto:1297Get a list of jobs in queue.
message
job.proto:11Get a list of jobs sorted by number of jobs ahead & job ID.
int32 offset = 10
Pagination offset.
int32 limit = 11
Pagination limit.
string resource_pool = 2
The target resource-pool for agent resource manager.
OrderBy order_by = 3
Order results in either ascending or descending order by the number of jobs ahead.
repeated job.v1.State states = 4
Filter to jobs with states among those given.
message
job.proto:29Response to GetJobsRequest.
optional pagination = 1
Pagination information of the full dataset.
repeated jobs = 2
List of the request jobs.
rpc GetJobsV2 (, )
api.proto:1307Get a list of jobs in queue.
message
job.proto:40Get a list of jobs sorted by number of jobs ahead & job ID.
int32 offset = 10
Pagination offset.
int32 limit = 11
Pagination limit.
string resource_pool = 2
The target resource-pool for agent resource manager.
OrderBy order_by = 3
Order results in either ascending or descending order by the number of jobs ahead.
repeated job.v1.State states = 4
Filter to jobs with states among those given.
message
job.proto:58Response to GetJobsV2Request.
optional pagination = 1
Pagination information of the full dataset.
repeated jobs = 2
List of the requested jobs.
rpc GetJobQueueStats (, )
api.proto:1318Get job queue stats for a resource pool.
message
job.proto:94Get job stats.
repeated string resource_pools = 1
Filter the results based on a set of resource pools.
message
job.proto:99Response to GetJobQueueStatsRequest.
repeated results = 1
List of queue stats per resource pool.
rpc UpdateJobQueue (, )
api.proto:1329Control the job queues.
message
job.proto:71Request to update the job queue.
repeated updates = 1
List of job queue control requests.
message
job.proto:79Response to UpdateJobQueueRequest.
(message has no fields)
rpc GetTemplates (, )
api.proto:1340Get a list of templates.
message
template.proto:13Get a list of templates.
GetTemplatesRequest.SortBy sort_by = 1
Sort templates by the given field.
OrderBy order_by = 2
Order templates in either ascending or descending order.
int32 offset = 3
Skip the number of templates before returning results. Negative values denote number of templates to skip from the end before returning results.
int32 limit = 4
Limit the number of templates. A value of 0 denotes no limit.
string name = 5
Limit templates to those that match the name.
repeated int32 workspace_ids = 6
Limit templates to those that match the workspace id.
message
template.proto:36Response to GetTemplatesRequest.
repeated templates = 1
the list of requested templates.
optional pagination = 2
Pagination information of the full dataset.
rpc GetTemplate (, )
api.proto:1349Get the requested template.
message
template.proto:47Get the requested template.
string template_name = 1
The id of the template.
message
template.proto:52Response to GetTemplateRequest.
optional template = 1
The requested template.
rpc PutTemplate (, )
api.proto:1358Update or create (upsert) the requested template.
message
template.proto:61Update or create (upsert) the requested template.
optional template = 1
The template to put.
message
template.proto:66Response to PutTemplateRequest.
optional template = 1
The updated or created template.
rpc PostTemplate (, )
api.proto:1370Post a new template.
message
template.proto:72Post a new template.
optional template = 1
The template to put.
message
template.proto:77Response to PostTemplateRequest.
optional template = 1
The created template.
rpc PatchTemplateConfig (, )
api.proto:1380Patch template config.
message
template.proto:86Patch the template with the given id.
string template_name = 1
The name of the template.
optional config = 2
The template value.
message
template.proto:96Response to PatchTemplateConfigRequest.
optional template = 1
The updated template.
rpc PatchTemplateName (, )
api.proto:1391Patch template name.
message
template.proto:105Rename a template
string old_name = 1
The current name.
string new_name = 2
The updated name.
message
template.proto:115Response to PatchTemplateNameRequest
optional template = 1
The updated template.
rpc DeleteTemplate (, )
api.proto:1403Delete a template.
message
template.proto:124Delete the template with the given id.
string template_name = 1
The id of the template.
message
template.proto:129Response to DeleteTemplateRequest.
(message has no fields)
rpc GetNotebooks (, )
api.proto:1413Get a list of notebooks.
message
notebook.proto:15Get a list of notebooks.
GetNotebooksRequest.SortBy sort_by = 1
Sort notebooks by the given field.
OrderBy order_by = 2
Order notebooks in either ascending or descending order.
int32 offset = 3
Skip the number of notebooks before returning results. Negative values denote number of notebooks to skip from the end before returning results.
int32 limit = 4
Limit the number of notebooks. A value of 0 denotes no limit.
repeated string users = 5
Limit notebooks to those that are owned by users with the specified usernames.
repeated int32 user_ids = 6
Limit notebooks to those that are owned by users with the specified userIds.
int32 workspace_id = 12
Limit to those within a specified workspace, or 0 for all accessible workspaces.
message
notebook.proto:49Response to GetNotebooksRequest.
repeated notebooks = 1
The list of returned notebooks.
optional pagination = 2
Pagination information of the full dataset.
rpc GetNotebook (, )
api.proto:1422Get the requested notebook.
message
notebook.proto:60Get the requested notebook.
string notebook_id = 1
The id of the notebook.
message
notebook.proto:65Response to GetNotebookRequest.
optional notebook = 1
The requested notebook.
optional config = 2
The notebook config.
rpc IdleNotebook (, )
api.proto:1431Send notebook idle data to master
message
notebook.proto:76Kill the requested notebook if idle.
string notebook_id = 1
The id of the notebook.
bool idle = 2
The value of idle timeout
message
notebook.proto:83Response to IdleNotebookRequest.
(message has no fields)
rpc KillNotebook (, )
api.proto:1441Kill the requested notebook.
message
notebook.proto:86Kill the requested notebook.
string notebook_id = 1
The id of the notebook.
message
notebook.proto:91Response to KillNotebookRequest.
optional notebook = 1
The requested notebook.
rpc SetNotebookPriority (, )
api.proto:1450Set the priority of the requested notebook.
message
notebook.proto:97Set the priority of the requested notebook.
string notebook_id = 1
The id of the notebook.
int32 priority = 2
The new priority.
message
notebook.proto:104Response to SetNotebookPriorityRequest.
optional notebook = 1
The requested notebook.
rpc LaunchNotebook (, )
api.proto:1461Launch a notebook.
message
notebook.proto:110Request to launch a notebook.
optional config = 1
Notebook config (JSON).
string template_name = 2
Template name.
repeated files = 3
The files to run with the command.
bool preview = 4
Preview a launching request without actually creating a Notebook.
int32 workspace_id = 5
Workspace ID. Defaults to 'Uncategorized' workspace if not specified.
message
notebook.proto:123Response to LaunchNotebookRequest.
optional notebook = 1
The requested notebook.
optional config = 2
The config;
repeated LaunchWarning warnings = 3
List of any related warnings.
rpc GetShells (, )
api.proto:1472Get a list of shells.
message
shell.proto:15Get a list of shells.
GetShellsRequest.SortBy sort_by = 1
Sort shells by the given field.
OrderBy order_by = 2
Order shells in either ascending or descending order.
int32 offset = 3
Skip the number of shells before returning results. Negative values denote number of shells to skip from the end before returning results.
int32 limit = 4
Limit the number of shells. A value of 0 denotes no limit.
repeated string users = 5
Limit shells to those that are owned by users with the specified usernames.
repeated int32 user_ids = 6
Limit shells to those that are owned by users with the specified userIds.
int32 workspace_id = 7
Limit to those within a specified workspace, or 0 for all accessible workspaces.
message
shell.proto:47Response to GetShellsRequest.
repeated shells = 1
The list of returned shells.
optional pagination = 2
Pagination information of the full dataset.
rpc GetShell (, )
api.proto:1481Get the requested shell.
message
shell.proto:58Get the requested shell.
string shell_id = 1
The id of the shell.
message
shell.proto:63Response to GetShellRequest.
optional shell = 1
The requested shell.
optional config = 2
The shell config.
rpc KillShell (, )
api.proto:1490Kill the requested shell.
message
shell.proto:74Kill the requested shell.
string shell_id = 1
The id of the shell.
message
shell.proto:79Response to KillShellRequest.
optional shell = 1
The requested shell.
rpc SetShellPriority (, )
api.proto:1499Set the priority of the requested shell.
message
shell.proto:85Set the priority of the requested shell.
string shell_id = 1
The id of the shell.
int32 priority = 2
The new priority.
message
shell.proto:92Response to SetShellPriorityRequest.
optional shell = 1
The requested shell.
rpc LaunchShell (, )
api.proto:1510Launch a shell.
message
shell.proto:98Request to launch a shell.
optional config = 1
Shell config (JSON).
string template_name = 2
Template name.
repeated files = 3
The files to run with the command.
bytes data = 4
Deprecated: Do not use.
int32 workspace_id = 5
Workspace ID. Defaults to 'Uncategorized' workspace if not specified.
message
shell.proto:111Response to LaunchShellRequest.
optional shell = 1
The requested shell.
optional config = 2
The config;
repeated LaunchWarning warnings = 3
List of any related warnings.
rpc GetCommands (, )
api.proto:1521Get a list of commands.
message
command.proto:14Get a list of commands.
GetCommandsRequest.SortBy sort_by = 1
Sort commands by the given field.
OrderBy order_by = 2
Order commands in either ascending or descending order.
int32 offset = 3
Skip the number of commands before returning results. Negative values denote number of commands to skip from the end before returning results.
int32 limit = 4
Limit the number of commands. A value of 0 denotes no limit.
repeated string users = 5
Limit commands to those that are owned by users with the specified usernames.
repeated int32 user_ids = 6
Limit commands to those that are owned by users with the specified userIds.
int32 workspace_id = 7
Limit commands to those within a specific workspace, or 0 for all accessible workspaces.
message
command.proto:47Response to GetCommandsRequest.
repeated commands = 1
The list of returned commands.
optional pagination = 2
Pagination information of the full dataset.
rpc GetCommand (, )
api.proto:1530Get the requested command.
message
command.proto:58Get the requested command.
string command_id = 1
The id of the command.
message
command.proto:63Response to GetCommandRequest.
optional command = 1
The requested command.
optional config = 2
The command config.
rpc KillCommand (, )
api.proto:1539Kill the requested command.
message
command.proto:74Kill the requested command.
string command_id = 1
The id of the command.
message
command.proto:79Response to KillCommandRequest.
optional command = 1
The requested command.
rpc SetCommandPriority (, )
api.proto:1548Set the priority of the requested command.
message
command.proto:85Set the priority of the requested command.
string command_id = 1
The id of the command.
int32 priority = 2
The new priority.
message
command.proto:92Response to SetCommandPriorityRequest.
optional command = 1
The requested command.
rpc LaunchCommand (, )
api.proto:1559Launch a command.
message
command.proto:98Request to launch a command.
optional config = 1
Command config (JSON).
string template_name = 2
Template name.
repeated files = 3
The files to run with the command.
bytes data = 4
Additional data.
int32 workspace_id = 5
Workspace ID. Defaults to the 'Uncategorized' workspace if not specified.
message
command.proto:120Response to LaunchCommandRequest.
optional command = 1
The requested command.
optional config = 2
The config;
repeated LaunchWarning warnings = 3
If the requested slots exceeded the current max available.
rpc GetTensorboards (, )
api.proto:1570Get a list of tensorboards.
message
tensorboard.proto:16Get a list of tensorboards.
GetTensorboardsRequest.SortBy sort_by = 1
Sort tensorboards by the given field.
OrderBy order_by = 2
Order tensorboards in either ascending or descending order.
int32 offset = 3
Skip the number of tensorboards before returning results. Negative values denote number of tensorboards to skip from the end before returning results.
int32 limit = 4
Limit the number of tensorboards. A value of 0 denotes no limit.
repeated string users = 5
Limit tensorboards to those that are owned by users with the specified usernames.
repeated int32 user_ids = 6
Limit tensorboards to those that are owned by users with the specified userIds.
int32 workspace_id = 7
Limit tensorboards to those that are in a specific workspace, or 0 for all accessible workspaces.
message
tensorboard.proto:51Response to GetTensorboardsRequest.
repeated tensorboards = 1
The list of returned tensorboards.
optional pagination = 2
Pagination information of the full dataset.
rpc GetTensorboard (, )
api.proto:1580Get the requested tensorboard.
message
tensorboard.proto:62Get the requested tensorboard.
string tensorboard_id = 1
The id of the tensorboard.
message
tensorboard.proto:67Response to GetTensorboardRequest.
optional tensorboard = 1
The requested tensorboard.
optional config = 2
The config;
rpc KillTensorboard (, )
api.proto:1589Kill the requested tensorboard.
message
tensorboard.proto:78Kill the requested tensorboard.
string tensorboard_id = 1
The id of the tensorboard.
message
tensorboard.proto:83Response to KillTensorboardRequest.
optional tensorboard = 1
The requested tensorboard.
rpc SetTensorboardPriority (, )
api.proto:1599Set the priority of the requested TensorBoard.
message
tensorboard.proto:89Set the priority of the requested TensorBoard.
string tensorboard_id = 1
The id of the TensorBoard.
int32 priority = 2
The new priority.
message
tensorboard.proto:96Response to SetTensorboardPriorityRequest.
optional tensorboard = 1
The requested Tensorboard.
rpc LaunchTensorboard (, )
api.proto:1610Launch a tensorboard.
message
tensorboard.proto:102Request to launch a tensorboard.
repeated int32 experiment_ids = 1
List of source experiment ids.
repeated int32 trial_ids = 2
List of source trial ids.
optional config = 3
Tensorboard config (JSON).
string template_name = 4
Tensorboard template name.
repeated files = 5
The files to run with the command.
int32 workspace_id = 6
Workspace in which to launch tensorboard. Defaults to 'Uncategorized'.
optional filters = 7
Targets all experiments matching filters.
message
tensorboard.proto:119Response to LaunchTensorboardRequest.
optional tensorboard = 1
The requested tensorboard.
optional config = 2
The config;
repeated LaunchWarning warnings = 3
List of any related warnings.
rpc DeleteTensorboardFiles (, )
api.proto:1621Delete tensorboard files.
message
experiment.proto:953Request to delete a tensorboard files.
int32 experiment_id = 1
ID of experiment that the tensorboard files are linked to.
message
experiment.proto:962Response to DeleteTensorboardRequest.
(message has no fields)
rpc GetActiveTasksCount (, )
api.proto:1632Get a count of active tasks.
message
task.proto:95Request a count of active tasks by type.
(message has no fields)
message
task.proto:98Response to GetActiveTasksCountRequest.
int32 commands = 1
The count of commands.
int32 notebooks = 2
The count of notebooks.
int32 shells = 3
The count of shells.
int32 tensorboards = 4
The count of TensorBoards.
rpc GetTask (, )
api.proto:1643Check the status of a requested task.
message
task.proto:49Get the requested task.
string task_id = 1
The requested task id.
message
task.proto:58Response to GetTaskRequest.
optional task = 1
The requested task.
rpc GetTasks (, )
api.proto:1653Get all tasks.
message
task.proto:243Request the information of all tasks.
(message has no fields)
message
task.proto:246Response to GetTasksRequest.
map<string, > allocation_id_to_summary = 1
Information about a task for external display.
rpc GetModel (, )
api.proto:1663Get the requested model.
message
model.proto:14Get the requested model.
string model_name = 2
The name of the model.
message
model.proto:24Response to GetModelRequest.
optional model = 1
The model requested.
rpc PostModel (, )
api.proto:1672Create a model in the registry.
message
model.proto:119Request for creating a model in the registry.
string name = 1
The name of the model.
string description = 2
The description of the model.
optional metadata = 3
The user-defined metadata of the model.
repeated string labels = 4
Labels associated with this model.
optional string workspace_name = 5
The name of the workspace associated with this model.
optional int32 workspace_id = 7
The id of the workspace associated with this model.
string notes = 6
Notes associated with this model.
message
model.proto:140Response to PostModelRequest.
optional model = 1
The model created.
rpc PatchModel (, )
api.proto:1682Patch a model's fields.
message
model.proto:150Request for updating a model in the registry.
optional model = 1
The model desired model fields and values.
string model_name = 3
The name of the model being updated.
message
model.proto:162Response to PatchModelRequest.
optional model = 1
The model created.
rpc ArchiveModel (, )
api.proto:1692Archive a model
message
model.proto:172Request for archiving a model in the registry.
string model_name = 2
The name of the model to archive.
message
model.proto:182Response to ArchiveModelRequest
(message has no fields)
rpc UnarchiveModel (, )
api.proto:1701Unarchive a model
message
model.proto:185Request for un-archiving a model in the registry.
string model_name = 2
The name of the model to un-archive.
message
model.proto:195Response to UnarchiveModelRequest
(message has no fields)
rpc MoveModel (, )
api.proto:1710Move a model into a workspace
message
model.proto:198Request to move a model to a workspace.
string model_name = 1
The target model name.
int32 destination_workspace_id = 2
The workspace id that the model will be stored.
message
model.proto:210Response to MoveModelRequest
(message has no fields)
rpc DeleteModel (, )
api.proto:1720Delete a model
message
model.proto:213Request for deleting a model in the registry.
string model_name = 2
The name of the model to delete.
message
model.proto:223Response to DeleteModelRequest
(message has no fields)
rpc GetModels (, )
api.proto:1729Get a list of models.
message
model.proto:34Get a list of models.
GetModelsRequest.SortBy sort_by = 1
Sort the models by the given field.
OrderBy order_by = 2
Order models in either ascending or descending order.
int32 offset = 3
Skip the number of models before returning results. Negative values denote number of models to skip from the end before returning results.
int32 limit = 4
Limit the number of models. A value of 0 denotes no limit.
string name = 5
Limit the models to those matching or partially-matching the name.
string description = 6
Limit the models to those matching or partially-matching the description.
repeated string labels = 7
Limit the models to those with the following labels.
optional archived = 8
Limit to unarchived models only.
repeated string users = 9
Limit the models to those made by the users with the following usernames.
repeated string workspace_names = 12
Limit models to those that belong to the following workspace names.
repeated int32 user_ids = 11
Limit the models to those made by the users with the following userIds.
int32 id = 10
Limit the models to this model id.
repeated int32 workspace_ids = 13
Limit models to those that belong to the following workspace ids.
message
model.proto:92Response to GetModelsRequest.
repeated models = 1
The list of returned models.
optional pagination = 2
Pagination information of the full dataset.
rpc GetModelLabels (, )
api.proto:1738Get a list of unique model labels (sorted by popularity).
message
model.proto:103Get a list of model labels.
optional int32 workspace_id = 1
Optional workspace ID to limit query for model tags.
message
model.proto:109Response to GetModelLabelsRequest.
repeated string labels = 1
List of labels used across all models.
rpc GetModelVersion (, )
api.proto:1747Get the requested model version.
message
model.proto:226Request for a version of a model in the registry.
string model_name = 3
The name of the model.
int32 model_version_num = 2
Sequential model version number.
message
model.proto:238Response for GetModelVersionRequest.
optional model_version = 1
The model version requested.
rpc GetModelVersions (, )
api.proto:1757Get a list of versions for the requested model.
message
model.proto:248Get a list of versions of the requested model.
GetModelVersionsRequest.SortBy sort_by = 1
Sort the model versions by the given field.
OrderBy order_by = 2
Order model versions in either ascending or descending order.
int32 offset = 3
Skip the number of model versions before returning results. Negative values denote number of models to skip from the end before returning results.
int32 limit = 4
Limit the number of model versions. A value of 0 denotes no limit.
string model_name = 6
The name of the model.
message
model.proto:277Response for GetModelVersionRequest.
optional model = 1
The model requested.
repeated model_versions = 2
The list of returned model versions.
optional pagination = 3
Pagination information of the full dataset.
rpc PostModelVersion (, )
api.proto:1767Create a model version.
message
model.proto:291Request for creating a model version.
string model_name = 8
The name of the model to add this version to.
string checkpoint_uuid = 2
UUID of the checkpoint.
string name = 3
User-friendly name for the model version.
string comment = 4
User-written comment for the model version.
optional metadata = 5
The user-defined metadata of the model version.
repeated string labels = 6
Labels associated with this model version.
string notes = 7
Notes associated with this model version.
message
model.proto:312Response for PostModelVersionRequest.
optional model_version = 1
The model version requested.
rpc PatchModelVersion (, )
api.proto:1779Patch a model version's fields.
message
model.proto:322Request for updating a model version in the registry.
string model_name = 4
The name of the model being updated.
optional model_version = 2
Patch payload.
int32 model_version_num = 3
The model version number being updated.
message
model.proto:338Response to PatchModelVersionRequest.
optional model_version = 1
The model version created.
rpc DeleteModelVersion (, )
api.proto:1791Delete a model version
message
model.proto:348Request for deleting a model version in the registry.
string model_name = 3
The name of the model associated with the model version.
int32 model_version_num = 2
Sequential model version number.
message
model.proto:360Response to DeleteModelVersionRequest
(message has no fields)
Gets the metrics for all trials associated with this model version
message
model.proto:363Request for all metrics related to a given model version
string model_name = 1
The name of the model associated with the model version.
int32 model_version_num = 2
Sequential model version number.
optional trial.v1.TrialSourceInfoType trial_source_info_type = 3
Type of the TrialSourceInfo
optional string metric_group = 4
Metric Group string ("training", "validation", or anything else) (nil means all groups)
message
model.proto:379Response for all metrics related to a given checkpoint
repeated metrics = 1
All the related trials and their metrics
rpc GetCheckpoint (, )
api.proto:1813Get the requested checkpoint.
message
checkpoint.proto:11Get the requested checkpoint.
string checkpoint_uuid = 1
The uuid for the requested checkpoint.
message
checkpoint.proto:17Response to GetCheckpointRequest.
optional checkpoint = 1
The requested checkpoint.
rpc PostCheckpointMetadata (, )
api.proto:1823Update checkpoint metadata.
message
checkpoint.proto:26Request for updating a checkpoints metadata.
optional checkpoint = 1
The desired checkpoint fields and values.
message
checkpoint.proto:32Response to PostCheckpointRequest.
optional checkpoint = 1
The updated checkpoint.
rpc CheckpointsRemoveFiles (, )
api.proto:1835Remove files from checkpoints.
message
checkpoint.proto:38Request to delete files matching globs in checkpoints.
repeated string checkpoint_uuids = 1
The list of checkpoint_uuids for the requested checkpoints.
repeated string checkpoint_globs = 2
The list of checkpoint_globs for the requested checkpoints. If a value is set to the empty string the checkpoint will only have its metadata refreshed.
message
checkpoint.proto:51Response to CheckpointRemoveFilesRequest.
(message has no fields)
rpc PatchCheckpoints (, )
api.proto:1847Update checkpoints. Won't modify checkpoint files.
message
checkpoint.proto:54Request to patch database info about a checkpoint.
repeated checkpoints = 1
List of checkpoints to patch.
message
checkpoint.proto:64Intentionally don't send the updated response for performance reasons.
(message has no fields)
rpc DeleteCheckpoints (, )
api.proto:1859Delete Checkpoints.
message
checkpoint.proto:67Request to Delete the list of checkpoints
repeated string checkpoint_uuids = 1
The list of checkpoint_uuids for the requested checkpoint.
message
checkpoint.proto:76Response to DeleteCheckpointsRequest
(message has no fields)
Gets the metrics for all trials associated with this checkpoint
message
checkpoint.proto:79Request for all metrics related to a given checkpoint
string checkpoint_uuid = 1
UUID of the checkpoint.
optional trial.v1.TrialSourceInfoType trial_source_info_type = 2
Type of the TrialSourceInfo
optional string metric_group = 3
Metric Group string ("training", "validation", or anything else) (nil means all groups)
message
checkpoint.proto:93Response for all metrics related to a given checkpoint
repeated metrics = 1
All the related trials and their metrics
rpc ExpMetricNames (, stream )
api.proto:1882Get the set of metric names recorded for a list of experiments.
message
experiment.proto:656Request for the set of metrics recorded by multiple experiments.
repeated int32 ids = 1
The ids for the experiments.
int32 period_seconds = 2
Seconds to wait when polling for updates.
message
experiment.proto:668Response to ExpMetricNamesRequest.
repeated string searcher_metrics = 1
The names of the searcher metrics.
repeated string training_metrics = 2
List of training metric names.
repeated string validation_metrics = 3
List of validation metric names.
repeated metric_names = 4
List of metric group-name pairs.
rpc MetricBatches (, stream )
api.proto:1894Get the milestones (in batches processed) at which a metric is recorded by an experiment.
message
experiment.proto:693Request the milestones (in batches processed) at which a metric is recorded by an experiment.
int32 experiment_id = 1
The id of the experiment.
string metric_name = 2
A metric name.
MetricType metric_type = 3
The type of metric.
string group = 5
Metric group (training, validation, etc).
int32 period_seconds = 4
Seconds to wait when polling for updates.
message
experiment.proto:715Response to MetricBatchesRequest.
repeated int32 batches = 1
Milestones (in batches processed) at which the specified metric is recorded.
rpc TrialsSnapshot (, stream )
api.proto:1906Get a snapshot of a metric across all trials at a certain point of progress.
message
experiment.proto:722Request metrics from all trials at a point of progress.
int32 experiment_id = 1
The id of the experiment.
string metric_name = 2
A metric name.
MetricType metric_type = 3
The type of metric.
string group = 7
Metric group (training, validation, etc).
int32 batches_processed = 4
The point of progress at which to query metrics.
int32 batches_margin = 5
A range either side of batches_processed to include near-misses.
int32 period_seconds = 6
Seconds to wait when polling for updates.
message
experiment.proto:752Response to TrialsSnapshotRequest
repeated trials = 1
A list of trials.
rpc TrialsSample (, stream )
api.proto:1917Get a sample of the metrics over time for a sample of the trials.
message
experiment.proto:777Request a sample of metrics over time for a sample of trials.
int32 experiment_id = 1
The id of the experiment.
string metric_name = 2
A metric name.
MetricType metric_type = 3
The type of metric.
string group = 9
Metric group (training, validation, etc).
int32 max_trials = 4
Maximum number of trials to fetch data for.
int32 max_datapoints = 5
Maximum number of initial / historical data points.
int32 start_batches = 6
Beginning of window (inclusive) to fetch data for.
int32 end_batches = 7
Ending of window (inclusive) to fetch data for.
int32 period_seconds = 8
Seconds to wait when polling for updates.
message
experiment.proto:807Response to TrialsSampleRequest
repeated trials = 1
A historical or incremental series of data points for the trials.
repeated int32 promoted_trials = 2
IDs of trials that are newly included in the data.
repeated int32 demoted_trials = 3
IDs of trials that are no longer included in the top N trials.
rpc GetResourcePools (, )
api.proto:1927Get a list of all resource pools from the cluster.
message
resourcepool.proto:12Get the list of resource pools from the cluster.
int32 offset = 1
Skip the number of resource pools before returning results. Negative values denote number of resource pools to skip from the end before returning results.
int32 limit = 2
Limit the number of resource pools. A value of 0 denotes no limit.
bool unbound = 3
Indicate whether or not to return unbound pools only.
message
resourcepool.proto:24Response to GetResourcePoolsRequest.
repeated resource_pools = 1
The list of returned resource pools.
optional pagination = 2
Pagination information of the full dataset.
Get a list of all Kubernetes cluster names.
message
master.proto:258Get list of all Kubernetes Cluster Names.
(message has no fields)
message
master.proto:261Response to GetKubernetesResourceManagersRequest.
repeated string resource_managers = 1
List of clusters
rpc ResourceAllocationRaw (, )
api.proto:1949Get a detailed view of resource allocation during the given time period.
message
master.proto:191Get a detailed view of resource allocation during the given time period.
optional timestamp_after = 1
The start of the period to consider.
optional timestamp_before = 2
The end of the period to consider.
message
master.proto:207Response to ResourceAllocationRawRequest.
repeated resource_entries = 1
An entry summarizing one workload.
Get an aggregated view of resource allocation during the given time period.
message
master.proto:213Get an aggregated view of resource allocation during the given time period.
string start_date = 1
The first day to consider (the exact time is midnight UTC at the beginning of the day).
string end_date = 2
The last day to consider (the exact time is midnight UTC at the end of the day).
master.v1.ResourceAllocationAggregationPeriod period = 3
The period over which to perform aggregation.
message
master.proto:236Response to ResourceAllocationAggregatedRequest.
repeated resource_entries = 1
An entry summarizing one workload.
rpc GetWorkspace (, )
api.proto:1972Get the requested workspace.
message
workspace.proto:15Get the requested workspace.
int32 id = 1
The id of the workspace.
message
workspace.proto:25Response to GetWorkspaceRequest.
optional workspace = 1
The workspace requested.
rpc GetWorkspaceProjects (, )
api.proto:1981Get projects associated with a workspace.
message
workspace.proto:35Get a list of projects associated with a workspace.
GetWorkspaceProjectsRequest.SortBy sort_by = 1
Sort the projects by the given field.
OrderBy order_by = 2
Order projects in either ascending or descending order.
int32 offset = 3
Skip the number of projects before returning results. Negative values denote number of projects to skip from the end before returning results.
int32 limit = 4
Limit the number of projects. A value of 0 denotes no limit.
int32 id = 5
The id of the workspace. When id is set to 0, return all projects across the all workspaces.
string name = 6
Limit the projects to those matching the name.
optional archived = 7
Limit the projects to those with an archived status.
repeated string users = 8
Limit the projects to those from particular users, by usernames.
repeated int32 user_ids = 9
Limit the projects to those from particular users, by userIds.
message
workspace.proto:82Response to GetWorkspaceProjectsRequest.
repeated projects = 1
The projects associated with the workspace.
optional pagination = 2
Pagination information of the full dataset.
rpc GetWorkspaces (, )
api.proto:1991Get a list of workspaces.
message
workspace.proto:94Get a list of workspaces.
GetWorkspacesRequest.SortBy sort_by = 1
Sort the workspaces by the given field.
OrderBy order_by = 2
Order workspaces in either ascending or descending order.
int32 offset = 3
Skip the number of workspaces before returning results. Negative values denote number of workspaces to skip from the end before returning results.
int32 limit = 4
Limit the number of workspaces. A value of 0 denotes no limit.
string name = 5
Limit the workspaces to those matching the name (case insensitive).
optional archived = 6
Limit the workspaces to those with an archived status.
repeated string users = 7
Limit the workspaces to those from particular users, by usernames.
repeated int32 user_ids = 9
Limit the workspaces to those from particular users, by userIds.
optional pinned = 8
Limit the workspaces to those with pinned status by the current user.
string name_case_sensitive = 10
Limit the workspaces to those matching the name (case sensitive).
message
workspace.proto:131Response to GetWorkspacesRequest.
repeated workspaces = 1
The list of returned workspaces.
optional pagination = 2
Pagination information of the full dataset.
rpc PostWorkspace (, )
api.proto:2000Create a workspace.
message
workspace.proto:143Request for creating a workspace.
string name = 1
The name of the workspace.
optional agent_user_group = 12
Optional agent host uid and gid override.
optional checkpoint_storage_config = 13
Optional checkpoint storage config.
string default_compute_pool = 14
The name of the default compute pool.
string default_aux_pool = 15
The name of the default aux pool.
map<string, > cluster_namespace_meta = 16
The map of clusters to workspace-namespace metadata (including the workspace-namespace binding and the resource quota placed on the namespace bound to the workspace for a given cluster).
map<string, int32> cluster_quota_pairs = 3
The map of clusters to the resource quota placed on the auto-generated namespace within that cluster (inherently capping the slots available to a workspace).
message
workspace.proto:171Response to PostWorkspaceRequest.
optional workspace = 1
The workspace created.
map<string, > namespace_bindings = 2
The workspace-namespace bindings and resource quotas created.
rpc PatchWorkspace (, )
api.proto:2011Update a workspace.
message
workspace.proto:184Request for updating a workspace.
int32 id = 1
The id of the workspace.
optional workspace = 2
The desired workspace fields and values to update.
message
workspace.proto:196Response to PatchWorkspaceRequest.
optional workspace = 1
The updated workspace.
map<string, > namespace_bindings = 2
The workspace-namespace bindings and resource quotas created.
rpc DeleteWorkspace (, )
api.proto:2021Delete a workspace.
message
workspace.proto:209Request for deleting a workspace.
int32 id = 1
The id of the workspace.
message
workspace.proto:219Response to DeleteWorkspaceRequest.
bool completed = 1
Status of deletion.
rpc ArchiveWorkspace (, )
api.proto:2031Archive a workspace.
message
workspace.proto:347Request for archiving a workspace.
int32 id = 1
The id of the workspace.
message
workspace.proto:357Response to ArchiveWorkspaceRequest.
(message has no fields)
rpc UnarchiveWorkspace (, )
api.proto:2041Unarchive a workspace.
message
workspace.proto:360Request for un-archiving a workspace.
int32 id = 1
The id of the workspace.
message
workspace.proto:370Response to UnarchiveWorkspaceRequest.
(message has no fields)
rpc PinWorkspace (, )
api.proto:2051Pin a workspace.
message
workspace.proto:373Request for pinning a workspace.
int32 id = 1
The id of the workspace.
message
workspace.proto:383Response to PinWorkspaceRequest.
(message has no fields)
rpc UnpinWorkspace (, )
api.proto:2060Unpin a workspace.
message
workspace.proto:386Request for un-pinning a workspace.
int32 id = 1
The id of the workspace.
message
workspace.proto:396Response to UnpinWorkspaceRequest.
(message has no fields)
Bind a namespace to a workspace.
message
workspace.proto:229Request for setting workspace-namespace bindings.
int32 workspace_id = 1
The unique id of the workspace.
map<string, > cluster_namespace_meta = 2
The cluster-namespace pairs used to create workspace-namespace bindings.
message
workspace.proto:242Response for setting workspace-namespace bindings.
map<string, > namespace_bindings = 1
The added workspace-namespace bindings.
rpc SetResourceQuotas (, )
api.proto:2082Set a resource quota for a workspace (within a specific cluster).
message
workspace.proto:253Request to set a resource quota on a workspace (for a specific cluster).
int32 id = 1
The id of the workspace.
map<string, int32> cluster_quota_pairs = 2
A map of cluster to resource-quota pairs used to set GPU request limits on the workspace (for a specific cluster).
message
workspace.proto:267Response for setting the resource quota for a workspace (for a specific cluster).
(message has no fields)
List namespaces bound to a workspace.
message
workspace.proto:291Request for listing namespaces bound to a workspace.
int32 id = 1
The unique id of the workspace.
message
workspace.proto:301Response for listing namespaces bound to a workspace.
map<string, > namespace_bindings = 1
List of workspace-namespace bindings for a given workspace.
Gets the ids of all workspaces that are bound to the default namespace for atleast one cluster.
message
workspace.proto:329Request the ids of all workspaces that are bound to the default namespace for atleast one cluster.
(message has no fields)
message
workspace.proto:332Response to GetUnboundWorkspacesRequest.
repeated int32 workspace_ids = 1
The list of returned workspace ids.
Binds the given workpaces to new auto-created namespaces.
message
workspace.proto:338Request for binding the given workpaces to new auto-created namespaces.
repeated int32 workspace_ids = 1
The list of workspace ids.
message
workspace.proto:344Response to BulkAutoCreateWorkspaceNamespaceBindingsRequest.
(message has no fields)
Deletes workpace namespace bindings.
message
workspace.proto:313Request for deleting workspace namespace bindings.
int32 workspace_id = 1
The unique id of the workspace.
repeated string cluster_names = 2
The names of the clusters to delete the bindings for.
message
workspace.proto:325Response to DeleteWorkspaceNamespaceBindingsRequest.
(message has no fields)
Get Kubernetes Resource Quotas for a workspace by the cluster name.
message
workspace.proto:270Request for listing namespaces bound to a workspace.
int32 id = 1
The unique id of the workspace.
message
workspace.proto:280Response for listing namespaces bound to a workspace.
map<string, double> resource_quotas = 1
List of workspace-namespace bindings for a given workspace.
rpc GetProject (, )
api.proto:2153Get the requested project.
message
project.proto:10Get the requested project.
int32 id = 1
The id of the project.
message
project.proto:20Response to GetProjectRequest.
optional project = 1
The project requested.
rpc GetProjectByKey (, )
api.proto:2162Get the request project by key.
message
project.proto:30Get the requested project by key.
string key = 1
The key of the project.
message
project.proto:40Response to GetProjectByKeyRequest.
optional project = 1
The project requested.
rpc GetProjectColumns (, )
api.proto:2172Get a list of columns for experiment list table.
message
project.proto:60Request for experiment list columns
int32 id = 1
The id of the project.
optional TableType table_type = 2
type of table for project columns
message
project.proto:72Response for experiment list columns
repeated columns = 4
List of columns.
Get metrics range for a project.
message
project.proto:82Request for experiment list metrics ranges
int32 id = 1
The id of the project.
message
project.proto:92Response for experiment list metrics ranges
repeated ranges = 1
List of ranges.
rpc PostProject (, )
api.proto:2193Create a project.
message
project.proto:101Request for creating a project.
string name = 1
The name of the project.
string description = 3
Description of the project.
int32 workspace_id = 4
Id of the associated workspace.
optional string key = 5
Key for the project.
message
project.proto:117Response to PostProjectRequest.
optional project = 1
The project created.
rpc AddProjectNote (, )
api.proto:2203Add a note to a project.
message
project.proto:127Request for adding a note to a project.
optional note = 1
The note to add.
int32 project_id = 2
The id of the project.
message
project.proto:138Response to AddProjectNoteRequest.
repeated notes = 1
The complete list of notes on a project.
rpc PutProjectNotes (, )
api.proto:2213Set project notes.
message
project.proto:148Request for setting project notes.
repeated notes = 1
The complete list of notes.
int32 project_id = 2
The id of the project.
message
project.proto:159Response to PutProjectNotesRequest.
repeated notes = 1
The complete list of notes on a project.
rpc PatchProject (, )
api.proto:2224Update a project.
message
project.proto:169Request for updating a project.
int32 id = 1
The id of the project.
optional project = 2
The desired project fields and values to update.
message
project.proto:181Response to PatchProjectRequest.
optional project = 1
The updated project.
rpc DeleteProject (, )
api.proto:2234Delete a project.
message
project.proto:191Request for deleting a project.
int32 id = 1
The id of the project.
message
project.proto:201Response to DeleteProjectRequest.
bool completed = 1
Status of deletion.
rpc ArchiveProject (, )
api.proto:2243Archive a project.
message
project.proto:226Request for archiving a project.
int32 id = 1
The id of the project.
message
project.proto:236Response to ArchiveProjectRequest.
(message has no fields)
rpc UnarchiveProject (, )
api.proto:2252Unarchive a project.
message
project.proto:239Request for un-archiving a project.
int32 id = 1
The id of the project.
message
project.proto:249Response to UnarchiveProjectRequest.
(message has no fields)
rpc MoveProject (, )
api.proto:2262Move a project into a workspace.
message
project.proto:211Request to move a project into a workspace.
int32 project_id = 1
The id of the project being moved.
int32 destination_workspace_id = 2
The id of the new parent workspace.
message
project.proto:223Response to MoveProjectRequest.
(message has no fields)
rpc MoveExperiment (, )
api.proto:2272Move an experiment into a project.
message
experiment.proto:848Request to move an experiment into a project.
int32 experiment_id = 1
The id of the experiment being moved.
int32 destination_project_id = 2
The id of the new parent project.
message
experiment.proto:860Response to MoveExperimentRequest.
(message has no fields)
rpc MoveExperiments (, )
api.proto:2282Move multiple experiments into a project.
message
experiment.proto:863Request to move an experiment into a project.
repeated int32 experiment_ids = 1
The ids of the experiments being moved.
int32 destination_project_id = 2
The id of the new parent project.
optional filters = 3
Targets all experiments matching filters.
int32 project_id = 4
Project id that the experiments belong to.
message
experiment.proto:881Response to MoveExperimentsRequest.
repeated results = 1
Details on success or error for each experiment.
rpc GetWebhooks (, )
api.proto:2294Get a list of webhooks.
message
webhook.proto:25Get a list of webhooks.
(message has no fields)
message
webhook.proto:28Response to GetWebhooksRequest.
repeated webhooks = 1
The list of returned webhooks.
rpc PatchWebhook (, )
api.proto:2304Update a webhook.
message
webhook.proto:107Request for updating a webhook.
int32 id = 1
The id of the webhook.
optional webhook = 2
The desired webhook fields and values to update.
message
webhook.proto:119Response to PatchWebhookRequest.
(message has no fields)
rpc PostWebhook (, )
api.proto:2316Create a webhook. TODO(???): Simplify req/response structs?
message
webhook.proto:38Request for creating a webhook
optional webhook = 1
The webhook to store.
message
webhook.proto:48Response to PostWebhookRequest.
optional webhook = 1
The webhook created.
rpc DeleteWebhook (, )
api.proto:2327Delete a webhook.
message
webhook.proto:58Request for deleting a webhook.
int32 id = 1
The id of the webhook.
message
webhook.proto:68Response to DeleteWebhookRequest.
(message has no fields)
rpc TestWebhook (, )
api.proto:2337Test a webhook.
message
webhook.proto:71Request for testing a webhook.
int32 id = 1
The id of the webhook.
message
webhook.proto:81Response to TestWebhookRequest.
bool completed = 1
Status of test.
rpc PostWebhookEventData (, )
api.proto:2347Trigger custom trigger of webhooks.
message
webhook.proto:91Request for triggering custom trigger.
optional data = 1
The event data for custom webhook trigger.
int32 experiment_id = 2
The id of the experiment.
int32 trial_id = 3
The id of the trial.
message
webhook.proto:104Response to PostWebhookEventDataRequest.
(message has no fields)
rpc GetGroup (, )
api.proto:2359Get a group by id.
message
group.proto:12GetGroupRequest is the body of the request for the call to get a group by id.
int32 group_id = 1
The id of the group to return.
message
group.proto:22GetGroupResponse is the body of the response for the call to get a group by id.
optional group = 1
The group info
rpc GetGroups (, )
api.proto:2369Search for groups with optional filters.
message
group.proto:32GetGroupsRequest is the body of the request for the call to search for groups.
int32 user_id = 1
The id of the user to use to find groups to which the user belongs.
string name = 2
The group name to use when searching.
int32 offset = 3
Skip the number of groups before returning results. Negative values denote number of groups to skip from the end before returning results.
int32 limit = 4
Limit the number of groups. Required and must be must be <= 500.
message
group.proto:49GetGroupsResponse is the body of the response for the call to search for groups.
repeated groups = 1
The found groups
optional pagination = 2
Pagination information of the full dataset.
rpc CreateGroup (, )
api.proto:2380Create a group with optional members on creation.
message
group.proto:94CreateGroupRequest is the body of the request for the call to create a group.
string name = 1
The name the new group should have
repeated int32 add_users = 2
The ids of users that should be added to the new group
message
group.proto:74CreateGroupResponse is the body of the response for the call to update a group and its members.
optional group = 1
Info about the group after the update succeeded.
rpc UpdateGroup (, )
api.proto:2391Update group info.
message
group.proto:58UpdateGroupRequest is the body of the request for the call to update a group and its members.
int32 group_id = 1
The id of the group
string name = 2
The name of the group
repeated int32 add_users = 3
The user ids of users to add to the group
repeated int32 remove_users = 4
The user ids of users to delete from the group
message
group.proto:84UpdateGroupResponse is the body of the response for the call to update a group and its members.
optional group = 1
Info about the group after the update succeeded.
rpc DeleteGroup (, )
api.proto:2402Remove a group.
message
group.proto:106DeleteGroupRequest is the body of the request for the call to delete a group.
int32 group_id = 1
The id of the group that should be deleted.
message
group.proto:116DeleteGroupResponse is the body of the response for the call to delete a group.
(message has no fields)
rpc GetPermissionsSummary (, )
api.proto:2412List all permissions for the logged in user in all scopes.
message
rbac.proto:14List all permissions for the current user in all parts of the cluster.
(message has no fields)
message
rbac.proto:17Response to GetPermissionsSummaryRequest.
repeated roles = 1
A group of roles in cluster and other scopes.
repeated assignments = 2
Lists of assignments for the cluster and other scopes.
Get groups and users assigned to a given workspace with what roles are assigned.
message
rbac.proto:29Request object for GetGroupsAndUsersAssignedToWorkspace.
int32 workspace_id = 1
ID of workspace getting groups and users.
string name = 2
Name of groups and users to search by. Name filters by group name for groups. Name filters by display name then username if display name is null for users.
message
rbac.proto:39Response object for GetGroupsAndUsersAssignedToWorkspace.
repeated groups = 1
Groups with a role assigned to the given workspace scope. Contains user membership of each group.
repeated users_assigned_directly = 2
Only contains users assigned directly to roles on the workspace scope.
repeated assignments = 3
Roles assigned to workspace with associations between groups and users_assigned_directly with roles.
rpc GetRolesByID (, )
api.proto:2436Get a set of roles with the corresponding IDs.
message
rbac.proto:57Request object for GetRolesByID
repeated int32 role_ids = 1
The ids of the roles to be returned
message
rbac.proto:63Response object for GetRolesByID
repeated roles = 1
The roles requested
rpc GetRolesAssignedToUser (, )
api.proto:2448Get the roles which are assigned to a user.
message
rbac.proto:69Request object for GetRolesAssignedToUser
int32 user_id = 1
The id of the user to search for role assignments for
message
rbac.proto:75Response object for GetRolesAssignedToUser
repeated roles = 1
The roles assigned to the requested user with assignment information.
Get the roles which are assigned to a group.
message
rbac.proto:85Request object for GetRolesAssignedToGroup
int32 group_id = 1
The id of the group to search for role assignments for
message
rbac.proto:91Response object for GetRolesAssignedToGroup
repeated roles = 1
The roles assigned to the requested groups.
repeated assignments = 2
What scope each role is assigned to.
Search for roles assignable to a given scope.
message
rbac.proto:104Request object for SearchRolesAssignableToScope
int32 limit = 1
The maximum number of results to return
int32 offset = 2
The offset to use with pagination
optional workspace_id = 3
The id of the workspace to use if searching for a workspace-assignable role
message
rbac.proto:118Response object for SearchRolesAssignableToScope
optional pagination = 1
pagination information.
repeated roles = 2
the set of roles and all assignments belonging to it.
rpc ListRoles (, )
api.proto:2484ListRoles returns roles and groups/users granted that role.
message
rbac.proto:127ListRolesRequest is the body of the request for the call to search for a role.
int32 offset = 3
the offset for pagination.
int32 limit = 4
the limit for pagination.
message
rbac.proto:139ListRolesResponse is the body of the response for the call to search for a role.
repeated roles = 1
a set of roles and all assignments belonging to it.
optional pagination = 2
pagination information.
rpc AssignRoles (, )
api.proto:2495AssignRoles adds a set of role assignments to the system.
message
rbac.proto:152AssignRolesRequest is the body of the request for the call to grant a user or group a role. It requires group_id, role_id, and either scope_workspace_id or scope_project_id.
repeated group_role_assignments = 1
the set of groups being assigned to a role.
repeated user_role_assignments = 2
the set of users being assigned to a role.
message
rbac.proto:161AssignRolesResponse is the body of the request for the call to grant a user or group a role.
(message has no fields)
rpc RemoveAssignments (, )
api.proto:2506RemoveAssignments removes a set of role assignments from the system.
message
rbac.proto:165RemoveAssignmentsRequest is the body of the request for the call to remove a user or group from a role.
repeated group_role_assignments = 1
the set of groups being removed from a role.
repeated user_role_assignments = 2
the set of users being removed from a role.
message
rbac.proto:174RemoveAssignmentsResponse is the body of the response for teh call to remove a user or group from a role.
(message has no fields)
rpc PostUserActivity (, )
api.proto:2518Patch a user's activity
message
user.proto:212Update user activity.
user.v1.ActivityType activity_type = 1
The type of the activity.
user.v1.EntityType entity_type = 2
The type of the entity.
int32 entity_id = 3
The unique id for the entity
message
user.proto:227Response to PostUserActivityRequest.
(message has no fields)
Get projects by user activity
message
project.proto:252Get projects based on user activity.
int32 limit = 1
Limit number of project entries
message
project.proto:258Response to GetProjectsByUserActivityRequest.
repeated projects = 1
A list of projects
rpc SearchExperiments (, )
api.proto:2541Get experiments with grouping and search syntax
message
experiment.proto:917Request for searching experiments
optional int32 project_id = 1
ID of the project to look at
int32 offset = 2
How many experiments to skip before including in the results
int32 limit = 3
How many results to show
optional string sort = 4
Sort parameters in the format <col1>=(asc|desc),<col2>=(asc|desc)
optional string filter = 5
Filter expression
message
experiment.proto:942Response for searching experiments
repeated experiments = 1
The list of returned experiments.
optional pagination = 2
Pagination information of the full dataset
rpc BindRPToWorkspace (, )
api.proto:2553Bind resource pool to workspace
message
resourcepool.proto:32Bind a resource pool to workspaces
string resource_pool_name = 1
The resource pool name.
repeated int32 workspace_ids = 2
The workspace IDs to be bound to the resource pool.
repeated string workspace_names = 3
The workspace names to be bound to the resource pool.
message
resourcepool.proto:46Bind a resource pool to workspaces response.
(message has no fields)
rpc UnbindRPFromWorkspace (, )
api.proto:2565Unbind resource pool to workspace
message
resourcepool.proto:49Unbind a resource pool to workspaces.
string resource_pool_name = 1
The resource pool name.
repeated int32 workspace_ids = 2
The workspace IDs to be unbound.
repeated string workspace_names = 3
The workspace names to be unbound.
message
resourcepool.proto:63Unbind a resource pool to workspaces response.
(message has no fields)
Overwrite resource pool - workspace bindings
message
resourcepool.proto:66Overwrite and replace the workspaces bound to an RP request.
string resource_pool_name = 1
The resource pool name.
repeated int32 workspace_ids = 2
The new workspace IDs to bind to the resource_pool.
repeated string workspace_names = 3
The new workspace names to bind to the resource_pool.
message
resourcepool.proto:80Overwrite and replace the workspaces bound to an RP response.
(message has no fields)
List all resource pools, bound and unbound, available to a specific workspace
message
workspace.proto:399List the resource pools bound to a workspace.
int32 workspace_id = 1
Workspace ID.
int32 offset = 2
The offset to use with pagination
int32 limit = 3
The maximum number of results to return
message
workspace.proto:413Response to ListWorkspaceRPsRequest.
repeated string resource_pools = 1
List of resource pools bound to the workspace.
optional pagination = 2
Pagination information of the full dataset.
List all workspaces bound to a specific resource pool
message
resourcepool.proto:83List all the workspaces bound to the RP.
string resource_pool_name = 1
Resource pool name.
int32 offset = 2
The offset to use with pagination
int32 limit = 3
The maximum number of results to return
message
resourcepool.proto:97Response to ListWorkspacesBoundToRPRequest.
repeated int32 workspace_ids = 1
List of workspace IDs.
optional pagination = 2
Pagination information of the full dataset.
rpc GetGenericTaskConfig (, )
api.proto:2612Get task config
message
task.proto:287Gets task configuration JSON
string task_id = 1
The id of the task.
message
task.proto:296Response to GetTaskConfigRequest
string config = 1
The config of the task
rpc KillGenericTask (, )
api.proto:2623Kill generic task
message
task.proto:305Kills generic task
string task_id = 1
The id of the task.
bool kill_from_root = 2
Kill entire task tree
message
task.proto:317Response to KillGenericTaskRequest
(message has no fields)
rpc PauseGenericTask (, )
api.proto:2635Pause generic task
message
task.proto:320Pauses generic task
string task_id = 1
The id of the task.
message
task.proto:329Response to PauseGenericTaskRequest
(message has no fields)
rpc UnpauseGenericTask (, )
api.proto:2646Unpause generic task
message
task.proto:332Unpause generic task
string task_id = 1
The id of the task.
message
task.proto:341Response to UnpauseGenericTaskRequest
(message has no fields)
rpc SearchRuns (, )
api.proto:2657Get a list of runs.
message
run.proto:32Get a list of runs.
optional int32 project_id = 1
ID of the project to look at
int32 offset = 2
How many experiments to skip before including in the results
int32 limit = 3
How many results to show
optional string sort = 4
Sort parameters in the format <col1>=(asc|desc),<col2>=(asc|desc)
optional string filter = 5
Filter expression
message
run.proto:45Response to SearchRunsResponse.
repeated runs = 1
The list of returned runs.
optional pagination = 2
Pagination information of the full dataset.
rpc MoveRuns (, )
api.proto:2668Move runs.
message
run.proto:67Request to move the run to a different project.
repeated int32 run_ids = 1
The ids of the runs being moved.
int32 source_project_id = 2
The id of the current parent project.
int32 destination_project_id = 3
The id of the new parent project.
optional string filter = 4
Filter expression
bool skip_multitrial = 5
If true, skip multi-trial experiments for move.
message
run.proto:87Response to MoveRunsRequest.
repeated results = 1
Details on success or error for each run.
rpc KillRuns (, )
api.proto:2679Kill runs.
message
run.proto:97Kill runs.
repeated int32 run_ids = 1
The ids of the runs being killed.
int32 project_id = 2
Project id of the runs being killed.
optional string filter = 3
Filter expression
message
run.proto:109Response to KillRunsResponse.
repeated results = 1
Details on success or error for each run.
rpc DeleteRuns (, )
api.proto:2690Delete a list of runs.
message
run.proto:118Delete runs.
repeated int32 run_ids = 1
The ids of the runs being deleted.
int32 project_id = 2
Project id of the runs being deleted.
optional string filter = 3
Filter expression
message
run.proto:130Response to DeleteRunsResponse.
repeated results = 1
Details on success or error for each run.
rpc ArchiveRuns (, )
api.proto:2701Archive runs.
message
run.proto:139Request to archive the run
repeated int32 run_ids = 1
The ids of the runs being archived.
int32 project_id = 2
The id of the current parent project.
optional string filter = 3
Filter expression
message
run.proto:153Response to ArchiveRunsRequest.
repeated results = 1
Details on success or error for each run.
rpc UnarchiveRuns (, )
api.proto:2712Unarchive runs.
message
run.proto:163Request to unarchive the run
repeated int32 run_ids = 1
The ids of the runs being unarchived.
int32 project_id = 2
The id of the current parent project.
optional string filter = 3
Filter expression
message
run.proto:177Response to UnarchiveRunsRequest.
repeated results = 1
Details on success or error for each run.
rpc PauseRuns (, )
api.proto:2723Pause experiment associated with provided runs.
message
run.proto:187Request to pause the experiment associated witha run.
repeated int32 run_ids = 1
The ids of the runs being moved.
int32 project_id = 2
The id of the project of the runs being paused.
optional string filter = 3
Filter expression
message
run.proto:201Response to PauseRunsRequest.
repeated results = 1
Details on success or error for each run.
rpc ResumeRuns (, )
api.proto:2734Unpause experiment associated with provided runs.
message
run.proto:211Request to unpause the experiment associated witha run.
repeated int32 run_ids = 1
The ids of the runs being moved.
int32 project_id = 2
The id of the project of the runs being unpaused.
optional string filter = 3
Filter expression
message
run.proto:225Response to ResumeRunsRequest.
repeated results = 1
Details on success or error for each run.
rpc GetRunMetadata (, )
api.proto:2745Get run metadata.
message
run.proto:235Request to get the metadata of a run.
int32 run_id = 1
The ID of the run to get metadata for.
message
run.proto:243Response to get the metadata of a run.
optional metadata = 1
The arbitrary metadata of the run.
rpc PostRunMetadata (, )
api.proto:2755Update run metadata.
message
run.proto:249Request to post metadata for a run.
int32 run_id = 1
The ID of the run to post metadata for.
optional metadata = 2
The arbitrary metadata to post.
message
run.proto:259Response to post metadata for a run.
optional metadata = 1
The new metadata of the run.
rpc GetMetadataValues (, )
api.proto:2768Retrieve run metadata values for a given string typed key within a given project.
message
project.proto:264Get metadata values for a given key within a project
string key = 1
Metadata key
int32 project_id = 2
Project id
message
project.proto:272Response to GetMetadataValuesRequest.
repeated string values = 1
A list of metadata values
Add or update workspace task config policies.
message
config_policies.proto:11PutWorkspaceConfigPoliciesRequest sets config policies for the workspace and workload type.
int32 workspace_id = 1
The workspace the config policies apply to. Use global API for global config policies.
string workload_type = 2
The workload type the config policies apply to: EXPERIMENT or NTSC.
string config_policies = 3
The config policies to use. Contains both invariant configs and constraints in yaml or json format.
message
config_policies.proto:31Response to PutWorkspaceConfigPoliciesRequest.
optional config_policies = 1
The config policies saved. Contains both invariant configs and constraints in yaml or json format.
Add or update global task config policies.
message
config_policies.proto:39PutGlobalConfigPoliciesRequest sets global config policies for the workload type.
string workload_type = 1
The workload type the config policies apply to: EXPERIMENT or NTSC.
string config_policies = 2
The config policies to use. Contains both invariant configs and constraints in yaml or json format.
message
config_policies.proto:53Response to PutGlobalConfigPoliciesRequest.
optional config_policies = 1
The config policies saved. Contains both invariant configs and constraints in yaml or json format.
Get workspace task config policies.
message
config_policies.proto:61GetWorkspaceConfigPoliciesRequest lists task config policies for a given workspace and workload type.
int32 workspace_id = 1
The workspace the config policies apply to. Use global API for global config policies.
string workload_type = 2
The workload type the config policies apply to: EXPERIMENT or NTSC.
message
config_policies.proto:75Response to GetWorkspaceConfigPoliciesRequest.
optional config_policies = 1
The current config policies saved for the workspace. Contains both invariant configs and constraints in yaml or json format.
Get global task config policies.
message
config_policies.proto:83GetGlobalConfigPoliciesRequest lists global task config policies for a given workload type.
string workload_type = 1
The workload type the config policies apply to: EXPERIMENT or NTSC.
message
config_policies.proto:93Response to GetGlobalConfigPoliciesRequest.
optional config_policies = 1
The global current config policies saved. Contains both invariant configs and constraints in yaml or json format.
Delete workspace task config policies.
message
config_policies.proto:101DeleteWorkspaceConfigPoliciesRequest is used to delete all task config policies for the workspace and workload type.
int32 workspace_id = 1
The workspace the config policies apply to. Use global API for global config policies.
string workload_type = 2
The workload type the config policies apply to: EXPERIMENT or NTSC.
message
config_policies.proto:115Response to DeleteWorkspaceConfigPoliciesRequest.
(message has no fields)
Delete global task config policies.
message
config_policies.proto:119DeleteGlobalConfigPoliciesRequest is used to delete all global task config policies for the workload type.
string workload_type = 1
The workload type the config policies apply to: EXPERIMENT or NTSC.
message
config_policies.proto:129Response to DeleteGlobalConfigPoliciesRequest.
(message has no fields)
rpc PostAccessToken (, )
api.proto:2847Create and get a user's access token
message
token.proto:11Create the requested user's accessToken.
int32 user_id = 1
The id of the user.
optional string lifespan = 2
Lifespan expressing how long the token should last. Should be a Go-format duration (e.g. "2s", "4m", "72h".)
string description = 3
Description of the token.
message
token.proto:25Response to PostAccessTokenRequest.
string token = 1
token value string.
int32 token_id = 2
token id.
rpc GetAccessTokens (, )
api.proto:2859Get a list of all access token records.
message
token.proto:33Get access tokens info for admin.
GetAccessTokensRequest.SortBy sort_by = 1
Sort token info by the given field.
OrderBy order_by = 2
Order token info in either ascending or descending order.
int32 offset = 3
Skip the number of projects before returning results. Negative values denote number of projects to skip from the end before returning results.
int32 limit = 4
Limit the number of projects. A value of 0 denotes no limit.
repeated int32 token_ids = 5
Filter on token_ids
string username = 6
Filter by username.
bool show_inactive = 7
Filter by active status.
message
token.proto:74Response to GetAccessTokensRequest.
repeated token_info = 1
List of token information.
optional pagination = 2
Pagination information of the full dataset.
rpc PatchAccessToken (, )
api.proto:2870Patch an access token's mutable fields.
message
token.proto:85Patch user's access token info.
int32 token_id = 1
The id of the token.
optional string description = 2
The requested updated token description.
bool set_revoked = 3
The requested updated token revoke status.
message
token.proto:98Response to PatchAccessTokenRequest.
optional token_info = 1
The updated token information.
message
trial.proto:587Accelerator data for a given allocation
Used in: ,
string container_id = 1
The id of the container.
string allocation_id = 2
The id of the allocation.
string node_name = 3
The name of the node the allocation is on.
string task_id = 4
The id of the agent associated with the allocation.
string accelerator_type = 5
The type of accelerator.
repeated string accelerator_uuids = 6
An array of UUIDs of the accelerators associated with the allocation.
string resource_pool = 7
The name of the resource pool.
message
experiment.proto:343Filters to apply actions to multiple experiments.
Used in: , , , , , , , , ,
string description = 1
Limit experiments to those that match the description.
string name = 2
Limit experiments to those that match the name.
repeated string labels = 3
Limit experiments to those that match the provided labels.
optional archived = 4
Limit experiments to those that are archived.
repeated experiment.v1.State states = 5
Limit experiments to those that match the provided state.
repeated int32 user_ids = 6
Limit experiments to those that are owned by users with the specified userIds.
int32 project_id = 7
Limit experiments to those within a specified project, or 0 for all projects.
repeated int32 excluded_experiment_ids = 8
Experiment ids to exclude when filters are used.
message
master.proto:31Active notice from the server admin.
Used in: ,
string message = 1
Text content of message.
optional start_time = 2
Time to begin showing message.
optional end_time = 3
Time to stop showing message.
optional created_time = 4
Time message was created.
message
trial.proto:49A filter structure to allow for range filters on arbitrary keys
string name = 1
The name of the field on which the filters is applied.
optional filter = 2
The filter to apply to the given column
message
trial.proto:433Container for a requested trial and its metrics.
Used in:
optional trial = 1
The requested trial.
repeated metrics = 2
The downsampled datapoints.
message
experiment.proto:579Request to create a new experiment.
Used as request type in: Determined.CreateExperiment
Used as field type in:
repeated model_definition = 1
Experiment context.
string config = 2
Experiment config (YAML).
bool validate_only = 3
Only validate instead of creating the experiment. A dry run.
int32 parent_id = 4
Parent experiment id.
bool activate = 5
Request to auto-activate the experiment.
int32 project_id = 6
Project id to contain the experiment.
optional string template = 7
Template to use for the experiment.
optional bool unmanaged = 40
Unmanaged experiments are detached.
message
trial.proto:795Create a trial.
Used as request type in: Determined.CreateTrial
Used as field type in:
int32 experiment_id = 2
The id of the parent experiment.
optional hparams = 6
Trial hyperparameters.
bool unmanaged = 40
Currently only unmanaged trials are supported, must be true.
message
experiment.proto:23One datapoint in a series of metrics from a trial in batch.
Used in: ,
int32 batches = 1
Total batches processed by the time this measurement is taken.
optional values = 2
Values of the requested metrics at this point in the trial.
optional time = 3
The time the measurement is taken.
optional double epoch = 4
The epoch this measurement is taken.
message
trial.proto:20DownsampledMetrics captures a metric's name and downsampled data points.
Used in:
repeated data = 1
A possibly down-sampled series of metrics' readings through the progress of the trial.
MetricType type = 3
Metric group (training, validation, or unset).
string group = 4
Metric group (training, validation, etc).
message
experiment.proto:301Message for results of individual experiments in a multi-experiment action.
Used in: , , , , , , , ,
string error = 1
Optional error message.
int32 id = 2
Experiment ID.
Sort token info by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns token info in an unsorted list.
SORT_BY_USER_ID = 1
Returns token info sorted by user id.
SORT_BY_EXPIRY = 2
Returns token info sorted by expiry.
SORT_BY_CREATED_AT = 3
Returns token info sorted by created at.
SORT_BY_TOKEN_TYPE = 4
Returns token info sorted by token type.
SORT_BY_REVOKED = 5
Returns token info sorted by if it is revoked.
SORT_BY_DESCRIPTION = 6
Returns token info sorted by description of token.
Sorts agents by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns agents in an unsorted list.
SORT_BY_ID = 1
Returns agents sorted by id.
SORT_BY_TIME = 2
Returns agents sorted by time.
Sorts commands by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns commands in an unsorted list.
SORT_BY_ID = 1
Returns commands sorted by id.
SORT_BY_DESCRIPTION = 2
Returns commands sorted by description.
SORT_BY_START_TIME = 4
Return commands sorted by start time.
SORT_BY_WORKSPACE_ID = 5
Return commands sorted by workspace_id.
Sorts trials by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns trials in an unsorted list.
SORT_BY_ID = 1
Returns trials sorted by id.
SORT_BY_START_TIME = 4
Return trials sorted by start time.
SORT_BY_END_TIME = 5
Return trials sorted by end time. Trials without end times are returned after trials that are.
SORT_BY_STATE = 6
Return trials sorted by state.
SORT_BY_BEST_VALIDATION_METRIC = 7
Return the trials sorted by the best metric so far, where the metric is specified by `searcher.metric` in the experiment configuration.
SORT_BY_LATEST_VALIDATION_METRIC = 8
Return the trials sorted by the latest metric so far, where the metric is specified by `searcher.metric` in the experiment configuration.
SORT_BY_BATCHES_PROCESSED = 9
Return the trials sorted by the number of batches completed.
SORT_BY_DURATION = 10
Return the trials sorted by the total duration.
SORT_BY_RESTARTS = 11
Return the trials sorted by the number of restarts.
SORT_BY_CHECKPOINT_SIZE = 12
Return the trials sorted by checkpoint size.
SORT_BY_LOG_RETENTION_DAYS = 13
Return the trials sorted by number of log retention days.
Sorts experiments by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns experiments in an unsorted list.
SORT_BY_ID = 1
Returns experiments sorted by id.
SORT_BY_DESCRIPTION = 2
Returns experiments sorted by description.
SORT_BY_START_TIME = 4
Return experiments sorted by start time.
SORT_BY_END_TIME = 5
Return experiments sorted by end time. Experiments without end_time are returned after the ones with end_time.
SORT_BY_STATE = 6
Return experiments sorted by state.
SORT_BY_NUM_TRIALS = 8
Return experiments sorted by number of trials.
SORT_BY_PROGRESS = 9
Return experiments sorted by progress.
SORT_BY_USER = 10
Return experiments sorted by user.
SORT_BY_NAME = 11
Returns experiments sorted by name.
SORT_BY_FORKED_FROM = 12
Returns experiments sorted by originating model.
SORT_BY_RESOURCE_POOL = 13
Returns experiments sorted by resource pool.
SORT_BY_PROJECT_ID = 14
Returns experiments sorted by project.
SORT_BY_CHECKPOINT_SIZE = 15
Returns experiments sorted by checkpoint size.
SORT_BY_CHECKPOINT_COUNT = 16
Returns experiments sorted by checkpoint count.
SORT_BY_SEARCHER_METRIC_VAL = 17
Returns experiments sorted by searcher metric value..
Different kinds of Determined Cloud offerings
Used in:
PRODUCT_UNSPECIFIED = 0
Not a Cloud Community offering
PRODUCT_COMMUNITY = 1
Determined Cloud, Community Edition
Sort models by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns model versions in an unsorted list.
SORT_BY_VERSION = 3
Returns model versions sorted by version number.
SORT_BY_CREATION_TIME = 4
Returns model versions sorted by creation_time.
Sort models by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns models in an unsorted list.
SORT_BY_NAME = 1
Returns models sorted by name.
SORT_BY_DESCRIPTION = 2
Returns models sorted by description.
SORT_BY_CREATION_TIME = 4
Returns models sorted by creation time.
SORT_BY_LAST_UPDATED_TIME = 5
Returns models sorted by last updated time.
SORT_BY_NUM_VERSIONS = 6
Returns models sorted by number of version.
SORT_BY_WORKSPACE = 7
Returns models sorted by workspace name.
Sorts notebooks by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns notebooks in an unsorted list.
SORT_BY_ID = 1
Returns notebooks sorted by id.
SORT_BY_DESCRIPTION = 2
Returns notebooks sorted by description.
SORT_BY_START_TIME = 4
Return notebooks sorted by start time.
SORT_BY_WORKSPACE_ID = 5
Return notebooks sorted by workspace_id
Sorts shells by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns shells in an unsorted list.
SORT_BY_ID = 1
Returns shells sorted by id.
SORT_BY_DESCRIPTION = 2
Returns shells sorted by description.
SORT_BY_START_TIME = 4
Return shells sorted by start time.
SORT_BY_WORKSPACE_ID = 5
Return shells sorted by workspace_id.
Sorts templates by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns templates in an unsorted list.
SORT_BY_NAME = 1
Returns templates sorted by name.
Sorts tensorboards by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns tensorboards in an unsorted list.
SORT_BY_ID = 1
Returns tensorboards sorted by id.
SORT_BY_DESCRIPTION = 2
Returns tensorboards sorted by description.
SORT_BY_START_TIME = 4
Return tensorboards sorted by start time.
SORT_BY_WORKSPACE_ID = 5
Return tensorboards sorted by workspace_id.
Filter workloads with training, validation, and checkpoint information.
Used in:
FILTER_OPTION_UNSPECIFIED = 0
Any workload.
FILTER_OPTION_CHECKPOINT = 1
Only workloads with an associated checkpoint.
FILTER_OPTION_VALIDATION = 2
Only validation workloads.
FILTER_OPTION_CHECKPOINT_OR_VALIDATION = 3
Only validation workloads or ones with an associated checkpoint.
Sort users by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns users in an unsorted list.
SORT_BY_DISPLAY_NAME = 1
Returns users sorted by display name.
SORT_BY_USER_NAME = 2
Returns users sorted by user name.
SORT_BY_ADMIN = 3
Returns users sorted by if they are admin.
SORT_BY_ACTIVE = 4
Returns users sorted by if they are active.
SORT_BY_MODIFIED_TIME = 5
Returns users sorted by modified time.
SORT_BY_NAME = 6
Returns users sorted by username unless display name exist.
SORT_BY_LAST_AUTH_TIME = 7
Returns users sorted by last authenticated time.
SORT_BY_REMOTE = 8
Returns users sorted by local or remote auth.
message
webhook.proto:10Get a single webhook.
int32 webhook_id = 1
The id of the webhook.
message
webhook.proto:16Response to GetWebhookRequest.
optional webhook = 1
The requested Webhook.
Sort associated projects by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns projects in an unsorted list.
SORT_BY_CREATION_TIME = 1
Returns projects sorted by time that they were created.
SORT_BY_LAST_EXPERIMENT_START_TIME = 2
Returns projects sorted by most recent start of an experiment.
SORT_BY_NAME = 3
Returns projects sorted by name.
SORT_BY_DESCRIPTION = 4
Returns projects sorted by description.
SORT_BY_ID = 5
Returns projects sorted by ID.
Sort workspaces by the given field.
Used in:
SORT_BY_UNSPECIFIED = 0
Returns workspaces in an unsorted list.
SORT_BY_ID = 1
Returns workspaces sorted by id.
SORT_BY_NAME = 2
Returns workspaces sorted by name.
Enum values for warnings when launching commands.
Used in: , , , , , ,
LAUNCH_WARNING_UNSPECIFIED = 0
Default value
LAUNCH_WARNING_CURRENT_SLOTS_EXCEEDED = 1
For a default webhook
To distinguish the different categories of metrics.
Used in: , , , , ,
METRIC_TYPE_UNSPECIFIED = 0
Zero-value (not allowed).
METRIC_TYPE_TRAINING = 1
For metrics emitted during training.
METRIC_TYPE_VALIDATION = 2
For metrics emitted during validation.
METRIC_TYPE_PROFILING = 3
For metrics emitted during profiling.
Order records in either ascending or descending order.
Used in: , , , , , , , , , , , , , , , , , , , , ,
ORDER_BY_UNSPECIFIED = 0
Returns records in no specific order.
ORDER_BY_ASC = 1
Returns records in ascending order.
ORDER_BY_DESC = 2
Returns records in descending order.
message
pagination.proto:8Pagination provides information about the offset, limit, and total number of records returned in the results.
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , ,
int32 offset = 1
The number of records skipped before returning results.
int32 limit = 2
The amount of records limited in the results.
int32 start_index = 3
The index of the first record in the dataset.
int32 end_index = 4
The index+1 of the last record in the dataset.
int32 total = 5
The total number of values that match the filter.
message
job.proto:82Job stats for a resource pool.
Used in:
optional stats = 1
Job queue stats.
string resource_pool = 2
Resource pool.
repeated aggregates = 3
Aggregate stats.
message
run.proto:56Message for results of individual runs in a multi-run action.
Used in: , , , , , ,
string error = 1
Optional error message.
int32 id = 2
run ID.
message
master.proto:15Describe one SSO provider.
Used in:
string name = 1
A descriptive name for this provider.
string sso_url = 2
The URL to use for SSO with this provider.
string type = 3
The type of SSO (such as SAML, OIDC).
bool always_redirect = 4
The flag to indicate if this provider should be always be redirected to, instead of showing the standard sign-in page.
message
experiment.proto:931combination of experiment and best trial with metrics
Used in:
optional experiment = 1
The experiment in question
optional best_trial = 2
The best performing trial associated with the experiment
Project Table type.
Used in:
TABLE_TYPE_UNSPECIFIED = 0
Unspecified table type.
TABLE_TYPE_EXPERIMENT = 1
experiment table.
TABLE_TYPE_RUN = 2
run table.
message
trial.proto:69Struct to specify a sorting for trials. Used for both determining sort order for returned trials, and for filtering trials by their rank according to sorter
TrialSorter.Namespace namespace = 1
The namespace for the sort field.
string field = 2
The name of the sort field.
OrderBy order_by = 3
The ordering for the sort.
Namespace for the sort field. corresponds to the different ways to access in the db
Used in:
NAMESPACE_UNSPECIFIED = 0
Namespace for columns in the trials table
NAMESPACE_HPARAMS = 1
Namespace corrspondings to trials->hparams
NAMESPACE_TRAINING_METRICS = 2
Namespace corrspondings to steps->avg_metrics
NAMESPACE_VALIDATION_METRICS = 3
Namespace corrspondings to validations->validation_metrics
message
trial.proto:58Tag for trials. Implemented in such a way to allow easy evolvability into/coexistence with key/values tags
string key = 1
The actual tag.
message
experiment.proto:812Metadata and metrics stream from a trial.
Used in:
int32 trial_id = 1
The id of the trial.
optional hparams = 2
Hyperparamters values for this specific trial.
repeated data = 3
A possibly down-sampled series of metric readings through the progress of the trial.
message
experiment.proto:757Metric value and metadata for a trial that has progress this far.
Used in:
int32 trial_id = 1
The id of the trial.
optional hparams = 2
A dictionary of hyperparameter values for this trial.
double metric = 3
The value of the metric in this trial at this point.
int32 batches_processed = 4
The number of batches processed for this particular datapoint.
message
user.proto:11Message for results of individual users in a multi-user action.
Used in:
string error = 1
Optional error message.
int32 id = 2
User ID.
message
user.proto:156Options to filter a subset of users.
Used in:
string name = 1
Case-insensitive partial match of string to username or display name.
optional bool admin = 2
Matches users with or without an admin flag.
message
trial.proto:35WorkloadContainer is a wrapper for Determined workloads to allow repeated oneof types.
Used in:
oneof workload
workload represent one of Determined workloads: training, validation, or checkpoint.
training = 4
Training workload.
validation = 5
Validation workload.
checkpoint = 6
Checkpoint workload.