api_v1_beta1

package
v0.17.0 Latest Latest
Warning

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

Go to latest
Published: Jul 12, 2024 License: Apache-2.0 Imports: 8 Imported by: 29

Documentation

Index

Constants

View Source
const (
	DBManager_ReportObservationLog_FullMethodName = "/api.v1.beta1.DBManager/ReportObservationLog"
	DBManager_GetObservationLog_FullMethodName    = "/api.v1.beta1.DBManager/GetObservationLog"
	DBManager_DeleteObservationLog_FullMethodName = "/api.v1.beta1.DBManager/DeleteObservationLog"
)
View Source
const (
	Suggestion_GetSuggestions_FullMethodName            = "/api.v1.beta1.Suggestion/GetSuggestions"
	Suggestion_ValidateAlgorithmSettings_FullMethodName = "/api.v1.beta1.Suggestion/ValidateAlgorithmSettings"
)
View Source
const (
	EarlyStopping_GetEarlyStoppingRules_FullMethodName         = "/api.v1.beta1.EarlyStopping/GetEarlyStoppingRules"
	EarlyStopping_SetTrialStatus_FullMethodName                = "/api.v1.beta1.EarlyStopping/SetTrialStatus"
	EarlyStopping_ValidateEarlyStoppingSettings_FullMethodName = "/api.v1.beta1.EarlyStopping/ValidateEarlyStoppingSettings"
)

Variables

View Source
var (
	ParameterType_name = map[int32]string{
		0: "UNKNOWN_TYPE",
		1: "DOUBLE",
		2: "INT",
		3: "DISCRETE",
		4: "CATEGORICAL",
	}
	ParameterType_value = map[string]int32{
		"UNKNOWN_TYPE": 0,
		"DOUBLE":       1,
		"INT":          2,
		"DISCRETE":     3,
		"CATEGORICAL":  4,
	}
)

Enum value maps for ParameterType.

View Source
var (
	ObjectiveType_name = map[int32]string{
		0: "UNKNOWN",
		1: "MINIMIZE",
		2: "MAXIMIZE",
	}
	ObjectiveType_value = map[string]int32{
		"UNKNOWN":  0,
		"MINIMIZE": 1,
		"MAXIMIZE": 2,
	}
)

Enum value maps for ObjectiveType.

View Source
var (
	ComparisonType_name = map[int32]string{
		0: "UNKNOWN_COMPARISON",
		1: "EQUAL",
		2: "LESS",
		3: "GREATER",
	}
	ComparisonType_value = map[string]int32{
		"UNKNOWN_COMPARISON": 0,
		"EQUAL":              1,
		"LESS":               2,
		"GREATER":            3,
	}
)

Enum value maps for ComparisonType.

View Source
var (
	TrialStatus_TrialConditionType_name = map[int32]string{
		0: "CREATED",
		1: "RUNNING",
		2: "SUCCEEDED",
		3: "KILLED",
		4: "FAILED",
		5: "METRICSUNAVAILABLE",
		6: "EARLYSTOPPED",
		7: "UNKNOWN",
	}
	TrialStatus_TrialConditionType_value = map[string]int32{
		"CREATED":            0,
		"RUNNING":            1,
		"SUCCEEDED":          2,
		"KILLED":             3,
		"FAILED":             4,
		"METRICSUNAVAILABLE": 5,
		"EARLYSTOPPED":       6,
		"UNKNOWN":            7,
	}
)

Enum value maps for TrialStatus_TrialConditionType.

View Source
var DBManager_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.v1.beta1.DBManager",
	HandlerType: (*DBManagerServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ReportObservationLog",
			Handler:    _DBManager_ReportObservationLog_Handler,
		},
		{
			MethodName: "GetObservationLog",
			Handler:    _DBManager_GetObservationLog_Handler,
		},
		{
			MethodName: "DeleteObservationLog",
			Handler:    _DBManager_DeleteObservationLog_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api.proto",
}

DBManager_ServiceDesc is the grpc.ServiceDesc for DBManager service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var EarlyStopping_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.v1.beta1.EarlyStopping",
	HandlerType: (*EarlyStoppingServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetEarlyStoppingRules",
			Handler:    _EarlyStopping_GetEarlyStoppingRules_Handler,
		},
		{
			MethodName: "SetTrialStatus",
			Handler:    _EarlyStopping_SetTrialStatus_Handler,
		},
		{
			MethodName: "ValidateEarlyStoppingSettings",
			Handler:    _EarlyStopping_ValidateEarlyStoppingSettings_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api.proto",
}

EarlyStopping_ServiceDesc is the grpc.ServiceDesc for EarlyStopping service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var Suggestion_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.v1.beta1.Suggestion",
	HandlerType: (*SuggestionServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetSuggestions",
			Handler:    _Suggestion_GetSuggestions_Handler,
		},
		{
			MethodName: "ValidateAlgorithmSettings",
			Handler:    _Suggestion_ValidateAlgorithmSettings_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api.proto",
}

Suggestion_ServiceDesc is the grpc.ServiceDesc for Suggestion service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterDBManagerServer added in v0.10.0

func RegisterDBManagerServer(s grpc.ServiceRegistrar, srv DBManagerServer)

func RegisterEarlyStoppingServer

func RegisterEarlyStoppingServer(s grpc.ServiceRegistrar, srv EarlyStoppingServer)

func RegisterSuggestionServer

func RegisterSuggestionServer(s grpc.ServiceRegistrar, srv SuggestionServer)

Types

type AlgorithmSetting

type AlgorithmSetting struct {
	Name  string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

* HP or NAS algorithm settings.

func (*AlgorithmSetting) Descriptor deprecated

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

Deprecated: Use AlgorithmSetting.ProtoReflect.Descriptor instead.

func (*AlgorithmSetting) GetName

func (x *AlgorithmSetting) GetName() string

func (*AlgorithmSetting) GetValue

func (x *AlgorithmSetting) GetValue() string

func (*AlgorithmSetting) ProtoMessage

func (*AlgorithmSetting) ProtoMessage()

func (*AlgorithmSetting) ProtoReflect added in v0.17.0

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

func (*AlgorithmSetting) Reset

func (x *AlgorithmSetting) Reset()

func (*AlgorithmSetting) String

func (x *AlgorithmSetting) String() string

type AlgorithmSpec

type AlgorithmSpec struct {
	AlgorithmName     string              `protobuf:"bytes,1,opt,name=algorithm_name,json=algorithmName,proto3" json:"algorithm_name,omitempty"`
	AlgorithmSettings []*AlgorithmSetting `protobuf:"bytes,2,rep,name=algorithm_settings,json=algorithmSettings,proto3" json:"algorithm_settings,omitempty"`
	// contains filtered or unexported fields
}

* HP or NAS algorithm specification.

func (*AlgorithmSpec) Descriptor deprecated

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

Deprecated: Use AlgorithmSpec.ProtoReflect.Descriptor instead.

func (*AlgorithmSpec) GetAlgorithmName

func (x *AlgorithmSpec) GetAlgorithmName() string

func (*AlgorithmSpec) GetAlgorithmSettings

func (x *AlgorithmSpec) GetAlgorithmSettings() []*AlgorithmSetting

func (*AlgorithmSpec) ProtoMessage

func (*AlgorithmSpec) ProtoMessage()

func (*AlgorithmSpec) ProtoReflect added in v0.17.0

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

func (*AlgorithmSpec) Reset

func (x *AlgorithmSpec) Reset()

func (*AlgorithmSpec) String

func (x *AlgorithmSpec) String() string

type ComparisonType added in v0.10.0

type ComparisonType int32
const (
	ComparisonType_UNKNOWN_COMPARISON ComparisonType = 0 // Unknown comparison, not used
	ComparisonType_EQUAL              ComparisonType = 1 // Equal comparison, e.g. accuracy = 0.7
	ComparisonType_LESS               ComparisonType = 2 // Less comparison, e.g. accuracy < 0.7
	ComparisonType_GREATER            ComparisonType = 3 // Greater comparison, e.g. accuracy > 0.7
)

func (ComparisonType) Descriptor added in v0.17.0

func (ComparisonType) Enum added in v0.17.0

func (x ComparisonType) Enum() *ComparisonType

func (ComparisonType) EnumDescriptor deprecated added in v0.10.0

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

Deprecated: Use ComparisonType.Descriptor instead.

func (ComparisonType) Number added in v0.17.0

func (ComparisonType) String added in v0.10.0

func (x ComparisonType) String() string

func (ComparisonType) Type added in v0.17.0

type DBManagerClient added in v0.10.0

type DBManagerClient interface {
	// *
	// Report a log of Observations for a Trial.
	// The log consists of timestamp and value of metric.
	// Katib store every log of metrics.
	// You can see accuracy curve or other metric logs on UI.
	ReportObservationLog(ctx context.Context, in *ReportObservationLogRequest, opts ...grpc.CallOption) (*ReportObservationLogReply, error)
	// *
	// Get all log of Observations for a Trial.
	GetObservationLog(ctx context.Context, in *GetObservationLogRequest, opts ...grpc.CallOption) (*GetObservationLogReply, error)
	// *
	// Delete all log of Observations for a Trial.
	DeleteObservationLog(ctx context.Context, in *DeleteObservationLogRequest, opts ...grpc.CallOption) (*DeleteObservationLogReply, error)
}

DBManagerClient is the client API for DBManager service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewDBManagerClient added in v0.10.0

func NewDBManagerClient(cc grpc.ClientConnInterface) DBManagerClient

type DBManagerServer added in v0.10.0

type DBManagerServer interface {
	// *
	// Report a log of Observations for a Trial.
	// The log consists of timestamp and value of metric.
	// Katib store every log of metrics.
	// You can see accuracy curve or other metric logs on UI.
	ReportObservationLog(context.Context, *ReportObservationLogRequest) (*ReportObservationLogReply, error)
	// *
	// Get all log of Observations for a Trial.
	GetObservationLog(context.Context, *GetObservationLogRequest) (*GetObservationLogReply, error)
	// *
	// Delete all log of Observations for a Trial.
	DeleteObservationLog(context.Context, *DeleteObservationLogRequest) (*DeleteObservationLogReply, error)
}

DBManagerServer is the server API for DBManager service. All implementations should embed UnimplementedDBManagerServer for forward compatibility

type DeleteObservationLogReply

type DeleteObservationLogReply struct {
	// contains filtered or unexported fields
}

func (*DeleteObservationLogReply) Descriptor deprecated

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

Deprecated: Use DeleteObservationLogReply.ProtoReflect.Descriptor instead.

func (*DeleteObservationLogReply) ProtoMessage

func (*DeleteObservationLogReply) ProtoMessage()

func (*DeleteObservationLogReply) ProtoReflect added in v0.17.0

func (*DeleteObservationLogReply) Reset

func (x *DeleteObservationLogReply) Reset()

func (*DeleteObservationLogReply) String

func (x *DeleteObservationLogReply) String() string

type DeleteObservationLogRequest

type DeleteObservationLogRequest struct {
	TrialName string `protobuf:"bytes,1,opt,name=trial_name,json=trialName,proto3" json:"trial_name,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteObservationLogRequest) Descriptor deprecated

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

Deprecated: Use DeleteObservationLogRequest.ProtoReflect.Descriptor instead.

func (*DeleteObservationLogRequest) GetTrialName

func (x *DeleteObservationLogRequest) GetTrialName() string

func (*DeleteObservationLogRequest) ProtoMessage

func (*DeleteObservationLogRequest) ProtoMessage()

func (*DeleteObservationLogRequest) ProtoReflect added in v0.17.0

func (*DeleteObservationLogRequest) Reset

func (x *DeleteObservationLogRequest) Reset()

func (*DeleteObservationLogRequest) String

func (x *DeleteObservationLogRequest) String() string

type EarlyStoppingClient

type EarlyStoppingClient interface {
	GetEarlyStoppingRules(ctx context.Context, in *GetEarlyStoppingRulesRequest, opts ...grpc.CallOption) (*GetEarlyStoppingRulesReply, error)
	SetTrialStatus(ctx context.Context, in *SetTrialStatusRequest, opts ...grpc.CallOption) (*SetTrialStatusReply, error)
	ValidateEarlyStoppingSettings(ctx context.Context, in *ValidateEarlyStoppingSettingsRequest, opts ...grpc.CallOption) (*ValidateEarlyStoppingSettingsReply, error)
}

EarlyStoppingClient is the client API for EarlyStopping service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type EarlyStoppingRule added in v0.10.0

type EarlyStoppingRule struct {
	Name       string         `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`                                               // Name of the rule. Usually, metric name.
	Value      string         `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`                                             // Value of the metric.
	Comparison ComparisonType `protobuf:"varint,3,opt,name=comparison,proto3,enum=api.v1.beta1.ComparisonType" json:"comparison,omitempty"` // Correlation between name and value, one of equal, less or greater
	// Defines quantity of intermediate results that should be received before applying the rule.
	// If start step is empty, rule is applied from the first recorded metric.
	StartStep int32 `protobuf:"varint,4,opt,name=start_step,json=startStep,proto3" json:"start_step,omitempty"`
	// contains filtered or unexported fields
}

* EarlyStoppingRule represents single early stopping rule.

func (*EarlyStoppingRule) Descriptor deprecated added in v0.10.0

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

Deprecated: Use EarlyStoppingRule.ProtoReflect.Descriptor instead.

func (*EarlyStoppingRule) GetComparison added in v0.10.0

func (x *EarlyStoppingRule) GetComparison() ComparisonType

func (*EarlyStoppingRule) GetName added in v0.10.0

func (x *EarlyStoppingRule) GetName() string

func (*EarlyStoppingRule) GetStartStep added in v0.10.0

func (x *EarlyStoppingRule) GetStartStep() int32

func (*EarlyStoppingRule) GetValue added in v0.10.0

func (x *EarlyStoppingRule) GetValue() string

func (*EarlyStoppingRule) ProtoMessage added in v0.10.0

func (*EarlyStoppingRule) ProtoMessage()

func (*EarlyStoppingRule) ProtoReflect added in v0.17.0

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

func (*EarlyStoppingRule) Reset added in v0.10.0

func (x *EarlyStoppingRule) Reset()

func (*EarlyStoppingRule) String added in v0.10.0

func (x *EarlyStoppingRule) String() string

type EarlyStoppingServer

EarlyStoppingServer is the server API for EarlyStopping service. All implementations should embed UnimplementedEarlyStoppingServer for forward compatibility

type EarlyStoppingSetting added in v0.10.0

type EarlyStoppingSetting struct {
	Name  string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

* Early stopping algorithm settings.

func (*EarlyStoppingSetting) Descriptor deprecated added in v0.10.0

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

Deprecated: Use EarlyStoppingSetting.ProtoReflect.Descriptor instead.

func (*EarlyStoppingSetting) GetName added in v0.10.0

func (x *EarlyStoppingSetting) GetName() string

func (*EarlyStoppingSetting) GetValue added in v0.10.0

func (x *EarlyStoppingSetting) GetValue() string

func (*EarlyStoppingSetting) ProtoMessage added in v0.10.0

func (*EarlyStoppingSetting) ProtoMessage()

func (*EarlyStoppingSetting) ProtoReflect added in v0.17.0

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

func (*EarlyStoppingSetting) Reset added in v0.10.0

func (x *EarlyStoppingSetting) Reset()

func (*EarlyStoppingSetting) String added in v0.10.0

func (x *EarlyStoppingSetting) String() string

type EarlyStoppingSpec

type EarlyStoppingSpec struct {
	AlgorithmName     string                  `protobuf:"bytes,1,opt,name=algorithm_name,json=algorithmName,proto3" json:"algorithm_name,omitempty"`
	AlgorithmSettings []*EarlyStoppingSetting `protobuf:"bytes,2,rep,name=algorithm_settings,json=algorithmSettings,proto3" json:"algorithm_settings,omitempty"`
	// contains filtered or unexported fields
}

* Early stopping algorithm specification.

func (*EarlyStoppingSpec) Descriptor deprecated

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

Deprecated: Use EarlyStoppingSpec.ProtoReflect.Descriptor instead.

func (*EarlyStoppingSpec) GetAlgorithmName added in v0.10.0

func (x *EarlyStoppingSpec) GetAlgorithmName() string

func (*EarlyStoppingSpec) GetAlgorithmSettings added in v0.10.0

func (x *EarlyStoppingSpec) GetAlgorithmSettings() []*EarlyStoppingSetting

func (*EarlyStoppingSpec) ProtoMessage

func (*EarlyStoppingSpec) ProtoMessage()

func (*EarlyStoppingSpec) ProtoReflect added in v0.17.0

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

func (*EarlyStoppingSpec) Reset

func (x *EarlyStoppingSpec) Reset()

func (*EarlyStoppingSpec) String

func (x *EarlyStoppingSpec) String() string

type Experiment

type Experiment struct {
	Name string          `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Name for the Experiment.
	Spec *ExperimentSpec `protobuf:"bytes,2,opt,name=spec,proto3" json:"spec,omitempty"` // Experiment specification.
	// contains filtered or unexported fields
}

* Structure for a single Experiment.

func (*Experiment) Descriptor deprecated

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

Deprecated: Use Experiment.ProtoReflect.Descriptor instead.

func (*Experiment) GetName

func (x *Experiment) GetName() string

func (*Experiment) GetSpec

func (x *Experiment) GetSpec() *ExperimentSpec

func (*Experiment) ProtoMessage

func (*Experiment) ProtoMessage()

func (*Experiment) ProtoReflect added in v0.17.0

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

func (*Experiment) Reset

func (x *Experiment) Reset()

func (*Experiment) String

func (x *Experiment) String() string

type ExperimentSpec

type ExperimentSpec struct {
	ParameterSpecs     *ExperimentSpec_ParameterSpecs `protobuf:"bytes,1,opt,name=parameter_specs,json=parameterSpecs,proto3" json:"parameter_specs,omitempty"`
	Objective          *ObjectiveSpec                 `protobuf:"bytes,2,opt,name=objective,proto3" json:"objective,omitempty"`                                                // Objective specification for the Experiment.
	Algorithm          *AlgorithmSpec                 `protobuf:"bytes,3,opt,name=algorithm,proto3" json:"algorithm,omitempty"`                                                // HP or NAS algorithm specification for the Experiment.
	EarlyStopping      *EarlyStoppingSpec             `protobuf:"bytes,4,opt,name=early_stopping,json=earlyStopping,proto3" json:"early_stopping,omitempty"`                   // Early stopping specification for the Experiment.
	ParallelTrialCount int32                          `protobuf:"varint,5,opt,name=parallel_trial_count,json=parallelTrialCount,proto3" json:"parallel_trial_count,omitempty"` // How many Trials can be processed in parallel.
	MaxTrialCount      int32                          `protobuf:"varint,6,opt,name=max_trial_count,json=maxTrialCount,proto3" json:"max_trial_count,omitempty"`                // Max completed Trials to mark Experiment as succeeded.
	NasConfig          *NasConfig                     `protobuf:"bytes,7,opt,name=nas_config,json=nasConfig,proto3" json:"nas_config,omitempty"`                               // NAS configuration for the Experiment.
	// contains filtered or unexported fields
}

* Specification of an Experiment. Experiment represents a single optimization run over a feasible space. Each Experiment contains a configuration describing the feasible space, as well as a set of Trials. It is assumed that objective function f(x) does not change in the course of an Experiment.

func (*ExperimentSpec) Descriptor deprecated

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

Deprecated: Use ExperimentSpec.ProtoReflect.Descriptor instead.

func (*ExperimentSpec) GetAlgorithm

func (x *ExperimentSpec) GetAlgorithm() *AlgorithmSpec

func (*ExperimentSpec) GetEarlyStopping added in v0.10.0

func (x *ExperimentSpec) GetEarlyStopping() *EarlyStoppingSpec

func (*ExperimentSpec) GetMaxTrialCount

func (x *ExperimentSpec) GetMaxTrialCount() int32

func (*ExperimentSpec) GetNasConfig

func (x *ExperimentSpec) GetNasConfig() *NasConfig

func (*ExperimentSpec) GetObjective

func (x *ExperimentSpec) GetObjective() *ObjectiveSpec

func (*ExperimentSpec) GetParallelTrialCount

func (x *ExperimentSpec) GetParallelTrialCount() int32

func (*ExperimentSpec) GetParameterSpecs

func (x *ExperimentSpec) GetParameterSpecs() *ExperimentSpec_ParameterSpecs

func (*ExperimentSpec) ProtoMessage

func (*ExperimentSpec) ProtoMessage()

func (*ExperimentSpec) ProtoReflect added in v0.17.0

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

func (*ExperimentSpec) Reset

func (x *ExperimentSpec) Reset()

func (*ExperimentSpec) String

func (x *ExperimentSpec) String() string

type ExperimentSpec_ParameterSpecs

type ExperimentSpec_ParameterSpecs struct {
	Parameters []*ParameterSpec `protobuf:"bytes,1,rep,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

* List of ParameterSpec.

func (*ExperimentSpec_ParameterSpecs) Descriptor deprecated

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

Deprecated: Use ExperimentSpec_ParameterSpecs.ProtoReflect.Descriptor instead.

func (*ExperimentSpec_ParameterSpecs) GetParameters

func (x *ExperimentSpec_ParameterSpecs) GetParameters() []*ParameterSpec

func (*ExperimentSpec_ParameterSpecs) ProtoMessage

func (*ExperimentSpec_ParameterSpecs) ProtoMessage()

func (*ExperimentSpec_ParameterSpecs) ProtoReflect added in v0.17.0

func (*ExperimentSpec_ParameterSpecs) Reset

func (x *ExperimentSpec_ParameterSpecs) Reset()

func (*ExperimentSpec_ParameterSpecs) String

type FeasibleSpace

type FeasibleSpace struct {
	Max  string   `protobuf:"bytes,1,opt,name=max,proto3" json:"max,omitempty"`   /// Max Value
	Min  string   `protobuf:"bytes,2,opt,name=min,proto3" json:"min,omitempty"`   /// Minimum Value
	List []string `protobuf:"bytes,3,rep,name=list,proto3" json:"list,omitempty"` /// List of Values.
	Step string   `protobuf:"bytes,4,opt,name=step,proto3" json:"step,omitempty"` /// Step for double or int parameter
	// contains filtered or unexported fields
}

* Feasible space for optimization. Int and Double type use Max/Min. Discrete and Categorical type use List.

func (*FeasibleSpace) Descriptor deprecated

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

Deprecated: Use FeasibleSpace.ProtoReflect.Descriptor instead.

func (*FeasibleSpace) GetList

func (x *FeasibleSpace) GetList() []string

func (*FeasibleSpace) GetMax

func (x *FeasibleSpace) GetMax() string

func (*FeasibleSpace) GetMin

func (x *FeasibleSpace) GetMin() string

func (*FeasibleSpace) GetStep

func (x *FeasibleSpace) GetStep() string

func (*FeasibleSpace) ProtoMessage

func (*FeasibleSpace) ProtoMessage()

func (*FeasibleSpace) ProtoReflect added in v0.17.0

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

func (*FeasibleSpace) Reset

func (x *FeasibleSpace) Reset()

func (*FeasibleSpace) String

func (x *FeasibleSpace) String() string

type GetEarlyStoppingRulesReply added in v0.10.0

type GetEarlyStoppingRulesReply struct {
	EarlyStoppingRules []*EarlyStoppingRule `protobuf:"bytes,1,rep,name=early_stopping_rules,json=earlyStoppingRules,proto3" json:"early_stopping_rules,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEarlyStoppingRulesReply) Descriptor deprecated added in v0.10.0

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

Deprecated: Use GetEarlyStoppingRulesReply.ProtoReflect.Descriptor instead.

func (*GetEarlyStoppingRulesReply) GetEarlyStoppingRules added in v0.10.0

func (x *GetEarlyStoppingRulesReply) GetEarlyStoppingRules() []*EarlyStoppingRule

func (*GetEarlyStoppingRulesReply) ProtoMessage added in v0.10.0

func (*GetEarlyStoppingRulesReply) ProtoMessage()

func (*GetEarlyStoppingRulesReply) ProtoReflect added in v0.17.0

func (*GetEarlyStoppingRulesReply) Reset added in v0.10.0

func (x *GetEarlyStoppingRulesReply) Reset()

func (*GetEarlyStoppingRulesReply) String added in v0.10.0

func (x *GetEarlyStoppingRulesReply) String() string

type GetEarlyStoppingRulesRequest added in v0.10.0

type GetEarlyStoppingRulesRequest struct {
	Experiment       *Experiment `protobuf:"bytes,1,opt,name=experiment,proto3" json:"experiment,omitempty"`
	Trials           []*Trial    `protobuf:"bytes,2,rep,name=trials,proto3" json:"trials,omitempty"`
	DbManagerAddress string      `protobuf:"bytes,3,opt,name=db_manager_address,json=dbManagerAddress,proto3" json:"db_manager_address,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEarlyStoppingRulesRequest) Descriptor deprecated added in v0.10.0

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

Deprecated: Use GetEarlyStoppingRulesRequest.ProtoReflect.Descriptor instead.

func (*GetEarlyStoppingRulesRequest) GetDbManagerAddress added in v0.10.0

func (x *GetEarlyStoppingRulesRequest) GetDbManagerAddress() string

func (*GetEarlyStoppingRulesRequest) GetExperiment added in v0.10.0

func (x *GetEarlyStoppingRulesRequest) GetExperiment() *Experiment

func (*GetEarlyStoppingRulesRequest) GetTrials added in v0.10.0

func (x *GetEarlyStoppingRulesRequest) GetTrials() []*Trial

func (*GetEarlyStoppingRulesRequest) ProtoMessage added in v0.10.0

func (*GetEarlyStoppingRulesRequest) ProtoMessage()

func (*GetEarlyStoppingRulesRequest) ProtoReflect added in v0.17.0

func (*GetEarlyStoppingRulesRequest) Reset added in v0.10.0

func (x *GetEarlyStoppingRulesRequest) Reset()

func (*GetEarlyStoppingRulesRequest) String added in v0.10.0

type GetObservationLogReply

type GetObservationLogReply struct {
	ObservationLog *ObservationLog `protobuf:"bytes,1,opt,name=observation_log,json=observationLog,proto3" json:"observation_log,omitempty"`
	// contains filtered or unexported fields
}

func (*GetObservationLogReply) Descriptor deprecated

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

Deprecated: Use GetObservationLogReply.ProtoReflect.Descriptor instead.

func (*GetObservationLogReply) GetObservationLog

func (x *GetObservationLogReply) GetObservationLog() *ObservationLog

func (*GetObservationLogReply) ProtoMessage

func (*GetObservationLogReply) ProtoMessage()

func (*GetObservationLogReply) ProtoReflect added in v0.17.0

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

func (*GetObservationLogReply) Reset

func (x *GetObservationLogReply) Reset()

func (*GetObservationLogReply) String

func (x *GetObservationLogReply) String() string

type GetObservationLogRequest

type GetObservationLogRequest struct {
	TrialName  string `protobuf:"bytes,1,opt,name=trial_name,json=trialName,proto3" json:"trial_name,omitempty"`
	MetricName string `protobuf:"bytes,2,opt,name=metric_name,json=metricName,proto3" json:"metric_name,omitempty"`
	StartTime  string `protobuf:"bytes,3,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` ///The start of the time range. RFC3339 format
	EndTime    string `protobuf:"bytes,4,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`       ///The end of the time range. RFC3339 format
	// contains filtered or unexported fields
}

func (*GetObservationLogRequest) Descriptor deprecated

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

Deprecated: Use GetObservationLogRequest.ProtoReflect.Descriptor instead.

func (*GetObservationLogRequest) GetEndTime

func (x *GetObservationLogRequest) GetEndTime() string

func (*GetObservationLogRequest) GetMetricName

func (x *GetObservationLogRequest) GetMetricName() string

func (*GetObservationLogRequest) GetStartTime

func (x *GetObservationLogRequest) GetStartTime() string

func (*GetObservationLogRequest) GetTrialName

func (x *GetObservationLogRequest) GetTrialName() string

func (*GetObservationLogRequest) ProtoMessage

func (*GetObservationLogRequest) ProtoMessage()

func (*GetObservationLogRequest) ProtoReflect added in v0.17.0

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

func (*GetObservationLogRequest) Reset

func (x *GetObservationLogRequest) Reset()

func (*GetObservationLogRequest) String

func (x *GetObservationLogRequest) String() string

type GetSuggestionsReply

type GetSuggestionsReply struct {
	ParameterAssignments []*GetSuggestionsReply_ParameterAssignments `protobuf:"bytes,1,rep,name=parameter_assignments,json=parameterAssignments,proto3" json:"parameter_assignments,omitempty"`
	Algorithm            *AlgorithmSpec                              `protobuf:"bytes,2,opt,name=algorithm,proto3" json:"algorithm,omitempty"`
	EarlyStoppingRules   []*EarlyStoppingRule                        `protobuf:"bytes,3,rep,name=early_stopping_rules,json=earlyStoppingRules,proto3" json:"early_stopping_rules,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSuggestionsReply) Descriptor deprecated

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

Deprecated: Use GetSuggestionsReply.ProtoReflect.Descriptor instead.

func (*GetSuggestionsReply) GetAlgorithm

func (x *GetSuggestionsReply) GetAlgorithm() *AlgorithmSpec

func (*GetSuggestionsReply) GetEarlyStoppingRules added in v0.10.0

func (x *GetSuggestionsReply) GetEarlyStoppingRules() []*EarlyStoppingRule

func (*GetSuggestionsReply) GetParameterAssignments

func (x *GetSuggestionsReply) GetParameterAssignments() []*GetSuggestionsReply_ParameterAssignments

func (*GetSuggestionsReply) ProtoMessage

func (*GetSuggestionsReply) ProtoMessage()

func (*GetSuggestionsReply) ProtoReflect added in v0.17.0

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

func (*GetSuggestionsReply) Reset

func (x *GetSuggestionsReply) Reset()

func (*GetSuggestionsReply) String

func (x *GetSuggestionsReply) String() string

type GetSuggestionsReply_ParameterAssignments

type GetSuggestionsReply_ParameterAssignments struct {
	Assignments []*ParameterAssignment `protobuf:"bytes,1,rep,name=assignments,proto3" json:"assignments,omitempty"`
	// Optional field to override the trial name
	TrialName string `protobuf:"bytes,2,opt,name=trial_name,json=trialName,proto3" json:"trial_name,omitempty"`
	// Optional field to add labels to the generated Trials
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetSuggestionsReply_ParameterAssignments) Descriptor deprecated

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

Deprecated: Use GetSuggestionsReply_ParameterAssignments.ProtoReflect.Descriptor instead.

func (*GetSuggestionsReply_ParameterAssignments) GetAssignments

func (*GetSuggestionsReply_ParameterAssignments) GetLabels added in v0.14.0

func (*GetSuggestionsReply_ParameterAssignments) GetTrialName added in v0.14.0

func (*GetSuggestionsReply_ParameterAssignments) ProtoMessage

func (*GetSuggestionsReply_ParameterAssignments) ProtoReflect added in v0.17.0

func (*GetSuggestionsReply_ParameterAssignments) Reset

func (*GetSuggestionsReply_ParameterAssignments) String

type GetSuggestionsRequest

type GetSuggestionsRequest struct {
	Experiment *Experiment `protobuf:"bytes,1,opt,name=experiment,proto3" json:"experiment,omitempty"`
	Trials     []*Trial    `protobuf:"bytes,2,rep,name=trials,proto3" json:"trials,omitempty"` // All completed trials owned by the experiment.
	// The number of Suggestions requested at one time.
	// When you set 3 to current_request_number, you get three Suggestions at one time.
	CurrentRequestNumber int32 `protobuf:"varint,4,opt,name=current_request_number,json=currentRequestNumber,proto3" json:"current_request_number,omitempty"`
	TotalRequestNumber   int32 `protobuf:"varint,5,opt,name=total_request_number,json=totalRequestNumber,proto3" json:"total_request_number,omitempty"` // The number of Suggestions requested till now.
	// contains filtered or unexported fields
}

func (*GetSuggestionsRequest) Descriptor deprecated

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

Deprecated: Use GetSuggestionsRequest.ProtoReflect.Descriptor instead.

func (*GetSuggestionsRequest) GetCurrentRequestNumber added in v0.13.0

func (x *GetSuggestionsRequest) GetCurrentRequestNumber() int32

func (*GetSuggestionsRequest) GetExperiment

func (x *GetSuggestionsRequest) GetExperiment() *Experiment

func (*GetSuggestionsRequest) GetTotalRequestNumber added in v0.12.0

func (x *GetSuggestionsRequest) GetTotalRequestNumber() int32

func (*GetSuggestionsRequest) GetTrials

func (x *GetSuggestionsRequest) GetTrials() []*Trial

func (*GetSuggestionsRequest) ProtoMessage

func (*GetSuggestionsRequest) ProtoMessage()

func (*GetSuggestionsRequest) ProtoReflect added in v0.17.0

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

func (*GetSuggestionsRequest) Reset

func (x *GetSuggestionsRequest) Reset()

func (*GetSuggestionsRequest) String

func (x *GetSuggestionsRequest) String() string

type GraphConfig

type GraphConfig struct {
	NumLayers   int32   `protobuf:"varint,1,opt,name=num_layers,json=numLayers,proto3" json:"num_layers,omitempty"`              /// Number of layers
	InputSizes  []int32 `protobuf:"varint,2,rep,packed,name=input_sizes,json=inputSizes,proto3" json:"input_sizes,omitempty"`    /// Dimensions of input size
	OutputSizes []int32 `protobuf:"varint,3,rep,packed,name=output_sizes,json=outputSizes,proto3" json:"output_sizes,omitempty"` /// Dimensions of output size
	// contains filtered or unexported fields
}

* GraphConfig contains a config of DAG

func (*GraphConfig) Descriptor deprecated

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

Deprecated: Use GraphConfig.ProtoReflect.Descriptor instead.

func (*GraphConfig) GetInputSizes

func (x *GraphConfig) GetInputSizes() []int32

func (*GraphConfig) GetNumLayers

func (x *GraphConfig) GetNumLayers() int32

func (*GraphConfig) GetOutputSizes

func (x *GraphConfig) GetOutputSizes() []int32

func (*GraphConfig) ProtoMessage

func (*GraphConfig) ProtoMessage()

func (*GraphConfig) ProtoReflect added in v0.17.0

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

func (*GraphConfig) Reset

func (x *GraphConfig) Reset()

func (*GraphConfig) String

func (x *GraphConfig) String() string

type Metric

type Metric struct {
	Name  string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*Metric) Descriptor deprecated

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

Deprecated: Use Metric.ProtoReflect.Descriptor instead.

func (*Metric) GetName

func (x *Metric) GetName() string

func (*Metric) GetValue

func (x *Metric) GetValue() string

func (*Metric) ProtoMessage

func (*Metric) ProtoMessage()

func (*Metric) ProtoReflect added in v0.17.0

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

func (*Metric) Reset

func (x *Metric) Reset()

func (*Metric) String

func (x *Metric) String() string

type MetricLog

type MetricLog struct {
	TimeStamp string  `protobuf:"bytes,1,opt,name=time_stamp,json=timeStamp,proto3" json:"time_stamp,omitempty"` /// RFC3339 format
	Metric    *Metric `protobuf:"bytes,2,opt,name=metric,proto3" json:"metric,omitempty"`
	// contains filtered or unexported fields
}

func (*MetricLog) Descriptor deprecated

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

Deprecated: Use MetricLog.ProtoReflect.Descriptor instead.

func (*MetricLog) GetMetric

func (x *MetricLog) GetMetric() *Metric

func (*MetricLog) GetTimeStamp

func (x *MetricLog) GetTimeStamp() string

func (*MetricLog) ProtoMessage

func (*MetricLog) ProtoMessage()

func (*MetricLog) ProtoReflect added in v0.17.0

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

func (*MetricLog) Reset

func (x *MetricLog) Reset()

func (*MetricLog) String

func (x *MetricLog) String() string

type NasConfig

type NasConfig struct {
	GraphConfig *GraphConfig          `protobuf:"bytes,1,opt,name=graph_config,json=graphConfig,proto3" json:"graph_config,omitempty"` /// Config of DAG
	Operations  *NasConfig_Operations `protobuf:"bytes,2,opt,name=operations,proto3" json:"operations,omitempty"`                      /// List of Operation
	// contains filtered or unexported fields
}

* NasConfig contains a config of NAS job

func (*NasConfig) Descriptor deprecated

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

Deprecated: Use NasConfig.ProtoReflect.Descriptor instead.

func (*NasConfig) GetGraphConfig

func (x *NasConfig) GetGraphConfig() *GraphConfig

func (*NasConfig) GetOperations

func (x *NasConfig) GetOperations() *NasConfig_Operations

func (*NasConfig) ProtoMessage

func (*NasConfig) ProtoMessage()

func (*NasConfig) ProtoReflect added in v0.17.0

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

func (*NasConfig) Reset

func (x *NasConfig) Reset()

func (*NasConfig) String

func (x *NasConfig) String() string

type NasConfig_Operations

type NasConfig_Operations struct {
	Operation []*Operation `protobuf:"bytes,1,rep,name=operation,proto3" json:"operation,omitempty"`
	// contains filtered or unexported fields
}

func (*NasConfig_Operations) Descriptor deprecated

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

Deprecated: Use NasConfig_Operations.ProtoReflect.Descriptor instead.

func (*NasConfig_Operations) GetOperation

func (x *NasConfig_Operations) GetOperation() []*Operation

func (*NasConfig_Operations) ProtoMessage

func (*NasConfig_Operations) ProtoMessage()

func (*NasConfig_Operations) ProtoReflect added in v0.17.0

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

func (*NasConfig_Operations) Reset

func (x *NasConfig_Operations) Reset()

func (*NasConfig_Operations) String

func (x *NasConfig_Operations) String() string

type ObjectiveSpec

type ObjectiveSpec struct {
	Type                ObjectiveType `protobuf:"varint,1,opt,name=type,proto3,enum=api.v1.beta1.ObjectiveType" json:"type,omitempty"`                           // Type of optimization.
	Goal                float64       `protobuf:"fixed64,2,opt,name=goal,proto3" json:"goal,omitempty"`                                                          // Goal of optimization, can be empty.
	ObjectiveMetricName string        `protobuf:"bytes,3,opt,name=objective_metric_name,json=objectiveMetricName,proto3" json:"objective_metric_name,omitempty"` // Primary metric name for the optimization.
	// List of additional metrics to record from Trial.
	// This can be empty if we only care about the objective metric.
	AdditionalMetricNames []string `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

* Objective specification.

func (*ObjectiveSpec) Descriptor deprecated

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

Deprecated: Use ObjectiveSpec.ProtoReflect.Descriptor instead.

func (*ObjectiveSpec) GetAdditionalMetricNames

func (x *ObjectiveSpec) GetAdditionalMetricNames() []string

func (*ObjectiveSpec) GetGoal

func (x *ObjectiveSpec) GetGoal() float64

func (*ObjectiveSpec) GetObjectiveMetricName

func (x *ObjectiveSpec) GetObjectiveMetricName() string

func (*ObjectiveSpec) GetType

func (x *ObjectiveSpec) GetType() ObjectiveType

func (*ObjectiveSpec) ProtoMessage

func (*ObjectiveSpec) ProtoMessage()

func (*ObjectiveSpec) ProtoReflect added in v0.17.0

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

func (*ObjectiveSpec) Reset

func (x *ObjectiveSpec) Reset()

func (*ObjectiveSpec) String

func (x *ObjectiveSpec) String() string

type ObjectiveType

type ObjectiveType int32

* Direction of optimization. Minimize or Maximize.

const (
	ObjectiveType_UNKNOWN  ObjectiveType = 0 /// Undefined type and not used.
	ObjectiveType_MINIMIZE ObjectiveType = 1 /// Minimize
	ObjectiveType_MAXIMIZE ObjectiveType = 2 /// Maximize
)

func (ObjectiveType) Descriptor added in v0.17.0

func (ObjectiveType) Enum added in v0.17.0

func (x ObjectiveType) Enum() *ObjectiveType

func (ObjectiveType) EnumDescriptor deprecated

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

Deprecated: Use ObjectiveType.Descriptor instead.

func (ObjectiveType) Number added in v0.17.0

func (ObjectiveType) String

func (x ObjectiveType) String() string

func (ObjectiveType) Type added in v0.17.0

type Observation

type Observation struct {
	Metrics []*Metric `protobuf:"bytes,1,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// contains filtered or unexported fields
}

func (*Observation) Descriptor deprecated

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

Deprecated: Use Observation.ProtoReflect.Descriptor instead.

func (*Observation) GetMetrics

func (x *Observation) GetMetrics() []*Metric

func (*Observation) ProtoMessage

func (*Observation) ProtoMessage()

func (*Observation) ProtoReflect added in v0.17.0

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

func (*Observation) Reset

func (x *Observation) Reset()

func (*Observation) String

func (x *Observation) String() string

type ObservationLog

type ObservationLog struct {
	MetricLogs []*MetricLog `protobuf:"bytes,1,rep,name=metric_logs,json=metricLogs,proto3" json:"metric_logs,omitempty"`
	// contains filtered or unexported fields
}

func (*ObservationLog) Descriptor deprecated

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

Deprecated: Use ObservationLog.ProtoReflect.Descriptor instead.

func (*ObservationLog) GetMetricLogs

func (x *ObservationLog) GetMetricLogs() []*MetricLog

func (*ObservationLog) ProtoMessage

func (*ObservationLog) ProtoMessage()

func (*ObservationLog) ProtoReflect added in v0.17.0

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

func (*ObservationLog) Reset

func (x *ObservationLog) Reset()

func (*ObservationLog) String

func (x *ObservationLog) String() string

type Operation

type Operation struct {
	OperationType  string                    `protobuf:"bytes,1,opt,name=operation_type,json=operationType,proto3" json:"operation_type,omitempty"` /// Type of operation in DAG
	ParameterSpecs *Operation_ParameterSpecs `protobuf:"bytes,2,opt,name=parameter_specs,json=parameterSpecs,proto3" json:"parameter_specs,omitempty"`
	// contains filtered or unexported fields
}

* Config for operations in DAG

func (*Operation) Descriptor deprecated

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

Deprecated: Use Operation.ProtoReflect.Descriptor instead.

func (*Operation) GetOperationType

func (x *Operation) GetOperationType() string

func (*Operation) GetParameterSpecs

func (x *Operation) GetParameterSpecs() *Operation_ParameterSpecs

func (*Operation) ProtoMessage

func (*Operation) ProtoMessage()

func (*Operation) ProtoReflect added in v0.17.0

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

func (*Operation) Reset

func (x *Operation) Reset()

func (*Operation) String

func (x *Operation) String() string

type Operation_ParameterSpecs

type Operation_ParameterSpecs struct {
	Parameters []*ParameterSpec `protobuf:"bytes,1,rep,name=parameters,proto3" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

* List of ParameterSpec

func (*Operation_ParameterSpecs) Descriptor deprecated

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

Deprecated: Use Operation_ParameterSpecs.ProtoReflect.Descriptor instead.

func (*Operation_ParameterSpecs) GetParameters

func (x *Operation_ParameterSpecs) GetParameters() []*ParameterSpec

func (*Operation_ParameterSpecs) ProtoMessage

func (*Operation_ParameterSpecs) ProtoMessage()

func (*Operation_ParameterSpecs) ProtoReflect added in v0.17.0

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

func (*Operation_ParameterSpecs) Reset

func (x *Operation_ParameterSpecs) Reset()

func (*Operation_ParameterSpecs) String

func (x *Operation_ParameterSpecs) String() string

type ParameterAssignment

type ParameterAssignment struct {
	Name  string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ParameterAssignment) Descriptor deprecated

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

Deprecated: Use ParameterAssignment.ProtoReflect.Descriptor instead.

func (*ParameterAssignment) GetName

func (x *ParameterAssignment) GetName() string

func (*ParameterAssignment) GetValue

func (x *ParameterAssignment) GetValue() string

func (*ParameterAssignment) ProtoMessage

func (*ParameterAssignment) ProtoMessage()

func (*ParameterAssignment) ProtoReflect added in v0.17.0

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

func (*ParameterAssignment) Reset

func (x *ParameterAssignment) Reset()

func (*ParameterAssignment) String

func (x *ParameterAssignment) String() string

type ParameterSpec

type ParameterSpec struct {
	Name          string        `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` /// Name of the parameter.
	ParameterType ParameterType ``                                                              /// Type of the parameter.
	/* 133-byte string literal not displayed */
	FeasibleSpace *FeasibleSpace `protobuf:"bytes,3,opt,name=feasible_space,json=feasibleSpace,proto3" json:"feasible_space,omitempty"` /// FeasibleSpace for the parameter.
	// contains filtered or unexported fields
}

* Config for a hyperparameter. Katib will create each Hyper parameter from this config.

func (*ParameterSpec) Descriptor deprecated

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

Deprecated: Use ParameterSpec.ProtoReflect.Descriptor instead.

func (*ParameterSpec) GetFeasibleSpace

func (x *ParameterSpec) GetFeasibleSpace() *FeasibleSpace

func (*ParameterSpec) GetName

func (x *ParameterSpec) GetName() string

func (*ParameterSpec) GetParameterType

func (x *ParameterSpec) GetParameterType() ParameterType

func (*ParameterSpec) ProtoMessage

func (*ParameterSpec) ProtoMessage()

func (*ParameterSpec) ProtoReflect added in v0.17.0

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

func (*ParameterSpec) Reset

func (x *ParameterSpec) Reset()

func (*ParameterSpec) String

func (x *ParameterSpec) String() string

type ParameterType

type ParameterType int32

* Types of value for HyperParameter.

const (
	ParameterType_UNKNOWN_TYPE ParameterType = 0 /// Undefined type and not used.
	ParameterType_DOUBLE       ParameterType = 1 /// Double float type. Use "Max/Min".
	ParameterType_INT          ParameterType = 2 /// Int type. Use "Max/Min".
	ParameterType_DISCRETE     ParameterType = 3 /// Discrete number type. Use "List" as float.
	ParameterType_CATEGORICAL  ParameterType = 4 /// Categorical type. Use "List" as string.
)

func (ParameterType) Descriptor added in v0.17.0

func (ParameterType) Enum added in v0.17.0

func (x ParameterType) Enum() *ParameterType

func (ParameterType) EnumDescriptor deprecated

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

Deprecated: Use ParameterType.Descriptor instead.

func (ParameterType) Number added in v0.17.0

func (ParameterType) String

func (x ParameterType) String() string

func (ParameterType) Type added in v0.17.0

type ReportObservationLogReply

type ReportObservationLogReply struct {
	// contains filtered or unexported fields
}

func (*ReportObservationLogReply) Descriptor deprecated

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

Deprecated: Use ReportObservationLogReply.ProtoReflect.Descriptor instead.

func (*ReportObservationLogReply) ProtoMessage

func (*ReportObservationLogReply) ProtoMessage()

func (*ReportObservationLogReply) ProtoReflect added in v0.17.0

func (*ReportObservationLogReply) Reset

func (x *ReportObservationLogReply) Reset()

func (*ReportObservationLogReply) String

func (x *ReportObservationLogReply) String() string

type ReportObservationLogRequest

type ReportObservationLogRequest struct {
	TrialName      string          `protobuf:"bytes,1,opt,name=trial_name,json=trialName,proto3" json:"trial_name,omitempty"`
	ObservationLog *ObservationLog `protobuf:"bytes,2,opt,name=observation_log,json=observationLog,proto3" json:"observation_log,omitempty"`
	// contains filtered or unexported fields
}

func (*ReportObservationLogRequest) Descriptor deprecated

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

Deprecated: Use ReportObservationLogRequest.ProtoReflect.Descriptor instead.

func (*ReportObservationLogRequest) GetObservationLog

func (x *ReportObservationLogRequest) GetObservationLog() *ObservationLog

func (*ReportObservationLogRequest) GetTrialName

func (x *ReportObservationLogRequest) GetTrialName() string

func (*ReportObservationLogRequest) ProtoMessage

func (*ReportObservationLogRequest) ProtoMessage()

func (*ReportObservationLogRequest) ProtoReflect added in v0.17.0

func (*ReportObservationLogRequest) Reset

func (x *ReportObservationLogRequest) Reset()

func (*ReportObservationLogRequest) String

func (x *ReportObservationLogRequest) String() string

type SetTrialStatusReply added in v0.10.0

type SetTrialStatusReply struct {
	// contains filtered or unexported fields
}

func (*SetTrialStatusReply) Descriptor deprecated added in v0.10.0

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

Deprecated: Use SetTrialStatusReply.ProtoReflect.Descriptor instead.

func (*SetTrialStatusReply) ProtoMessage added in v0.10.0

func (*SetTrialStatusReply) ProtoMessage()

func (*SetTrialStatusReply) ProtoReflect added in v0.17.0

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

func (*SetTrialStatusReply) Reset added in v0.10.0

func (x *SetTrialStatusReply) Reset()

func (*SetTrialStatusReply) String added in v0.10.0

func (x *SetTrialStatusReply) String() string

type SetTrialStatusRequest added in v0.10.0

type SetTrialStatusRequest struct {
	TrialName string `protobuf:"bytes,1,opt,name=trial_name,json=trialName,proto3" json:"trial_name,omitempty"`
	// contains filtered or unexported fields
}

func (*SetTrialStatusRequest) Descriptor deprecated added in v0.10.0

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

Deprecated: Use SetTrialStatusRequest.ProtoReflect.Descriptor instead.

func (*SetTrialStatusRequest) GetTrialName added in v0.10.0

func (x *SetTrialStatusRequest) GetTrialName() string

func (*SetTrialStatusRequest) ProtoMessage added in v0.10.0

func (*SetTrialStatusRequest) ProtoMessage()

func (*SetTrialStatusRequest) ProtoReflect added in v0.17.0

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

func (*SetTrialStatusRequest) Reset added in v0.10.0

func (x *SetTrialStatusRequest) Reset()

func (*SetTrialStatusRequest) String added in v0.10.0

func (x *SetTrialStatusRequest) String() string

type SuggestionClient

type SuggestionClient interface {
	GetSuggestions(ctx context.Context, in *GetSuggestionsRequest, opts ...grpc.CallOption) (*GetSuggestionsReply, error)
	ValidateAlgorithmSettings(ctx context.Context, in *ValidateAlgorithmSettingsRequest, opts ...grpc.CallOption) (*ValidateAlgorithmSettingsReply, error)
}

SuggestionClient is the client API for Suggestion service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewSuggestionClient

func NewSuggestionClient(cc grpc.ClientConnInterface) SuggestionClient

type SuggestionServer

type SuggestionServer interface {
	GetSuggestions(context.Context, *GetSuggestionsRequest) (*GetSuggestionsReply, error)
	ValidateAlgorithmSettings(context.Context, *ValidateAlgorithmSettingsRequest) (*ValidateAlgorithmSettingsReply, error)
}

SuggestionServer is the server API for Suggestion service. All implementations should embed UnimplementedSuggestionServer for forward compatibility

type Trial

type Trial struct {
	Name   string       `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`     // Name for the Trial.
	Spec   *TrialSpec   `protobuf:"bytes,2,opt,name=spec,proto3" json:"spec,omitempty"`     // Trial specification.
	Status *TrialStatus `protobuf:"bytes,3,opt,name=status,proto3" json:"status,omitempty"` // Trial status.
	// contains filtered or unexported fields
}

* Structure for a single Trial.

func (*Trial) Descriptor deprecated

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

Deprecated: Use Trial.ProtoReflect.Descriptor instead.

func (*Trial) GetName

func (x *Trial) GetName() string

func (*Trial) GetSpec

func (x *Trial) GetSpec() *TrialSpec

func (*Trial) GetStatus

func (x *Trial) GetStatus() *TrialStatus

func (*Trial) ProtoMessage

func (*Trial) ProtoMessage()

func (*Trial) ProtoReflect added in v0.17.0

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

func (*Trial) Reset

func (x *Trial) Reset()

func (*Trial) String

func (x *Trial) String() string

type TrialSpec

type TrialSpec struct {
	Objective            *ObjectiveSpec                  `protobuf:"bytes,2,opt,name=objective,proto3" json:"objective,omitempty"`                                                   // Objective specification for the Trial.
	ParameterAssignments *TrialSpec_ParameterAssignments `protobuf:"bytes,3,opt,name=parameter_assignments,json=parameterAssignments,proto3" json:"parameter_assignments,omitempty"` // List of assignments generated for the Trial.
	Labels               map[string]string               ``                                                                                                                          // Map of labels assigned to the Trial
	/* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

* Specification of a Trial. It represents Trial's parameter assignments and objective.

func (*TrialSpec) Descriptor deprecated

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

Deprecated: Use TrialSpec.ProtoReflect.Descriptor instead.

func (*TrialSpec) GetLabels added in v0.14.0

func (x *TrialSpec) GetLabels() map[string]string

func (*TrialSpec) GetObjective

func (x *TrialSpec) GetObjective() *ObjectiveSpec

func (*TrialSpec) GetParameterAssignments

func (x *TrialSpec) GetParameterAssignments() *TrialSpec_ParameterAssignments

func (*TrialSpec) ProtoMessage

func (*TrialSpec) ProtoMessage()

func (*TrialSpec) ProtoReflect added in v0.17.0

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

func (*TrialSpec) Reset

func (x *TrialSpec) Reset()

func (*TrialSpec) String

func (x *TrialSpec) String() string

type TrialSpec_ParameterAssignments

type TrialSpec_ParameterAssignments struct {
	Assignments []*ParameterAssignment `protobuf:"bytes,1,rep,name=assignments,proto3" json:"assignments,omitempty"`
	// contains filtered or unexported fields
}

* List of ParameterAssignment

func (*TrialSpec_ParameterAssignments) Descriptor deprecated

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

Deprecated: Use TrialSpec_ParameterAssignments.ProtoReflect.Descriptor instead.

func (*TrialSpec_ParameterAssignments) GetAssignments

func (x *TrialSpec_ParameterAssignments) GetAssignments() []*ParameterAssignment

func (*TrialSpec_ParameterAssignments) ProtoMessage

func (*TrialSpec_ParameterAssignments) ProtoMessage()

func (*TrialSpec_ParameterAssignments) ProtoReflect added in v0.17.0

func (*TrialSpec_ParameterAssignments) Reset

func (x *TrialSpec_ParameterAssignments) Reset()

func (*TrialSpec_ParameterAssignments) String

type TrialStatus

type TrialStatus struct {
	StartTime      string                         `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`                                  // Trial start time in RFC3339 format
	CompletionTime string                         `protobuf:"bytes,2,opt,name=completion_time,json=completionTime,proto3" json:"completion_time,omitempty"`                   // Trial completion time in RFC3339 format
	Condition      TrialStatus_TrialConditionType `protobuf:"varint,3,opt,name=condition,proto3,enum=api.v1.beta1.TrialStatus_TrialConditionType" json:"condition,omitempty"` // Trial current condition. It is equal to the latest Trial CR condition.
	Observation    *Observation                   `protobuf:"bytes,4,opt,name=observation,proto3" json:"observation,omitempty"`                                               // The best Trial observation in logs.
	// contains filtered or unexported fields
}

* Current Trial status. It contains Trial's latest condition, start time, completion time, observation.

func (*TrialStatus) Descriptor deprecated

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

Deprecated: Use TrialStatus.ProtoReflect.Descriptor instead.

func (*TrialStatus) GetCompletionTime

func (x *TrialStatus) GetCompletionTime() string

func (*TrialStatus) GetCondition

func (x *TrialStatus) GetCondition() TrialStatus_TrialConditionType

func (*TrialStatus) GetObservation

func (x *TrialStatus) GetObservation() *Observation

func (*TrialStatus) GetStartTime

func (x *TrialStatus) GetStartTime() string

func (*TrialStatus) ProtoMessage

func (*TrialStatus) ProtoMessage()

func (*TrialStatus) ProtoReflect added in v0.17.0

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

func (*TrialStatus) Reset

func (x *TrialStatus) Reset()

func (*TrialStatus) String

func (x *TrialStatus) String() string

type TrialStatus_TrialConditionType

type TrialStatus_TrialConditionType int32

Trial can be in one of 8 conditions. TODO (andreyvelich): Remove unused conditions.

const (
	TrialStatus_CREATED            TrialStatus_TrialConditionType = 0
	TrialStatus_RUNNING            TrialStatus_TrialConditionType = 1
	TrialStatus_SUCCEEDED          TrialStatus_TrialConditionType = 2
	TrialStatus_KILLED             TrialStatus_TrialConditionType = 3
	TrialStatus_FAILED             TrialStatus_TrialConditionType = 4
	TrialStatus_METRICSUNAVAILABLE TrialStatus_TrialConditionType = 5
	TrialStatus_EARLYSTOPPED       TrialStatus_TrialConditionType = 6
	TrialStatus_UNKNOWN            TrialStatus_TrialConditionType = 7
)

func (TrialStatus_TrialConditionType) Descriptor added in v0.17.0

func (TrialStatus_TrialConditionType) Enum added in v0.17.0

func (TrialStatus_TrialConditionType) EnumDescriptor deprecated

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

Deprecated: Use TrialStatus_TrialConditionType.Descriptor instead.

func (TrialStatus_TrialConditionType) Number added in v0.17.0

func (TrialStatus_TrialConditionType) String

func (TrialStatus_TrialConditionType) Type added in v0.17.0

type UnimplementedDBManagerServer added in v0.17.0

type UnimplementedDBManagerServer struct {
}

UnimplementedDBManagerServer should be embedded to have forward compatible implementations.

func (UnimplementedDBManagerServer) DeleteObservationLog added in v0.17.0

func (UnimplementedDBManagerServer) GetObservationLog added in v0.17.0

func (UnimplementedDBManagerServer) ReportObservationLog added in v0.17.0

type UnimplementedEarlyStoppingServer added in v0.17.0

type UnimplementedEarlyStoppingServer struct {
}

UnimplementedEarlyStoppingServer should be embedded to have forward compatible implementations.

func (UnimplementedEarlyStoppingServer) GetEarlyStoppingRules added in v0.17.0

func (UnimplementedEarlyStoppingServer) SetTrialStatus added in v0.17.0

func (UnimplementedEarlyStoppingServer) ValidateEarlyStoppingSettings added in v0.17.0

type UnimplementedSuggestionServer added in v0.17.0

type UnimplementedSuggestionServer struct {
}

UnimplementedSuggestionServer should be embedded to have forward compatible implementations.

func (UnimplementedSuggestionServer) GetSuggestions added in v0.17.0

func (UnimplementedSuggestionServer) ValidateAlgorithmSettings added in v0.17.0

type UnsafeDBManagerServer added in v0.17.0

type UnsafeDBManagerServer interface {
	// contains filtered or unexported methods
}

UnsafeDBManagerServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DBManagerServer will result in compilation errors.

type UnsafeEarlyStoppingServer added in v0.17.0

type UnsafeEarlyStoppingServer interface {
	// contains filtered or unexported methods
}

UnsafeEarlyStoppingServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to EarlyStoppingServer will result in compilation errors.

type UnsafeSuggestionServer added in v0.17.0

type UnsafeSuggestionServer interface {
	// contains filtered or unexported methods
}

UnsafeSuggestionServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SuggestionServer will result in compilation errors.

type ValidateAlgorithmSettingsReply

type ValidateAlgorithmSettingsReply struct {
	// contains filtered or unexported fields
}

* Return INVALID_ARGUMENT Error if Algorithm Settings are not Valid

func (*ValidateAlgorithmSettingsReply) Descriptor deprecated

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

Deprecated: Use ValidateAlgorithmSettingsReply.ProtoReflect.Descriptor instead.

func (*ValidateAlgorithmSettingsReply) ProtoMessage

func (*ValidateAlgorithmSettingsReply) ProtoMessage()

func (*ValidateAlgorithmSettingsReply) ProtoReflect added in v0.17.0

func (*ValidateAlgorithmSettingsReply) Reset

func (x *ValidateAlgorithmSettingsReply) Reset()

func (*ValidateAlgorithmSettingsReply) String

type ValidateAlgorithmSettingsRequest

type ValidateAlgorithmSettingsRequest struct {
	Experiment *Experiment `protobuf:"bytes,1,opt,name=experiment,proto3" json:"experiment,omitempty"`
	// contains filtered or unexported fields
}

func (*ValidateAlgorithmSettingsRequest) Descriptor deprecated

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

Deprecated: Use ValidateAlgorithmSettingsRequest.ProtoReflect.Descriptor instead.

func (*ValidateAlgorithmSettingsRequest) GetExperiment

func (x *ValidateAlgorithmSettingsRequest) GetExperiment() *Experiment

func (*ValidateAlgorithmSettingsRequest) ProtoMessage

func (*ValidateAlgorithmSettingsRequest) ProtoMessage()

func (*ValidateAlgorithmSettingsRequest) ProtoReflect added in v0.17.0

func (*ValidateAlgorithmSettingsRequest) Reset

func (*ValidateAlgorithmSettingsRequest) String

type ValidateEarlyStoppingSettingsReply added in v0.13.0

type ValidateEarlyStoppingSettingsReply struct {
	// contains filtered or unexported fields
}

* Return INVALID_ARGUMENT Error if Early Stopping Settings are not Valid

func (*ValidateEarlyStoppingSettingsReply) Descriptor deprecated added in v0.13.0

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

Deprecated: Use ValidateEarlyStoppingSettingsReply.ProtoReflect.Descriptor instead.

func (*ValidateEarlyStoppingSettingsReply) ProtoMessage added in v0.13.0

func (*ValidateEarlyStoppingSettingsReply) ProtoMessage()

func (*ValidateEarlyStoppingSettingsReply) ProtoReflect added in v0.17.0

func (*ValidateEarlyStoppingSettingsReply) Reset added in v0.13.0

func (*ValidateEarlyStoppingSettingsReply) String added in v0.13.0

type ValidateEarlyStoppingSettingsRequest added in v0.13.0

type ValidateEarlyStoppingSettingsRequest struct {
	EarlyStopping *EarlyStoppingSpec `protobuf:"bytes,1,opt,name=early_stopping,json=earlyStopping,proto3" json:"early_stopping,omitempty"`
	// contains filtered or unexported fields
}

func (*ValidateEarlyStoppingSettingsRequest) Descriptor deprecated added in v0.13.0

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

Deprecated: Use ValidateEarlyStoppingSettingsRequest.ProtoReflect.Descriptor instead.

func (*ValidateEarlyStoppingSettingsRequest) GetEarlyStopping added in v0.13.0

func (*ValidateEarlyStoppingSettingsRequest) ProtoMessage added in v0.13.0

func (*ValidateEarlyStoppingSettingsRequest) ProtoMessage()

func (*ValidateEarlyStoppingSettingsRequest) ProtoReflect added in v0.17.0

func (*ValidateEarlyStoppingSettingsRequest) Reset added in v0.13.0

func (*ValidateEarlyStoppingSettingsRequest) String added in v0.13.0

Jump to

Keyboard shortcuts

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