package determined.checkpoint.v1
Get desktop application:
View/edit binary Protocol Buffers messages
message
checkpoint.proto:69Checkpoint a collection of files saved by a task.
Used in: , , , , , , ,
string task_id = 1
ID of the task which generated this checkpoint.
optional string allocation_id = 2
ID of the allocation which generated this checkpoint.
string uuid = 3
UUID of the checkpoint.
optional report_time = 4
Timestamp when the checkpoint was reported.
map<string, int64> resources = 5
Dictionary of file paths to file sizes in bytes of all files in the checkpoint.
optional metadata = 6
User defined metadata associated with the checkpoint.
State state = 7
The state of the underlying checkpoint.
optional training = 8
Training-related data for this checkpoint.
optional int32 storage_id = 9
Optional ID that describes where this checkpoint is stored. It will be null on every checkpoint pre 0.27.1. It can also be null when a user does not specify the storageID calling the report API themselves or when users don't provide a storage config to core_context.
message
checkpoint.proto:47CheckpointTrainingMetadata is specifically metadata about training.
Used in:
optional int32 trial_id = 1
The ID of the trial that created this checkpoint.
optional int32 experiment_id = 2
The ID of the experiment that created this checkpoint.
optional experiment_config = 3
The configuration of the experiment that created this checkpoint.
optional hparams = 4
Hyperparameter values for the trial that created this checkpoint.
optional training_metrics = 5
Training metrics reported at the same steps_completed as the checkpoint.
optional validation_metrics = 6
Validation metrics reported at the same steps_completed as the checkpoint.
optional double searcher_metric = 17
Searcher metric (as specified by the expconf) at the same steps_completed of the checkpoint.
message
checkpoint.proto:100Request to change checkpoint database information.
Used in:
string uuid = 1
The uuid of the checkpoint.
optional resources = 2
Dictionary of file paths to file sizes in bytes of all files in the checkpoint. This won't update actual checkpoint files. If len(resources) == 0 => the checkpoint is considered deleted Otherwise if resources are updated the checkpoint is considered partially deleted.
message
checkpoint.proto:107Gets around not being able to do "Optional map<string, int64>". Not ideal but this API is marked internal for now.
Used in:
map<string, int64> resources = 1
Resources.
Sorts options for checkpoints by the given field.
Used in: ,
SORT_BY_UNSPECIFIED = 0
Returns checkpoints in an unsorted list.
SORT_BY_UUID = 1
Returns checkpoints sorted by UUID.
SORT_BY_TRIAL_ID = 2
Returns checkpoints sorted by trial id.
SORT_BY_BATCH_NUMBER = 3
Returns checkpoints sorted by batch number.
SORT_BY_END_TIME = 4
Returns checkpoints sorted by end time.
SORT_BY_STATE = 5
Returns checkpoints sorted by state.
SORT_BY_SEARCHER_METRIC = 6
Returns checkpoints sorted by the experiment's `searcher.metric` configuration setting.
The current state of the checkpoint.
Used in: , , ,
STATE_UNSPECIFIED = 0
The state of the checkpoint is unknown.
STATE_ACTIVE = 1
The checkpoint is in an active state.
STATE_COMPLETED = 2
The checkpoint is persisted to checkpoint storage.
STATE_ERROR = 3
The checkpoint errored.
STATE_DELETED = 4
The checkpoint has been deleted.
STATE_PARTIALLY_DELETED = 5
The checkpoint has been partially deleted.