experimentv1

package
v0.38.0-rc7 Latest Latest
Warning

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

Go to latest
Published: Nov 4, 2024 License: Apache-2.0 Imports: 8 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_PAUSED",
		3:  "STATE_STOPPING_COMPLETED",
		4:  "STATE_STOPPING_CANCELED",
		5:  "STATE_STOPPING_ERROR",
		6:  "STATE_COMPLETED",
		7:  "STATE_CANCELED",
		8:  "STATE_ERROR",
		9:  "STATE_DELETED",
		10: "STATE_DELETING",
		11: "STATE_DELETE_FAILED",
		12: "STATE_STOPPING_KILLED",
		13: "STATE_QUEUED",
		14: "STATE_PULLING",
		15: "STATE_STARTING",
		16: "STATE_RUNNING",
	}
	State_value = map[string]int32{
		"STATE_UNSPECIFIED":        0,
		"STATE_ACTIVE":             1,
		"STATE_PAUSED":             2,
		"STATE_STOPPING_COMPLETED": 3,
		"STATE_STOPPING_CANCELED":  4,
		"STATE_STOPPING_ERROR":     5,
		"STATE_COMPLETED":          6,
		"STATE_CANCELED":           7,
		"STATE_ERROR":              8,
		"STATE_DELETED":            9,
		"STATE_DELETING":           10,
		"STATE_DELETE_FAILED":      11,
		"STATE_STOPPING_KILLED":    12,
		"STATE_QUEUED":             13,
		"STATE_PULLING":            14,
		"STATE_STARTING":           15,
		"STATE_RUNNING":            16,
	}
)

Enum value maps for State.

View Source
var (
	TrialExitedEarly_ExitedReason_name = map[int32]string{
		0: "EXITED_REASON_UNSPECIFIED",
		1: "EXITED_REASON_INVALID_HP",
		2: "EXITED_REASON_USER_REQUESTED_STOP",
		3: "EXITED_REASON_USER_CANCELED",
	}
	TrialExitedEarly_ExitedReason_value = map[string]int32{
		"EXITED_REASON_UNSPECIFIED":         0,
		"EXITED_REASON_INVALID_HP":          1,
		"EXITED_REASON_USER_REQUESTED_STOP": 2,
		"EXITED_REASON_USER_CANCELED":       3,
	}
)

Enum value maps for TrialExitedEarly_ExitedReason.

View Source
var File_determined_experiment_v1_experiment_proto protoreflect.FileDescriptor
View Source
var File_determined_experiment_v1_searcher_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CloseTrialOperation

type CloseTrialOperation struct {

	// The ID of the trial to close.
	RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

Close a trial with given ID.

func (*CloseTrialOperation) Descriptor deprecated

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

Deprecated: Use CloseTrialOperation.ProtoReflect.Descriptor instead.

func (*CloseTrialOperation) GetRequestId

func (x *CloseTrialOperation) GetRequestId() string

func (*CloseTrialOperation) ProtoMessage

func (*CloseTrialOperation) ProtoMessage()

func (*CloseTrialOperation) ProtoReflect

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

func (*CloseTrialOperation) Reset

func (x *CloseTrialOperation) Reset()

func (*CloseTrialOperation) String

func (x *CloseTrialOperation) String() string

type CreateTrialOperation

type CreateTrialOperation struct {

	// The ID of the trial to create.
	RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// A JSON object representing the hyperparameters.
	Hyperparams string `protobuf:"bytes,2,opt,name=hyperparams,proto3" json:"hyperparams,omitempty"`
	// contains filtered or unexported fields
}

Create a trial with given hyperparameters.

func (*CreateTrialOperation) Descriptor deprecated

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

Deprecated: Use CreateTrialOperation.ProtoReflect.Descriptor instead.

func (*CreateTrialOperation) GetHyperparams

func (x *CreateTrialOperation) GetHyperparams() string

func (*CreateTrialOperation) GetRequestId

func (x *CreateTrialOperation) GetRequestId() string

func (*CreateTrialOperation) ProtoMessage

func (*CreateTrialOperation) ProtoMessage()

func (*CreateTrialOperation) ProtoReflect

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

func (*CreateTrialOperation) Reset

func (x *CreateTrialOperation) Reset()

func (*CreateTrialOperation) String

func (x *CreateTrialOperation) String() string

type Experiment

type Experiment struct {

	// The id of the experiment.
	Id int32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// The description of the experiment.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Labels attached to the experiment.
	Labels []string `protobuf:"bytes,3,rep,name=labels,proto3" json:"labels,omitempty"`
	// The time the experiment was started.
	StartTime *timestamp.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The time the experiment ended if the experiment is stopped.
	EndTime *timestamp.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// The current state of the experiment.
	State State `protobuf:"varint,6,opt,name=state,proto3,enum=determined.experiment.v1.State" json:"state,omitempty"`
	// Boolean denoting whether the experiment was archived.
	Archived bool `protobuf:"varint,7,opt,name=archived,proto3" json:"archived,omitempty"`
	// The number of trials linked to the experiment.
	NumTrials int32 `protobuf:"varint,8,opt,name=num_trials,json=numTrials,proto3" json:"num_trials,omitempty"`
	// The ids of trials linked to the experiment.
	TrialIds []int32 `protobuf:"varint,20,rep,packed,name=trial_ids,json=trialIds,proto3" json:"trial_ids,omitempty"`
	// The display name of the user that created the experiment.
	DisplayName string `protobuf:"bytes,18,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The id of the user that created the experiment.
	UserId int32 `protobuf:"varint,19,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// The username of the user that created the experiment.
	Username string `protobuf:"bytes,10,opt,name=username,proto3" json:"username,omitempty"`
	// The resource pool the experiment was created in
	ResourcePool string `protobuf:"bytes,11,opt,name=resource_pool,json=resourcePool,proto3" json:"resource_pool,omitempty"`
	// The type of searcher for the experiment
	SearcherType string `protobuf:"bytes,12,opt,name=searcher_type,json=searcherType,proto3" json:"searcher_type,omitempty"`
	// The searcher metric name for the experiment
	SearcherMetric string `protobuf:"bytes,42,opt,name=searcher_metric,json=searcherMetric,proto3" json:"searcher_metric,omitempty"`
	// The hyperparameters for the experiment
	Hyperparameters *_struct.Struct `protobuf:"bytes,46,opt,name=hyperparameters,proto3" json:"hyperparameters,omitempty"`
	// The experiment name.
	Name string `protobuf:"bytes,13,opt,name=name,proto3" json:"name,omitempty"`
	// The experiment notes.
	Notes string `protobuf:"bytes,14,opt,name=notes,proto3" json:"notes,omitempty"`
	// Associated job's id.
	JobId string `protobuf:"bytes,15,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// Original id of a forked or continued experiment.
	ForkedFrom *wrappers.Int32Value `protobuf:"bytes,16,opt,name=forked_from,json=forkedFrom,proto3" json:"forked_from,omitempty"`
	// The current progress of a running experiment.
	Progress *wrappers.DoubleValue `protobuf:"bytes,17,opt,name=progress,proto3" json:"progress,omitempty"`
	// The id of the project associated with this experiment.
	ProjectId int32 `protobuf:"varint,21,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// The name of the project associated with this experiment.
	ProjectName string `protobuf:"bytes,22,opt,name=project_name,json=projectName,proto3" json:"project_name,omitempty"`
	// The id of the workspace associated with this experiment.
	WorkspaceId int32 `protobuf:"varint,23,opt,name=workspace_id,json=workspaceId,proto3" json:"workspace_id,omitempty"`
	// The name of the workspace associated with this experiment.
	WorkspaceName string `protobuf:"bytes,24,opt,name=workspace_name,json=workspaceName,proto3" json:"workspace_name,omitempty"`
	// The archived status of the parent project (can be inherited from
	// workspace).
	ParentArchived bool `protobuf:"varint,25,opt,name=parent_archived,json=parentArchived,proto3" json:"parent_archived,omitempty"`
	// The configuration of the experiment.
	// Is deprecated for performance reasons on the listing experiment route.
	// Use GetExperimentResponse.config instead.
	//
	// Deprecated: Do not use.
	Config *_struct.Struct `protobuf:"bytes,26,opt,name=config,proto3" json:"config,omitempty"`
	// The original configuration that the user submitted.
	OriginalConfig string `protobuf:"bytes,27,opt,name=original_config,json=originalConfig,proto3" json:"original_config,omitempty"`
	// The id of the user who created the parent project.
	ProjectOwnerId int32 `protobuf:"varint,28,opt,name=project_owner_id,json=projectOwnerId,proto3" json:"project_owner_id,omitempty"`
	// The total size of checkpoints.
	CheckpointSize int64 `protobuf:"varint,29,opt,name=checkpoint_size,json=checkpointSize,proto3" json:"checkpoint_size,omitempty"`
	// The count of checkpoints.
	CheckpointCount int32 `protobuf:"varint,30,opt,name=checkpoint_count,json=checkpointCount,proto3" json:"checkpoint_count,omitempty"`
	// The metrics and hyperparameters associated with the best trial by searcher
	// metric.
	BestTrialSearcherMetric *float64 `` /* 143-byte string literal not displayed */
	// Id of experiment's best trial, calculated by the best searcher metrics
	// value of trial's best validation.
	BestTrialId *int32 `protobuf:"varint,32,opt,name=best_trial_id,json=bestTrialId,proto3,oneof" json:"best_trial_id,omitempty"`
	// Unmanaged experiments are detached.
	Unmanaged bool `protobuf:"varint,40,opt,name=unmanaged,proto3" json:"unmanaged,omitempty"`
	// Time in seconds which experiment ran or has been running.
	Duration *int32 `protobuf:"varint,41,opt,name=duration,proto3,oneof" json:"duration,omitempty"`
	// The id of external experiment
	ExternalExperimentId *string `` /* 130-byte string literal not displayed */
	// The id of external trial
	ExternalTrialId *string `protobuf:"bytes,44,opt,name=external_trial_id,json=externalTrialId,proto3,oneof" json:"external_trial_id,omitempty"`
	// Size of model definition file, for unmanaged experiments this should be 0.
	ModelDefinitionSize *int32 `` /* 128-byte string literal not displayed */
	// The experiment pachyderm integration config.
	PachydermIntegration *_struct.Struct `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

Experiment is a collection of one or more trials that are exploring a user-defined hyperparameter space.

func (*Experiment) Descriptor deprecated

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

Deprecated: Use Experiment.ProtoReflect.Descriptor instead.

func (*Experiment) GetArchived

func (x *Experiment) GetArchived() bool

func (*Experiment) GetBestTrialId

func (x *Experiment) GetBestTrialId() int32

func (*Experiment) GetBestTrialSearcherMetric

func (x *Experiment) GetBestTrialSearcherMetric() float64

func (*Experiment) GetCheckpointCount

func (x *Experiment) GetCheckpointCount() int32

func (*Experiment) GetCheckpointSize

func (x *Experiment) GetCheckpointSize() int64

func (*Experiment) GetConfig deprecated

func (x *Experiment) GetConfig() *_struct.Struct

Deprecated: Do not use.

func (*Experiment) GetDescription

func (x *Experiment) GetDescription() string

func (*Experiment) GetDisplayName

func (x *Experiment) GetDisplayName() string

func (*Experiment) GetDuration

func (x *Experiment) GetDuration() int32

func (*Experiment) GetEndTime

func (x *Experiment) GetEndTime() *timestamp.Timestamp

func (*Experiment) GetExternalExperimentId

func (x *Experiment) GetExternalExperimentId() string

func (*Experiment) GetExternalTrialId

func (x *Experiment) GetExternalTrialId() string

func (*Experiment) GetForkedFrom

func (x *Experiment) GetForkedFrom() *wrappers.Int32Value

func (*Experiment) GetHyperparameters

func (x *Experiment) GetHyperparameters() *_struct.Struct

func (*Experiment) GetId

func (x *Experiment) GetId() int32

func (*Experiment) GetJobId

func (x *Experiment) GetJobId() string

func (*Experiment) GetLabels

func (x *Experiment) GetLabels() []string

func (*Experiment) GetModelDefinitionSize

func (x *Experiment) GetModelDefinitionSize() int32

func (*Experiment) GetName

func (x *Experiment) GetName() string

func (*Experiment) GetNotes

func (x *Experiment) GetNotes() string

func (*Experiment) GetNumTrials

func (x *Experiment) GetNumTrials() int32

func (*Experiment) GetOriginalConfig

func (x *Experiment) GetOriginalConfig() string

func (*Experiment) GetPachydermIntegration

func (x *Experiment) GetPachydermIntegration() *_struct.Struct

func (*Experiment) GetParentArchived

func (x *Experiment) GetParentArchived() bool

func (*Experiment) GetProgress

func (x *Experiment) GetProgress() *wrappers.DoubleValue

func (*Experiment) GetProjectId

func (x *Experiment) GetProjectId() int32

func (*Experiment) GetProjectName

func (x *Experiment) GetProjectName() string

func (*Experiment) GetProjectOwnerId

func (x *Experiment) GetProjectOwnerId() int32

func (*Experiment) GetResourcePool

func (x *Experiment) GetResourcePool() string

func (*Experiment) GetSearcherMetric

func (x *Experiment) GetSearcherMetric() string

func (*Experiment) GetSearcherType

func (x *Experiment) GetSearcherType() string

func (*Experiment) GetStartTime

func (x *Experiment) GetStartTime() *timestamp.Timestamp

func (*Experiment) GetState

func (x *Experiment) GetState() State

func (*Experiment) GetTrialIds

func (x *Experiment) GetTrialIds() []int32

func (*Experiment) GetUnmanaged

func (x *Experiment) GetUnmanaged() bool

func (*Experiment) GetUserId

func (x *Experiment) GetUserId() int32

func (*Experiment) GetUsername

func (x *Experiment) GetUsername() string

func (*Experiment) GetWorkspaceId

func (x *Experiment) GetWorkspaceId() int32

func (*Experiment) GetWorkspaceName

func (x *Experiment) GetWorkspaceName() string

func (*Experiment) ProtoMessage

func (*Experiment) ProtoMessage()

func (*Experiment) ProtoReflect

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

func (*Experiment) Reset

func (x *Experiment) Reset()

func (*Experiment) String

func (x *Experiment) String() string

type ExperimentInactive

type ExperimentInactive struct {

	// Current state of the experiment.
	ExperimentState State `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

ExperimentInactive is a searcher event triggered when an experiment is no longer active.

func (*ExperimentInactive) Descriptor deprecated

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

Deprecated: Use ExperimentInactive.ProtoReflect.Descriptor instead.

func (*ExperimentInactive) GetExperimentState

func (x *ExperimentInactive) GetExperimentState() State

func (*ExperimentInactive) ProtoMessage

func (*ExperimentInactive) ProtoMessage()

func (*ExperimentInactive) ProtoReflect

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

func (*ExperimentInactive) Reset

func (x *ExperimentInactive) Reset()

func (*ExperimentInactive) String

func (x *ExperimentInactive) String() string

type ExperimentTrial

type ExperimentTrial struct {

	// the searcher metric value associated with the best_validation_id for the
	// trial.
	SearcherMetricValue *float64 `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

ExperimentTrial is trial-level data that is surfaced to the experiment level.

func (*ExperimentTrial) Descriptor deprecated

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

Deprecated: Use ExperimentTrial.ProtoReflect.Descriptor instead.

func (*ExperimentTrial) GetSearcherMetricValue

func (x *ExperimentTrial) GetSearcherMetricValue() float64

func (*ExperimentTrial) ProtoMessage

func (*ExperimentTrial) ProtoMessage()

func (*ExperimentTrial) ProtoReflect

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

func (*ExperimentTrial) Reset

func (x *ExperimentTrial) Reset()

func (*ExperimentTrial) String

func (x *ExperimentTrial) String() string

type FileNode

type FileNode struct {

	// Path of file.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Name of file.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Modification time of file.
	ModifiedTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=modified_time,json=modifiedTime,proto3" json:"modified_time,omitempty"`
	// Number of bytes in file content.
	ContentLength int32 `protobuf:"varint,4,opt,name=content_length,json=contentLength,proto3" json:"content_length,omitempty"`
	// Is this a directory.
	IsDir bool `protobuf:"varint,5,opt,name=is_dir,json=isDir,proto3" json:"is_dir,omitempty"`
	// MIME type of file.
	ContentType string `protobuf:"bytes,6,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// Subdirectory files.
	Files []*FileNode `protobuf:"bytes,7,rep,name=files,proto3" json:"files,omitempty"`
	// contains filtered or unexported fields
}

File node is one node of file in experiment model definition file tree.

func (*FileNode) Descriptor deprecated

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

Deprecated: Use FileNode.ProtoReflect.Descriptor instead.

func (*FileNode) GetContentLength

func (x *FileNode) GetContentLength() int32

func (*FileNode) GetContentType

func (x *FileNode) GetContentType() string

func (*FileNode) GetFiles

func (x *FileNode) GetFiles() []*FileNode

func (*FileNode) GetIsDir

func (x *FileNode) GetIsDir() bool

func (*FileNode) GetModifiedTime

func (x *FileNode) GetModifiedTime() *timestamp.Timestamp

func (*FileNode) GetName

func (x *FileNode) GetName() string

func (*FileNode) GetPath

func (x *FileNode) GetPath() string

func (*FileNode) ProtoMessage

func (*FileNode) ProtoMessage()

func (*FileNode) ProtoReflect

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

func (*FileNode) Reset

func (x *FileNode) Reset()

func (*FileNode) String

func (x *FileNode) String() string

type InitialOperations

type InitialOperations struct {

	// Cannot have an empty message type.
	Placeholder int32 `protobuf:"varint,1,opt,name=placeholder,proto3" json:"placeholder,omitempty"`
	// contains filtered or unexported fields
}

InitialOperations is a searcher event signaling the creation of an experiment.

func (*InitialOperations) Descriptor deprecated

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

Deprecated: Use InitialOperations.ProtoReflect.Descriptor instead.

func (*InitialOperations) GetPlaceholder

func (x *InitialOperations) GetPlaceholder() int32

func (*InitialOperations) ProtoMessage

func (*InitialOperations) ProtoMessage()

func (*InitialOperations) ProtoReflect

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

func (*InitialOperations) Reset

func (x *InitialOperations) Reset()

func (*InitialOperations) String

func (x *InitialOperations) String() string

type PatchExperiment

type PatchExperiment struct {

	// The id of the experiment.
	Id int32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// The description of the experiment.
	Description *wrappers.StringValue `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Labels attached to the experiment.
	Labels *_struct.ListValue `protobuf:"bytes,3,opt,name=labels,proto3" json:"labels,omitempty"`
	// The experiment name.
	Name *wrappers.StringValue `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// The experiment notes.
	Notes *wrappers.StringValue `protobuf:"bytes,5,opt,name=notes,proto3" json:"notes,omitempty"`
	// Experiment config resources.
	Resources *PatchExperiment_PatchResources `protobuf:"bytes,6,opt,name=resources,proto3,oneof" json:"resources,omitempty"`
	// Experiment config checkpoint_storage.
	CheckpointStorage *PatchExperiment_PatchCheckpointStorage `protobuf:"bytes,7,opt,name=checkpoint_storage,json=checkpointStorage,proto3,oneof" json:"checkpoint_storage,omitempty"`
	// contains filtered or unexported fields
}

PatchExperiment is a partial update to an experiment with only id required.

func (*PatchExperiment) Descriptor deprecated

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

Deprecated: Use PatchExperiment.ProtoReflect.Descriptor instead.

func (*PatchExperiment) GetCheckpointStorage

func (x *PatchExperiment) GetCheckpointStorage() *PatchExperiment_PatchCheckpointStorage

func (*PatchExperiment) GetDescription

func (x *PatchExperiment) GetDescription() *wrappers.StringValue

func (*PatchExperiment) GetId

func (x *PatchExperiment) GetId() int32

func (*PatchExperiment) GetLabels

func (x *PatchExperiment) GetLabels() *_struct.ListValue

func (*PatchExperiment) GetName

func (x *PatchExperiment) GetName() *wrappers.StringValue

func (*PatchExperiment) GetNotes

func (x *PatchExperiment) GetNotes() *wrappers.StringValue

func (*PatchExperiment) GetResources

func (*PatchExperiment) ProtoMessage

func (*PatchExperiment) ProtoMessage()

func (*PatchExperiment) ProtoReflect

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

func (*PatchExperiment) Reset

func (x *PatchExperiment) Reset()

func (*PatchExperiment) String

func (x *PatchExperiment) String() string

type PatchExperiment_PatchCheckpointStorage

type PatchExperiment_PatchCheckpointStorage struct {

	// Experiment config checkpoint_storage.save_experiment_best.
	SaveExperimentBest int32 `protobuf:"varint,1,opt,name=save_experiment_best,json=saveExperimentBest,proto3" json:"save_experiment_best,omitempty"`
	// Experiment config checkpoint_storage.save_trial_best.
	SaveTrialBest int32 `protobuf:"varint,2,opt,name=save_trial_best,json=saveTrialBest,proto3" json:"save_trial_best,omitempty"`
	// Experiment config checkpoint_storage.save_trial_latest.
	SaveTrialLatest int32 `protobuf:"varint,3,opt,name=save_trial_latest,json=saveTrialLatest,proto3" json:"save_trial_latest,omitempty"`
	// contains filtered or unexported fields
}

Nested object for checkpoint_storage field patch.

func (*PatchExperiment_PatchCheckpointStorage) Descriptor deprecated

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

Deprecated: Use PatchExperiment_PatchCheckpointStorage.ProtoReflect.Descriptor instead.

func (*PatchExperiment_PatchCheckpointStorage) GetSaveExperimentBest

func (x *PatchExperiment_PatchCheckpointStorage) GetSaveExperimentBest() int32

func (*PatchExperiment_PatchCheckpointStorage) GetSaveTrialBest

func (x *PatchExperiment_PatchCheckpointStorage) GetSaveTrialBest() int32

func (*PatchExperiment_PatchCheckpointStorage) GetSaveTrialLatest

func (x *PatchExperiment_PatchCheckpointStorage) GetSaveTrialLatest() int32

func (*PatchExperiment_PatchCheckpointStorage) ProtoMessage

func (*PatchExperiment_PatchCheckpointStorage) ProtoReflect

func (*PatchExperiment_PatchCheckpointStorage) Reset

func (*PatchExperiment_PatchCheckpointStorage) String

type PatchExperiment_PatchResources

type PatchExperiment_PatchResources struct {

	// Experiment config resources.max_slots.
	MaxSlots *int32 `protobuf:"varint,1,opt,name=max_slots,json=maxSlots,proto3,oneof" json:"max_slots,omitempty"`
	// Experiment config resources.weight.
	Weight *float64 `protobuf:"fixed64,2,opt,name=weight,proto3,oneof" json:"weight,omitempty"`
	// Experiment config resources.priority.
	Priority *int32 `protobuf:"varint,3,opt,name=priority,proto3,oneof" json:"priority,omitempty"`
	// contains filtered or unexported fields
}

Nested object for resources field patch.

func (*PatchExperiment_PatchResources) Descriptor deprecated

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

Deprecated: Use PatchExperiment_PatchResources.ProtoReflect.Descriptor instead.

func (*PatchExperiment_PatchResources) GetMaxSlots

func (x *PatchExperiment_PatchResources) GetMaxSlots() int32

func (*PatchExperiment_PatchResources) GetPriority

func (x *PatchExperiment_PatchResources) GetPriority() int32

func (*PatchExperiment_PatchResources) GetWeight

func (x *PatchExperiment_PatchResources) GetWeight() float64

func (*PatchExperiment_PatchResources) ProtoMessage

func (*PatchExperiment_PatchResources) ProtoMessage()

func (*PatchExperiment_PatchResources) ProtoReflect

func (*PatchExperiment_PatchResources) Reset

func (x *PatchExperiment_PatchResources) Reset()

func (*PatchExperiment_PatchResources) String

type SearchSummary

type SearchSummary struct {

	// The searcher config from which the summary is generated.
	Config *_struct.Struct `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// A list of planned number of trials to their training lengths.
	Trials []*TrialSummary `protobuf:"bytes,2,rep,name=trials,proto3" json:"trials,omitempty"`
	// contains filtered or unexported fields
}

SearchSummary contains the estimated trials and training lengths that a search plans to execute.

func (*SearchSummary) Descriptor deprecated

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

Deprecated: Use SearchSummary.ProtoReflect.Descriptor instead.

func (*SearchSummary) GetConfig

func (x *SearchSummary) GetConfig() *_struct.Struct

func (*SearchSummary) GetTrials

func (x *SearchSummary) GetTrials() []*TrialSummary

func (*SearchSummary) ProtoMessage

func (*SearchSummary) ProtoMessage()

func (*SearchSummary) ProtoReflect

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

func (*SearchSummary) Reset

func (x *SearchSummary) Reset()

func (*SearchSummary) String

func (x *SearchSummary) String() string

type SearchUnit

type SearchUnit struct {

	// Name of the length unit (if max_length is false).
	Name *string `protobuf:"bytes,1,opt,name=name,proto3,oneof" json:"name,omitempty"`
	// Value of the length unit (if max_length is false).
	Value *int32 `protobuf:"varint,2,opt,name=value,proto3,oneof" json:"value,omitempty"`
	// Bool indicating whether the training length is defined in code.
	MaxLength bool `protobuf:"varint,3,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
	// contains filtered or unexported fields
}

SearchUnit describes a length unit used by some searchers to manage training.

func (*SearchUnit) Descriptor deprecated

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

Deprecated: Use SearchUnit.ProtoReflect.Descriptor instead.

func (*SearchUnit) GetMaxLength

func (x *SearchUnit) GetMaxLength() bool

func (*SearchUnit) GetName

func (x *SearchUnit) GetName() string

func (*SearchUnit) GetValue

func (x *SearchUnit) GetValue() int32

func (*SearchUnit) ProtoMessage

func (*SearchUnit) ProtoMessage()

func (*SearchUnit) ProtoReflect

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

func (*SearchUnit) Reset

func (x *SearchUnit) Reset()

func (*SearchUnit) String

func (x *SearchUnit) String() string

type SearcherOperation

type SearcherOperation struct {

	// A searcher operation is one of the following operations.
	//
	// Types that are assignable to Union:
	//
	//	*SearcherOperation_TrialOperation
	//	*SearcherOperation_CreateTrial
	//	*SearcherOperation_CloseTrial
	//	*SearcherOperation_ShutDown
	Union isSearcherOperation_Union `protobuf_oneof:"union"`
	// contains filtered or unexported fields
}

SearcherOperation is an operation issued by the custom searcher.

func (*SearcherOperation) Descriptor deprecated

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

Deprecated: Use SearcherOperation.ProtoReflect.Descriptor instead.

func (*SearcherOperation) GetCloseTrial

func (x *SearcherOperation) GetCloseTrial() *CloseTrialOperation

func (*SearcherOperation) GetCreateTrial

func (x *SearcherOperation) GetCreateTrial() *CreateTrialOperation

func (*SearcherOperation) GetShutDown

func (x *SearcherOperation) GetShutDown() *ShutDownOperation

func (*SearcherOperation) GetTrialOperation

func (x *SearcherOperation) GetTrialOperation() *TrialOperation

func (*SearcherOperation) GetUnion

func (m *SearcherOperation) GetUnion() isSearcherOperation_Union

func (*SearcherOperation) ProtoMessage

func (*SearcherOperation) ProtoMessage()

func (*SearcherOperation) ProtoReflect

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

func (*SearcherOperation) Reset

func (x *SearcherOperation) Reset()

func (*SearcherOperation) String

func (x *SearcherOperation) String() string

type SearcherOperation_CloseTrial

type SearcherOperation_CloseTrial struct {
	// CloseTrialOperation is issued to close a trial.
	CloseTrial *CloseTrialOperation `protobuf:"bytes,3,opt,name=close_trial,json=closeTrial,proto3,oneof"`
}

type SearcherOperation_CreateTrial

type SearcherOperation_CreateTrial struct {
	// CreateTrialOperation is issued to create a trial.
	CreateTrial *CreateTrialOperation `protobuf:"bytes,2,opt,name=create_trial,json=createTrial,proto3,oneof"`
}

type SearcherOperation_ShutDown

type SearcherOperation_ShutDown struct {
	// ShutDownOperation is issued to shut down the custom search method.
	ShutDown *ShutDownOperation `protobuf:"bytes,4,opt,name=shut_down,json=shutDown,proto3,oneof"`
}

type SearcherOperation_TrialOperation

type SearcherOperation_TrialOperation struct {
	// TrialOperation is issued to tell an existing trial to do something.
	TrialOperation *TrialOperation `protobuf:"bytes,1,opt,name=trial_operation,json=trialOperation,proto3,oneof"`
}

type ShutDownOperation

type ShutDownOperation struct {

	// Defines whether the Searcher was cancelled
	Cancel bool `protobuf:"varint,1,opt,name=cancel,proto3" json:"cancel,omitempty"`
	// Defines whether the Searcher failed
	Failure bool `protobuf:"varint,2,opt,name=failure,proto3" json:"failure,omitempty"`
	// contains filtered or unexported fields
}

Shut down custom searcher method.

func (*ShutDownOperation) Descriptor deprecated

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

Deprecated: Use ShutDownOperation.ProtoReflect.Descriptor instead.

func (*ShutDownOperation) GetCancel

func (x *ShutDownOperation) GetCancel() bool

func (*ShutDownOperation) GetFailure

func (x *ShutDownOperation) GetFailure() bool

func (*ShutDownOperation) ProtoMessage

func (*ShutDownOperation) ProtoMessage()

func (*ShutDownOperation) ProtoReflect

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

func (*ShutDownOperation) Reset

func (x *ShutDownOperation) Reset()

func (*ShutDownOperation) String

func (x *ShutDownOperation) String() string

type State

type State int32

The current state of the experiment.

const (
	// The state of the experiment is unknown.
	State_STATE_UNSPECIFIED State = 0
	// The experiment is in an active state.
	State_STATE_ACTIVE State = 1
	// The experiment is in a paused state
	State_STATE_PAUSED State = 2
	// The experiment is completed and is shutting down.
	State_STATE_STOPPING_COMPLETED State = 3
	// The experiment is canceled and is shutting down.
	State_STATE_STOPPING_CANCELED State = 4
	// The experiment is errored and is shutting down.
	State_STATE_STOPPING_ERROR State = 5
	// The experiment is completed and is shut down.
	State_STATE_COMPLETED State = 6
	// The experiment is canceled and is shut down.
	State_STATE_CANCELED State = 7
	// The experiment is errored and is shut down.
	State_STATE_ERROR State = 8
	// The experiment has been deleted.
	State_STATE_DELETED State = 9
	// The experiment is deleting.
	State_STATE_DELETING State = 10
	// The experiment failed to delete.
	State_STATE_DELETE_FAILED State = 11
	// The experiment is killed and is shutting down.
	State_STATE_STOPPING_KILLED State = 12
	// The experiment is queued (waiting to be run, or job state is still queued).
	// Queued is a substate of the Active state.
	State_STATE_QUEUED State = 13
	// The experiment is pulling the image. Pulling is a substate of the Active
	// state.
	State_STATE_PULLING State = 14
	// The experiment is preparing the environment after finishing pulling the
	// image. Starting is a substate of the Active state.
	State_STATE_STARTING State = 15
	// The experiment has an allocation actively running.
	// Running is a substate of the Active state.
	State_STATE_RUNNING State = 16
)

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

type TrialClosed

type TrialClosed struct {

	// UUID identifying the trial to the searcher.
	RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

TrialClosed is a searcher event triggered when a trial has successfully finished.

func (*TrialClosed) Descriptor deprecated

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

Deprecated: Use TrialClosed.ProtoReflect.Descriptor instead.

func (*TrialClosed) GetRequestId

func (x *TrialClosed) GetRequestId() string

func (*TrialClosed) ProtoMessage

func (*TrialClosed) ProtoMessage()

func (*TrialClosed) ProtoReflect

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

func (*TrialClosed) Reset

func (x *TrialClosed) Reset()

func (*TrialClosed) String

func (x *TrialClosed) String() string

type TrialCreated

type TrialCreated struct {

	// UUID identifying the trial to the searcher.
	RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

TrialCreated is a searcher event signaling the creation of a trial.

func (*TrialCreated) Descriptor deprecated

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

Deprecated: Use TrialCreated.ProtoReflect.Descriptor instead.

func (*TrialCreated) GetRequestId

func (x *TrialCreated) GetRequestId() string

func (*TrialCreated) ProtoMessage

func (*TrialCreated) ProtoMessage()

func (*TrialCreated) ProtoReflect

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

func (*TrialCreated) Reset

func (x *TrialCreated) Reset()

func (*TrialCreated) String

func (x *TrialCreated) String() string

type TrialExitedEarly

type TrialExitedEarly struct {

	// UUID identifying the trial to the searcher.
	RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// The reason for the exit.
	ExitedReason TrialExitedEarly_ExitedReason `` /* 158-byte string literal not displayed */
	// contains filtered or unexported fields
}

TrialExitedEarly is a searcher event triggered when a trial exited prematurely.

func (*TrialExitedEarly) Descriptor deprecated

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

Deprecated: Use TrialExitedEarly.ProtoReflect.Descriptor instead.

func (*TrialExitedEarly) GetExitedReason

func (x *TrialExitedEarly) GetExitedReason() TrialExitedEarly_ExitedReason

func (*TrialExitedEarly) GetRequestId

func (x *TrialExitedEarly) GetRequestId() string

func (*TrialExitedEarly) ProtoMessage

func (*TrialExitedEarly) ProtoMessage()

func (*TrialExitedEarly) ProtoReflect

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

func (*TrialExitedEarly) Reset

func (x *TrialExitedEarly) Reset()

func (*TrialExitedEarly) String

func (x *TrialExitedEarly) String() string

type TrialExitedEarly_ExitedReason

type TrialExitedEarly_ExitedReason int32

The reason for an early exit.

const (
	// Zero-value (not allowed).
	TrialExitedEarly_EXITED_REASON_UNSPECIFIED TrialExitedEarly_ExitedReason = 0
	// Indicates the trial exited due to an invalid hyperparameter.
	TrialExitedEarly_EXITED_REASON_INVALID_HP TrialExitedEarly_ExitedReason = 1
	// Indicates the trial exited due to a user requested stop, from code.
	TrialExitedEarly_EXITED_REASON_USER_REQUESTED_STOP TrialExitedEarly_ExitedReason = 2
	// Indicates the trial exited due to a user requested stop, from the CLI or
	// UI.
	TrialExitedEarly_EXITED_REASON_USER_CANCELED TrialExitedEarly_ExitedReason = 3
)

func (TrialExitedEarly_ExitedReason) Descriptor

func (TrialExitedEarly_ExitedReason) Enum

func (TrialExitedEarly_ExitedReason) EnumDescriptor deprecated

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

Deprecated: Use TrialExitedEarly_ExitedReason.Descriptor instead.

func (TrialExitedEarly_ExitedReason) Number

func (TrialExitedEarly_ExitedReason) String

func (TrialExitedEarly_ExitedReason) Type

type TrialOperation

type TrialOperation struct {

	// A trial operation is one of the following operations.
	//
	// Types that are assignable to Union:
	//
	//	*TrialOperation_ValidateAfter
	Union isTrialOperation_Union `protobuf_oneof:"union"`
	// contains filtered or unexported fields
}

TrialOperation is any operation that a trial can perform while it is active.

func (*TrialOperation) Descriptor deprecated

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

Deprecated: Use TrialOperation.ProtoReflect.Descriptor instead.

func (*TrialOperation) GetUnion

func (m *TrialOperation) GetUnion() isTrialOperation_Union

func (*TrialOperation) GetValidateAfter

func (x *TrialOperation) GetValidateAfter() *ValidateAfterOperation

func (*TrialOperation) ProtoMessage

func (*TrialOperation) ProtoMessage()

func (*TrialOperation) ProtoReflect

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

func (*TrialOperation) Reset

func (x *TrialOperation) Reset()

func (*TrialOperation) String

func (x *TrialOperation) String() string

type TrialOperation_ValidateAfter

type TrialOperation_ValidateAfter struct {
	// ValidateAfter means a trial is currently training and will later
	// validate.
	ValidateAfter *ValidateAfterOperation `protobuf:"bytes,1,opt,name=validate_after,json=validateAfter,proto3,oneof"`
}

type TrialProgress

type TrialProgress struct {

	// UUID identifying the trial to the searcher.
	RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// partial_units represent partial epochs, batches or records where the Unit
	// is implied.
	PartialUnits float64 `protobuf:"fixed64,2,opt,name=partial_units,json=partialUnits,proto3" json:"partial_units,omitempty"`
	// contains filtered or unexported fields
}

TrialProgress is a searcher event that tells you the number of batches completed in the trial.

func (*TrialProgress) Descriptor deprecated

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

Deprecated: Use TrialProgress.ProtoReflect.Descriptor instead.

func (*TrialProgress) GetPartialUnits

func (x *TrialProgress) GetPartialUnits() float64

func (*TrialProgress) GetRequestId

func (x *TrialProgress) GetRequestId() string

func (*TrialProgress) ProtoMessage

func (*TrialProgress) ProtoMessage()

func (*TrialProgress) ProtoReflect

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

func (*TrialProgress) Reset

func (x *TrialProgress) Reset()

func (*TrialProgress) String

func (x *TrialProgress) String() string

type TrialSummary

type TrialSummary struct {

	// Number of trials.
	Count int32 `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"`
	// Training length for the trials.
	Unit *SearchUnit `protobuf:"bytes,2,opt,name=unit,proto3" json:"unit,omitempty"`
	// contains filtered or unexported fields
}

TrialSummary describes the runs that are estimated to train for a certain length.

func (*TrialSummary) Descriptor deprecated

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

Deprecated: Use TrialSummary.ProtoReflect.Descriptor instead.

func (*TrialSummary) GetCount

func (x *TrialSummary) GetCount() int32

func (*TrialSummary) GetUnit

func (x *TrialSummary) GetUnit() *SearchUnit

func (*TrialSummary) ProtoMessage

func (*TrialSummary) ProtoMessage()

func (*TrialSummary) ProtoReflect

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

func (*TrialSummary) Reset

func (x *TrialSummary) Reset()

func (*TrialSummary) String

func (x *TrialSummary) String() string

type ValidateAfterOperation

type ValidateAfterOperation struct {

	// The ID of the trial that should train.
	RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// The length to train before reporting a validation.
	Length uint64 `protobuf:"varint,2,opt,name=length,proto3" json:"length,omitempty"`
	// contains filtered or unexported fields
}

ValidateAfterOperation means the trial should train and validate after training the given length.

func (*ValidateAfterOperation) Descriptor deprecated

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

Deprecated: Use ValidateAfterOperation.ProtoReflect.Descriptor instead.

func (*ValidateAfterOperation) GetLength

func (x *ValidateAfterOperation) GetLength() uint64

func (*ValidateAfterOperation) GetRequestId

func (x *ValidateAfterOperation) GetRequestId() string

func (*ValidateAfterOperation) ProtoMessage

func (*ValidateAfterOperation) ProtoMessage()

func (*ValidateAfterOperation) ProtoReflect

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

func (*ValidateAfterOperation) Reset

func (x *ValidateAfterOperation) Reset()

func (*ValidateAfterOperation) String

func (x *ValidateAfterOperation) String() string

type ValidationCompleted

type ValidationCompleted struct {

	// UUID identifying the trial to the searcher.
	RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Value of the validation metric used to direct the search.
	Metric *_struct.Value `protobuf:"bytes,2,opt,name=metric,proto3" json:"metric,omitempty"`
	// Length from ValidateAfterOperation.
	ValidateAfterLength uint64 `protobuf:"varint,3,opt,name=validate_after_length,json=validateAfterLength,proto3" json:"validate_after_length,omitempty"`
	// contains filtered or unexported fields
}

ValidationCompleted is a searcher event triggered when a validation has been completed.

func (*ValidationCompleted) Descriptor deprecated

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

Deprecated: Use ValidationCompleted.ProtoReflect.Descriptor instead.

func (*ValidationCompleted) GetMetric

func (x *ValidationCompleted) GetMetric() *_struct.Value

func (*ValidationCompleted) GetRequestId

func (x *ValidationCompleted) GetRequestId() string

func (*ValidationCompleted) GetValidateAfterLength

func (x *ValidationCompleted) GetValidateAfterLength() uint64

func (*ValidationCompleted) ProtoMessage

func (*ValidationCompleted) ProtoMessage()

func (*ValidationCompleted) ProtoReflect

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

func (*ValidationCompleted) Reset

func (x *ValidationCompleted) Reset()

func (*ValidationCompleted) String

func (x *ValidationCompleted) String() string

type ValidationHistoryEntry

type ValidationHistoryEntry struct {

	// The id for the trial associated with this validation entry.
	TrialId int32 `protobuf:"varint,1,opt,name=trial_id,json=trialId,proto3" json:"trial_id,omitempty"`
	// The time at which the completed validation was reported.
	EndTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// The value of the `searcher.metric`, indicated by the experiment config, for
	// the validation.
	SearcherMetric float32 `protobuf:"fixed32,3,opt,name=searcher_metric,json=searcherMetric,proto3" json:"searcher_metric,omitempty"`
	// contains filtered or unexported fields
}

ValidationHistoryEntry is a single entry for a validation history for an experiment.

func (*ValidationHistoryEntry) Descriptor deprecated

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

Deprecated: Use ValidationHistoryEntry.ProtoReflect.Descriptor instead.

func (*ValidationHistoryEntry) GetEndTime

func (x *ValidationHistoryEntry) GetEndTime() *timestamp.Timestamp

func (*ValidationHistoryEntry) GetSearcherMetric

func (x *ValidationHistoryEntry) GetSearcherMetric() float32

func (*ValidationHistoryEntry) GetTrialId

func (x *ValidationHistoryEntry) GetTrialId() int32

func (*ValidationHistoryEntry) ProtoMessage

func (*ValidationHistoryEntry) ProtoMessage()

func (*ValidationHistoryEntry) ProtoReflect

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

func (*ValidationHistoryEntry) Reset

func (x *ValidationHistoryEntry) Reset()

func (*ValidationHistoryEntry) String

func (x *ValidationHistoryEntry) String() string

Jump to

Keyboard shortcuts

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