checkpointv1

package
v0.0.0-...-3511abf Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 2, 2023 License: Apache-2.0 Imports: 9 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "STATE_ACTIVE",
		2: "STATE_COMPLETED",
		3: "STATE_ERROR",
		4: "STATE_DELETED",
		5: "STATE_PARTIALLY_DELETED",
	}
	State_value = map[string]int32{
		"STATE_UNSPECIFIED":       0,
		"STATE_ACTIVE":            1,
		"STATE_COMPLETED":         2,
		"STATE_ERROR":             3,
		"STATE_DELETED":           4,
		"STATE_PARTIALLY_DELETED": 5,
	}
)

Enum value maps for State.

View Source
var (
	SortBy_name = map[int32]string{
		0: "SORT_BY_UNSPECIFIED",
		1: "SORT_BY_UUID",
		2: "SORT_BY_TRIAL_ID",
		3: "SORT_BY_BATCH_NUMBER",
		4: "SORT_BY_END_TIME",
		5: "SORT_BY_STATE",
		6: "SORT_BY_SEARCHER_METRIC",
	}
	SortBy_value = map[string]int32{
		"SORT_BY_UNSPECIFIED":     0,
		"SORT_BY_UUID":            1,
		"SORT_BY_TRIAL_ID":        2,
		"SORT_BY_BATCH_NUMBER":    3,
		"SORT_BY_END_TIME":        4,
		"SORT_BY_STATE":           5,
		"SORT_BY_SEARCHER_METRIC": 6,
	}
)

Enum value maps for SortBy.

View Source
var File_determined_checkpoint_v1_checkpoint_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Checkpoint

type Checkpoint struct {

	// ID of the task which generated this checkpoint.
	TaskId string `protobuf:"bytes,1,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`
	// ID of the allocation which generated this checkpoint.
	AllocationId *string `protobuf:"bytes,2,opt,name=allocation_id,json=allocationId,proto3,oneof" json:"allocation_id,omitempty"`
	// UUID of the checkpoint.
	Uuid string `protobuf:"bytes,3,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Timestamp when the checkpoint was reported.
	ReportTime *timestamp.Timestamp `protobuf:"bytes,4,opt,name=report_time,json=reportTime,proto3" json:"report_time,omitempty"`
	// Dictionary of file paths to file sizes in bytes of all files in the
	// checkpoint.
	Resources map[string]int64 `` /* 160-byte string literal not displayed */
	// User defined metadata associated with the checkpoint.
	Metadata *_struct.Struct `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// The state of the underlying checkpoint.
	State State `protobuf:"varint,7,opt,name=state,proto3,enum=determined.checkpoint.v1.State" json:"state,omitempty"`
	// Training-related data for this checkpoint.
	Training *CheckpointTrainingMetadata `protobuf:"bytes,8,opt,name=training,proto3" json:"training,omitempty"`
	// contains filtered or unexported fields
}

Checkpoint a collection of files saved by a task.

func (*Checkpoint) Descriptor deprecated

func (*Checkpoint) Descriptor() ([]byte, []int)

Deprecated: Use Checkpoint.ProtoReflect.Descriptor instead.

func (*Checkpoint) GetAllocationId

func (x *Checkpoint) GetAllocationId() string

func (*Checkpoint) GetMetadata

func (x *Checkpoint) GetMetadata() *_struct.Struct

func (*Checkpoint) GetReportTime

func (x *Checkpoint) GetReportTime() *timestamp.Timestamp

func (*Checkpoint) GetResources

func (x *Checkpoint) GetResources() map[string]int64

func (*Checkpoint) GetState

func (x *Checkpoint) GetState() State

func (*Checkpoint) GetTaskId

func (x *Checkpoint) GetTaskId() string

func (*Checkpoint) GetTraining

func (x *Checkpoint) GetTraining() *CheckpointTrainingMetadata

func (*Checkpoint) GetUuid

func (x *Checkpoint) GetUuid() string

func (*Checkpoint) ProtoMessage

func (*Checkpoint) ProtoMessage()

func (*Checkpoint) ProtoReflect

func (x *Checkpoint) ProtoReflect() protoreflect.Message

func (*Checkpoint) Reset

func (x *Checkpoint) Reset()

func (*Checkpoint) String

func (x *Checkpoint) String() string

type CheckpointTrainingMetadata

type CheckpointTrainingMetadata struct {

	// The ID of the trial that created this checkpoint.
	TrialId *wrappers.Int32Value `protobuf:"bytes,1,opt,name=trial_id,json=trialId,proto3" json:"trial_id,omitempty"`
	// The ID of the experiment that created this checkpoint.
	ExperimentId *wrappers.Int32Value `protobuf:"bytes,2,opt,name=experiment_id,json=experimentId,proto3" json:"experiment_id,omitempty"`
	// The configuration of the experiment that created this checkpoint.
	ExperimentConfig *_struct.Struct `protobuf:"bytes,3,opt,name=experiment_config,json=experimentConfig,proto3" json:"experiment_config,omitempty"`
	// Hyperparameter values for the trial that created this checkpoint.
	Hparams *_struct.Struct `protobuf:"bytes,4,opt,name=hparams,proto3" json:"hparams,omitempty"`
	// Training metrics reported at the same steps_completed as the checkpoint.
	TrainingMetrics *commonv1.Metrics `protobuf:"bytes,5,opt,name=training_metrics,json=trainingMetrics,proto3" json:"training_metrics,omitempty"`
	// Validation metrics reported at the same steps_completed as the checkpoint.
	ValidationMetrics *commonv1.Metrics `protobuf:"bytes,6,opt,name=validation_metrics,json=validationMetrics,proto3" json:"validation_metrics,omitempty"`
	// Searcher metric (as specified by the expconf) at the same steps_completed
	// of the checkpoint.
	SearcherMetric *wrappers.DoubleValue `protobuf:"bytes,17,opt,name=searcher_metric,json=searcherMetric,proto3" json:"searcher_metric,omitempty"`
	// contains filtered or unexported fields
}

CheckpointTrainingMetadata is specifically metadata about training.

func (*CheckpointTrainingMetadata) Descriptor deprecated

func (*CheckpointTrainingMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CheckpointTrainingMetadata.ProtoReflect.Descriptor instead.

func (*CheckpointTrainingMetadata) GetExperimentConfig

func (x *CheckpointTrainingMetadata) GetExperimentConfig() *_struct.Struct

func (*CheckpointTrainingMetadata) GetExperimentId

func (x *CheckpointTrainingMetadata) GetExperimentId() *wrappers.Int32Value

func (*CheckpointTrainingMetadata) GetHparams

func (x *CheckpointTrainingMetadata) GetHparams() *_struct.Struct

func (*CheckpointTrainingMetadata) GetSearcherMetric

func (x *CheckpointTrainingMetadata) GetSearcherMetric() *wrappers.DoubleValue

func (*CheckpointTrainingMetadata) GetTrainingMetrics

func (x *CheckpointTrainingMetadata) GetTrainingMetrics() *commonv1.Metrics

func (*CheckpointTrainingMetadata) GetTrialId

func (*CheckpointTrainingMetadata) GetValidationMetrics

func (x *CheckpointTrainingMetadata) GetValidationMetrics() *commonv1.Metrics

func (*CheckpointTrainingMetadata) ProtoMessage

func (*CheckpointTrainingMetadata) ProtoMessage()

func (*CheckpointTrainingMetadata) ProtoReflect

func (*CheckpointTrainingMetadata) Reset

func (x *CheckpointTrainingMetadata) Reset()

func (*CheckpointTrainingMetadata) String

func (x *CheckpointTrainingMetadata) String() string

type PatchCheckpoint

type PatchCheckpoint struct {

	// The uuid of the checkpoint.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// 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.
	Resources *PatchCheckpoint_OptionalResources `protobuf:"bytes,2,opt,name=resources,proto3,oneof" json:"resources,omitempty"`
	// contains filtered or unexported fields
}

Request to change checkpoint database information.

func (*PatchCheckpoint) Descriptor deprecated

func (*PatchCheckpoint) Descriptor() ([]byte, []int)

Deprecated: Use PatchCheckpoint.ProtoReflect.Descriptor instead.

func (*PatchCheckpoint) GetResources

func (*PatchCheckpoint) GetUuid

func (x *PatchCheckpoint) GetUuid() string

func (*PatchCheckpoint) ProtoMessage

func (*PatchCheckpoint) ProtoMessage()

func (*PatchCheckpoint) ProtoReflect

func (x *PatchCheckpoint) ProtoReflect() protoreflect.Message

func (*PatchCheckpoint) Reset

func (x *PatchCheckpoint) Reset()

func (*PatchCheckpoint) String

func (x *PatchCheckpoint) String() string

type PatchCheckpoint_OptionalResources

type PatchCheckpoint_OptionalResources struct {

	// Resources.
	Resources map[string]int64 `` /* 160-byte string literal not displayed */
	// contains filtered or unexported fields
}

Gets around not being able to do "Optional map<string, int64>". Not ideal but this API is marked internal for now.

func (*PatchCheckpoint_OptionalResources) Descriptor deprecated

func (*PatchCheckpoint_OptionalResources) Descriptor() ([]byte, []int)

Deprecated: Use PatchCheckpoint_OptionalResources.ProtoReflect.Descriptor instead.

func (*PatchCheckpoint_OptionalResources) GetResources

func (x *PatchCheckpoint_OptionalResources) GetResources() map[string]int64

func (*PatchCheckpoint_OptionalResources) ProtoMessage

func (*PatchCheckpoint_OptionalResources) ProtoMessage()

func (*PatchCheckpoint_OptionalResources) ProtoReflect

func (*PatchCheckpoint_OptionalResources) Reset

func (*PatchCheckpoint_OptionalResources) String

type SortBy

type SortBy int32

Sorts options for checkpoints by the given field.

const (
	// Returns checkpoints in an unsorted list.
	SortBy_SORT_BY_UNSPECIFIED SortBy = 0
	// Returns checkpoints sorted by UUID.
	SortBy_SORT_BY_UUID SortBy = 1
	// Returns checkpoints sorted by trial id.
	SortBy_SORT_BY_TRIAL_ID SortBy = 2
	// Returns checkpoints sorted by batch number.
	SortBy_SORT_BY_BATCH_NUMBER SortBy = 3
	// Returns checkpoints sorted by end time.
	SortBy_SORT_BY_END_TIME SortBy = 4
	// Returns checkpoints sorted by state.
	SortBy_SORT_BY_STATE SortBy = 5
	// Returns checkpoints sorted by the experiment's `searcher.metric`
	// configuration setting.
	SortBy_SORT_BY_SEARCHER_METRIC SortBy = 6
)

func (SortBy) Descriptor

func (SortBy) Descriptor() protoreflect.EnumDescriptor

func (SortBy) Enum

func (x SortBy) Enum() *SortBy

func (SortBy) EnumDescriptor deprecated

func (SortBy) EnumDescriptor() ([]byte, []int)

Deprecated: Use SortBy.Descriptor instead.

func (SortBy) Number

func (x SortBy) Number() protoreflect.EnumNumber

func (SortBy) String

func (x SortBy) String() string

func (SortBy) Type

func (SortBy) Type() protoreflect.EnumType

type State

type State int32

The current state of the checkpoint.

const (
	// The state of the checkpoint is unknown.
	State_STATE_UNSPECIFIED State = 0
	// The checkpoint is in an active state.
	State_STATE_ACTIVE State = 1
	// The checkpoint is persisted to checkpoint storage.
	State_STATE_COMPLETED State = 2
	// The checkpoint errored.
	State_STATE_ERROR State = 3
	// The checkpoint has been deleted.
	State_STATE_DELETED State = 4
	// The checkpoint has been partially deleted.
	State_STATE_PARTIALLY_DELETED State = 5
)

func (State) Descriptor

func (State) Descriptor() protoreflect.EnumDescriptor

func (State) Enum

func (x State) Enum() *State

func (State) EnumDescriptor deprecated

func (State) EnumDescriptor() ([]byte, []int)

Deprecated: Use State.Descriptor instead.

func (State) Number

func (x State) Number() protoreflect.EnumNumber

func (State) String

func (x State) String() string

func (State) Type

func (State) Type() protoreflect.EnumType

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL