experimentv1

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
}

type CompleteValidateAfterOperation struct {

	// The ValidateAfterOperation being completed.
	Op *ValidateAfterOperation `protobuf:"bytes,1,opt,name=op,proto3" json:"op,omitempty"`
	// The value of searcher metric associated with this completed operation.
	// The metric provided should be the metric used to guide HP search.
	SearcherMetric *_struct.Value `protobuf:"bytes,2,opt,name=searcher_metric,json=searcherMetric,proto3" json:"searcher_metric,omitempty"`
	// contains filtered or unexported fields
}

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
}

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 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.
	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 */
	// contains filtered or unexported fields
}

type ExperimentInactive struct {

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

type ExperimentSimulation struct {

	// The simulated experiment config.
	Config *_struct.Struct `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// The searcher simulation seed.
	Seed uint32 `protobuf:"varint,2,opt,name=seed,proto3" json:"seed,omitempty"`
	// The list of trials in the simulation.
	Trials []*TrialSimulation `protobuf:"bytes,3,rep,name=trials,proto3" json:"trials,omitempty"`
	// contains filtered or unexported fields
}

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
}

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
}

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
}

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
}

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
}

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
}

type RunnableOperation struct {

	// This is the type of the operation.
	Type RunnableType `protobuf:"varint,1,opt,name=type,proto3,enum=determined.experiment.v1.RunnableType" json:"type,omitempty"`
	// If the type == WORKLOAD_KIND_TRAIN, this is the number of units
	Length uint64 `protobuf:"varint,2,opt,name=length,proto3" json:"length,omitempty"`
	// contains filtered or unexported fields
}

type RunnableType int32

type SearcherEvent struct {

	// Incremental ID of the event.
	Id int32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// The concrete event.
	//
	// Types that are assignable to Event:
	//
	//	*SearcherEvent_InitialOperations
	//	*SearcherEvent_TrialCreated
	//	*SearcherEvent_ValidationCompleted
	//	*SearcherEvent_TrialClosed
	//	*SearcherEvent_TrialExitedEarly
	//	*SearcherEvent_TrialProgress
	//	*SearcherEvent_ExperimentInactive
	Event isSearcherEvent_Event `protobuf_oneof:"event"`
	// contains filtered or unexported fields
}

type SearcherEvent_ExperimentInactive struct {
	// Experiment is inactive.
	ExperimentInactive *ExperimentInactive `protobuf:"bytes,9,opt,name=experiment_inactive,json=experimentInactive,proto3,oneof"`
}

type SearcherEvent_InitialOperations struct {
	// An experiment has just been created.
	InitialOperations *InitialOperations `protobuf:"bytes,3,opt,name=initial_operations,json=initialOperations,proto3,oneof"`
}

type SearcherEvent_TrialClosed struct {
	// Trial has finished.
	TrialClosed *TrialClosed `protobuf:"bytes,6,opt,name=trial_closed,json=trialClosed,proto3,oneof"`
}

type SearcherEvent_TrialCreated struct {
	// A trial has been created.
	TrialCreated *TrialCreated `protobuf:"bytes,4,opt,name=trial_created,json=trialCreated,proto3,oneof"`
}

type SearcherEvent_TrialExitedEarly struct {
	// Trial exited early.
	TrialExitedEarly *TrialExitedEarly `protobuf:"bytes,7,opt,name=trial_exited_early,json=trialExitedEarly,proto3,oneof"`
}

type SearcherEvent_TrialProgress struct {
	// Trial progress.
	TrialProgress *TrialProgress `protobuf:"bytes,8,opt,name=trial_progress,json=trialProgress,proto3,oneof"`
}

type SearcherEvent_ValidationCompleted struct {
	// Validation has completed.
	ValidationCompleted *ValidationCompleted `protobuf:"bytes,5,opt,name=validation_completed,json=validationCompleted,proto3,oneof"`
}

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
	//	*SearcherOperation_SetSearcherProgress
	Union isSearcherOperation_Union `protobuf_oneof:"union"`
	// contains filtered or unexported fields
}

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 struct {
	// CreateTrialOperation is issued to create a trial.
	CreateTrial *CreateTrialOperation `protobuf:"bytes,2,opt,name=create_trial,json=createTrial,proto3,oneof"`
}

type SearcherOperation_SetSearcherProgress struct {
	// SetSearcherProgressOperation is issued to set the progress of the custom
	// search method.
	SetSearcherProgress *SetSearcherProgressOperation `protobuf:"bytes,5,opt,name=set_searcher_progress,json=setSearcherProgress,proto3,oneof"`
}

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 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 SetSearcherProgressOperation struct {

	// Experiment progress as a float between 0.0 and 1.0.
	Progress float64 `protobuf:"fixed64,1,opt,name=progress,proto3" json:"progress,omitempty"`
	// contains filtered or unexported fields
}

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
}

type State int32

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
}

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
}

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
}

type TrialExitedEarly_ExitedReason int32

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
}

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 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
}

type TrialSimulation struct {

	// The list of operations that were run before the trial was completed.
	Operations []*RunnableOperation `protobuf:"bytes,1,rep,name=operations,proto3" json:"operations,omitempty"`
	// The number of times that this trial configuration has occurred during the
	// simulation.
	Occurrences int32 `protobuf:"varint,2,opt,name=occurrences,proto3" json:"occurrences,omitempty"`
	// contains filtered or unexported fields
}

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
}

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
}

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
}