api_v1_alpha3

package
v0.10.0 Latest Latest
Warning

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

Go to latest
Published: Nov 7, 2020 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package api_v1_alpha3 is a generated protocol buffer package.

It is generated from these files:

api.proto

It has these top-level messages:

FeasibleSpace
ParameterSpec
ObjectiveSpec
AlgorithmSetting
EarlyStoppingSpec
AlgorithmSpec
NasConfig
GraphConfig
Operation
ExperimentSpec
Experiment
ParameterAssignment
Metric
MetricLog
Observation
ObservationLog
TrialSpec
TrialStatus
Trial
ReportObservationLogRequest
ReportObservationLogReply
DeleteObservationLogRequest
DeleteObservationLogReply
GetObservationLogRequest
GetObservationLogReply
GetSuggestionsRequest
GetSuggestionsReply
ValidateAlgorithmSettingsRequest
ValidateAlgorithmSettingsReply

Package api_v1_alpha3 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var ObjectiveType_name = map[int32]string{
	0: "UNKNOWN",
	1: "MINIMIZE",
	2: "MAXIMIZE",
}
View Source
var ObjectiveType_value = map[string]int32{
	"UNKNOWN":  0,
	"MINIMIZE": 1,
	"MAXIMIZE": 2,
}
View Source
var ParameterType_name = map[int32]string{
	0: "UNKNOWN_TYPE",
	1: "DOUBLE",
	2: "INT",
	3: "DISCRETE",
	4: "CATEGORICAL",
}
View Source
var ParameterType_value = map[string]int32{
	"UNKNOWN_TYPE": 0,
	"DOUBLE":       1,
	"INT":          2,
	"DISCRETE":     3,
	"CATEGORICAL":  4,
}
View Source
var TrialStatus_TrialConditionType_name = map[int32]string{
	0: "CREATED",
	1: "RUNNING",
	2: "SUCCEEDED",
	3: "KILLED",
	4: "FAILED",
	5: "UNKNOWN",
}
View Source
var TrialStatus_TrialConditionType_value = map[string]int32{
	"CREATED":   0,
	"RUNNING":   1,
	"SUCCEEDED": 2,
	"KILLED":    3,
	"FAILED":    4,
	"UNKNOWN":   5,
}

Functions

func RegisterEarlyStoppingServer

func RegisterEarlyStoppingServer(s *grpc.Server, srv EarlyStoppingServer)

func RegisterManagerHandler

func RegisterManagerHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterManagerHandler registers the http handlers for service Manager to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterManagerHandlerFromEndpoint

func RegisterManagerHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterManagerHandlerFromEndpoint is same as RegisterManagerHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterManagerServer

func RegisterManagerServer(s *grpc.Server, srv ManagerServer)

func RegisterSuggestionServer

func RegisterSuggestionServer(s *grpc.Server, srv SuggestionServer)

Types

type AlgorithmSetting

type AlgorithmSetting struct {
	Name  string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

func (*AlgorithmSetting) Descriptor

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

func (*AlgorithmSetting) GetName

func (m *AlgorithmSetting) GetName() string

func (*AlgorithmSetting) GetValue

func (m *AlgorithmSetting) GetValue() string

func (*AlgorithmSetting) ProtoMessage

func (*AlgorithmSetting) ProtoMessage()

func (*AlgorithmSetting) Reset

func (m *AlgorithmSetting) Reset()

func (*AlgorithmSetting) String

func (m *AlgorithmSetting) String() string

type AlgorithmSpec

type AlgorithmSpec struct {
	AlgorithmName     string              `protobuf:"bytes,1,opt,name=algorithm_name,json=algorithmName" json:"algorithm_name,omitempty"`
	AlgorithmSetting  []*AlgorithmSetting `protobuf:"bytes,2,rep,name=algorithm_setting,json=algorithmSetting" json:"algorithm_setting,omitempty"`
	EarlyStoppingSpec *EarlyStoppingSpec  `protobuf:"bytes,3,opt,name=early_stopping_spec,json=earlyStoppingSpec" json:"early_stopping_spec,omitempty"`
}

func (*AlgorithmSpec) Descriptor

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

func (*AlgorithmSpec) GetAlgorithmName

func (m *AlgorithmSpec) GetAlgorithmName() string

func (*AlgorithmSpec) GetAlgorithmSetting

func (m *AlgorithmSpec) GetAlgorithmSetting() []*AlgorithmSetting

func (*AlgorithmSpec) GetEarlyStoppingSpec

func (m *AlgorithmSpec) GetEarlyStoppingSpec() *EarlyStoppingSpec

func (*AlgorithmSpec) ProtoMessage

func (*AlgorithmSpec) ProtoMessage()

func (*AlgorithmSpec) Reset

func (m *AlgorithmSpec) Reset()

func (*AlgorithmSpec) String

func (m *AlgorithmSpec) String() string

type DeleteObservationLogReply

type DeleteObservationLogReply struct {
}

func (*DeleteObservationLogReply) Descriptor

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

func (*DeleteObservationLogReply) ProtoMessage

func (*DeleteObservationLogReply) ProtoMessage()

func (*DeleteObservationLogReply) Reset

func (m *DeleteObservationLogReply) Reset()

func (*DeleteObservationLogReply) String

func (m *DeleteObservationLogReply) String() string

type DeleteObservationLogRequest

type DeleteObservationLogRequest struct {
	TrialName string `protobuf:"bytes,1,opt,name=trial_name,json=trialName" json:"trial_name,omitempty"`
}

func (*DeleteObservationLogRequest) Descriptor

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

func (*DeleteObservationLogRequest) GetTrialName

func (m *DeleteObservationLogRequest) GetTrialName() string

func (*DeleteObservationLogRequest) ProtoMessage

func (*DeleteObservationLogRequest) ProtoMessage()

func (*DeleteObservationLogRequest) Reset

func (m *DeleteObservationLogRequest) Reset()

func (*DeleteObservationLogRequest) String

func (m *DeleteObservationLogRequest) String() string

type EarlyStoppingClient

type EarlyStoppingClient interface {
}

func NewEarlyStoppingClient

func NewEarlyStoppingClient(cc *grpc.ClientConn) EarlyStoppingClient

type EarlyStoppingServer

type EarlyStoppingServer interface {
}

type EarlyStoppingSpec

type EarlyStoppingSpec struct {
}

func (*EarlyStoppingSpec) Descriptor

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

func (*EarlyStoppingSpec) ProtoMessage

func (*EarlyStoppingSpec) ProtoMessage()

func (*EarlyStoppingSpec) Reset

func (m *EarlyStoppingSpec) Reset()

func (*EarlyStoppingSpec) String

func (m *EarlyStoppingSpec) String() string

type Experiment

type Experiment struct {
	Name string          `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Spec *ExperimentSpec `protobuf:"bytes,2,opt,name=spec" json:"spec,omitempty"`
}

func (*Experiment) Descriptor

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

func (*Experiment) GetName

func (m *Experiment) GetName() string

func (*Experiment) GetSpec

func (m *Experiment) GetSpec() *ExperimentSpec

func (*Experiment) ProtoMessage

func (*Experiment) ProtoMessage()

func (*Experiment) Reset

func (m *Experiment) Reset()

func (*Experiment) String

func (m *Experiment) String() string

type ExperimentSpec

type ExperimentSpec struct {
	ParameterSpecs       *ExperimentSpec_ParameterSpecs `protobuf:"bytes,1,opt,name=parameter_specs,json=parameterSpecs" json:"parameter_specs,omitempty"`
	Objective            *ObjectiveSpec                 `protobuf:"bytes,2,opt,name=objective" json:"objective,omitempty"`
	Algorithm            *AlgorithmSpec                 `protobuf:"bytes,3,opt,name=algorithm" json:"algorithm,omitempty"`
	TrialTemplate        string                         `protobuf:"bytes,4,opt,name=trial_template,json=trialTemplate" json:"trial_template,omitempty"`
	MetricsCollectorSpec string                         `protobuf:"bytes,5,opt,name=metrics_collector_spec,json=metricsCollectorSpec" json:"metrics_collector_spec,omitempty"`
	ParallelTrialCount   int32                          `protobuf:"varint,6,opt,name=parallel_trial_count,json=parallelTrialCount" json:"parallel_trial_count,omitempty"`
	MaxTrialCount        int32                          `protobuf:"varint,7,opt,name=max_trial_count,json=maxTrialCount" json:"max_trial_count,omitempty"`
	NasConfig            *NasConfig                     `protobuf:"bytes,8,opt,name=nas_config,json=nasConfig" json:"nas_config,omitempty"`
}

* Spec of a 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 a Experiment.

func (*ExperimentSpec) Descriptor

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

func (*ExperimentSpec) GetAlgorithm

func (m *ExperimentSpec) GetAlgorithm() *AlgorithmSpec

func (*ExperimentSpec) GetMaxTrialCount

func (m *ExperimentSpec) GetMaxTrialCount() int32

func (*ExperimentSpec) GetMetricsCollectorSpec

func (m *ExperimentSpec) GetMetricsCollectorSpec() string

func (*ExperimentSpec) GetNasConfig

func (m *ExperimentSpec) GetNasConfig() *NasConfig

func (*ExperimentSpec) GetObjective

func (m *ExperimentSpec) GetObjective() *ObjectiveSpec

func (*ExperimentSpec) GetParallelTrialCount

func (m *ExperimentSpec) GetParallelTrialCount() int32

func (*ExperimentSpec) GetParameterSpecs

func (m *ExperimentSpec) GetParameterSpecs() *ExperimentSpec_ParameterSpecs

func (*ExperimentSpec) GetTrialTemplate

func (m *ExperimentSpec) GetTrialTemplate() string

func (*ExperimentSpec) ProtoMessage

func (*ExperimentSpec) ProtoMessage()

func (*ExperimentSpec) Reset

func (m *ExperimentSpec) Reset()

func (*ExperimentSpec) String

func (m *ExperimentSpec) String() string

type ExperimentSpec_ParameterSpecs

type ExperimentSpec_ParameterSpecs struct {
	Parameters []*ParameterSpec `protobuf:"bytes,1,rep,name=parameters" json:"parameters,omitempty"`
}

* List of ParameterSpec

func (*ExperimentSpec_ParameterSpecs) Descriptor

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

func (*ExperimentSpec_ParameterSpecs) GetParameters

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

func (*ExperimentSpec_ParameterSpecs) ProtoMessage

func (*ExperimentSpec_ParameterSpecs) ProtoMessage()

func (*ExperimentSpec_ParameterSpecs) Reset

func (m *ExperimentSpec_ParameterSpecs) Reset()

func (*ExperimentSpec_ParameterSpecs) String

type FeasibleSpace

type FeasibleSpace struct {
	Max  string   `protobuf:"bytes,1,opt,name=max" json:"max,omitempty"`
	Min  string   `protobuf:"bytes,2,opt,name=min" json:"min,omitempty"`
	List []string `protobuf:"bytes,3,rep,name=list" json:"list,omitempty"`
	Step string   `protobuf:"bytes,4,opt,name=step" json:"step,omitempty"`
}

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

func (*FeasibleSpace) Descriptor

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

func (*FeasibleSpace) GetList

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

func (*FeasibleSpace) GetMax

func (m *FeasibleSpace) GetMax() string

func (*FeasibleSpace) GetMin

func (m *FeasibleSpace) GetMin() string

func (*FeasibleSpace) GetStep

func (m *FeasibleSpace) GetStep() string

func (*FeasibleSpace) ProtoMessage

func (*FeasibleSpace) ProtoMessage()

func (*FeasibleSpace) Reset

func (m *FeasibleSpace) Reset()

func (*FeasibleSpace) String

func (m *FeasibleSpace) String() string

type GetObservationLogReply

type GetObservationLogReply struct {
	ObservationLog *ObservationLog `protobuf:"bytes,1,opt,name=observation_log,json=observationLog" json:"observation_log,omitempty"`
}

func (*GetObservationLogReply) Descriptor

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

func (*GetObservationLogReply) GetObservationLog

func (m *GetObservationLogReply) GetObservationLog() *ObservationLog

func (*GetObservationLogReply) ProtoMessage

func (*GetObservationLogReply) ProtoMessage()

func (*GetObservationLogReply) Reset

func (m *GetObservationLogReply) Reset()

func (*GetObservationLogReply) String

func (m *GetObservationLogReply) String() string

type GetObservationLogRequest

type GetObservationLogRequest struct {
	TrialName  string `protobuf:"bytes,1,opt,name=trial_name,json=trialName" json:"trial_name,omitempty"`
	MetricName string `protobuf:"bytes,2,opt,name=metric_name,json=metricName" json:"metric_name,omitempty"`
	StartTime  string `protobuf:"bytes,3,opt,name=start_time,json=startTime" json:"start_time,omitempty"`
	EndTime    string `protobuf:"bytes,4,opt,name=end_time,json=endTime" json:"end_time,omitempty"`
}

func (*GetObservationLogRequest) Descriptor

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

func (*GetObservationLogRequest) GetEndTime

func (m *GetObservationLogRequest) GetEndTime() string

func (*GetObservationLogRequest) GetMetricName

func (m *GetObservationLogRequest) GetMetricName() string

func (*GetObservationLogRequest) GetStartTime

func (m *GetObservationLogRequest) GetStartTime() string

func (*GetObservationLogRequest) GetTrialName

func (m *GetObservationLogRequest) GetTrialName() string

func (*GetObservationLogRequest) ProtoMessage

func (*GetObservationLogRequest) ProtoMessage()

func (*GetObservationLogRequest) Reset

func (m *GetObservationLogRequest) Reset()

func (*GetObservationLogRequest) String

func (m *GetObservationLogRequest) String() string

type GetSuggestionsReply

type GetSuggestionsReply struct {
	ParameterAssignments []*GetSuggestionsReply_ParameterAssignments `protobuf:"bytes,1,rep,name=parameter_assignments,json=parameterAssignments" json:"parameter_assignments,omitempty"`
	Algorithm            *AlgorithmSpec                              `protobuf:"bytes,2,opt,name=algorithm" json:"algorithm,omitempty"`
}

func (*GetSuggestionsReply) Descriptor

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

func (*GetSuggestionsReply) GetAlgorithm

func (m *GetSuggestionsReply) GetAlgorithm() *AlgorithmSpec

func (*GetSuggestionsReply) GetParameterAssignments

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

func (*GetSuggestionsReply) ProtoMessage

func (*GetSuggestionsReply) ProtoMessage()

func (*GetSuggestionsReply) Reset

func (m *GetSuggestionsReply) Reset()

func (*GetSuggestionsReply) String

func (m *GetSuggestionsReply) String() string

type GetSuggestionsReply_ParameterAssignments

type GetSuggestionsReply_ParameterAssignments struct {
	Assignments []*ParameterAssignment `protobuf:"bytes,1,rep,name=assignments" json:"assignments,omitempty"`
}

func (*GetSuggestionsReply_ParameterAssignments) Descriptor

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

func (*GetSuggestionsReply_ParameterAssignments) GetAssignments

func (*GetSuggestionsReply_ParameterAssignments) ProtoMessage

func (*GetSuggestionsReply_ParameterAssignments) Reset

func (*GetSuggestionsReply_ParameterAssignments) String

type GetSuggestionsRequest

type GetSuggestionsRequest struct {
	Experiment    *Experiment `protobuf:"bytes,1,opt,name=experiment" json:"experiment,omitempty"`
	Trials        []*Trial    `protobuf:"bytes,2,rep,name=trials" json:"trials,omitempty"`
	RequestNumber int32       `protobuf:"varint,3,opt,name=request_number,json=requestNumber" json:"request_number,omitempty"`
}

func (*GetSuggestionsRequest) Descriptor

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

func (*GetSuggestionsRequest) GetExperiment

func (m *GetSuggestionsRequest) GetExperiment() *Experiment

func (*GetSuggestionsRequest) GetRequestNumber

func (m *GetSuggestionsRequest) GetRequestNumber() int32

func (*GetSuggestionsRequest) GetTrials

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

func (*GetSuggestionsRequest) ProtoMessage

func (*GetSuggestionsRequest) ProtoMessage()

func (*GetSuggestionsRequest) Reset

func (m *GetSuggestionsRequest) Reset()

func (*GetSuggestionsRequest) String

func (m *GetSuggestionsRequest) String() string

type GraphConfig

type GraphConfig struct {
	NumLayers   int32   `protobuf:"varint,1,opt,name=num_layers,json=numLayers" json:"num_layers,omitempty"`
	InputSizes  []int32 `protobuf:"varint,2,rep,packed,name=input_sizes,json=inputSizes" json:"input_sizes,omitempty"`
	OutputSizes []int32 `protobuf:"varint,3,rep,packed,name=output_sizes,json=outputSizes" json:"output_sizes,omitempty"`
}

* GraphConfig contains a config of DAG

func (*GraphConfig) Descriptor

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

func (*GraphConfig) GetInputSizes

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

func (*GraphConfig) GetNumLayers

func (m *GraphConfig) GetNumLayers() int32

func (*GraphConfig) GetOutputSizes

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

func (*GraphConfig) ProtoMessage

func (*GraphConfig) ProtoMessage()

func (*GraphConfig) Reset

func (m *GraphConfig) Reset()

func (*GraphConfig) String

func (m *GraphConfig) String() string

type ManagerClient

type ManagerClient 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)
}

func NewManagerClient

func NewManagerClient(cc *grpc.ClientConn) ManagerClient

type ManagerServer

type ManagerServer 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)
}

type Metric

type Metric struct {
	Name  string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

func (*Metric) Descriptor

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

func (*Metric) GetName

func (m *Metric) GetName() string

func (*Metric) GetValue

func (m *Metric) GetValue() string

func (*Metric) ProtoMessage

func (*Metric) ProtoMessage()

func (*Metric) Reset

func (m *Metric) Reset()

func (*Metric) String

func (m *Metric) String() string

type MetricLog

type MetricLog struct {
	TimeStamp string  `protobuf:"bytes,1,opt,name=time_stamp,json=timeStamp" json:"time_stamp,omitempty"`
	Metric    *Metric `protobuf:"bytes,2,opt,name=metric" json:"metric,omitempty"`
}

func (*MetricLog) Descriptor

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

func (*MetricLog) GetMetric

func (m *MetricLog) GetMetric() *Metric

func (*MetricLog) GetTimeStamp

func (m *MetricLog) GetTimeStamp() string

func (*MetricLog) ProtoMessage

func (*MetricLog) ProtoMessage()

func (*MetricLog) Reset

func (m *MetricLog) Reset()

func (*MetricLog) String

func (m *MetricLog) String() string

type NasConfig

type NasConfig struct {
	GraphConfig *GraphConfig          `protobuf:"bytes,1,opt,name=graph_config,json=graphConfig" json:"graph_config,omitempty"`
	Operations  *NasConfig_Operations `protobuf:"bytes,2,opt,name=operations" json:"operations,omitempty"`
}

* NasConfig contains a config of NAS job

func (*NasConfig) Descriptor

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

func (*NasConfig) GetGraphConfig

func (m *NasConfig) GetGraphConfig() *GraphConfig

func (*NasConfig) GetOperations

func (m *NasConfig) GetOperations() *NasConfig_Operations

func (*NasConfig) ProtoMessage

func (*NasConfig) ProtoMessage()

func (*NasConfig) Reset

func (m *NasConfig) Reset()

func (*NasConfig) String

func (m *NasConfig) String() string

type NasConfig_Operations

type NasConfig_Operations struct {
	Operation []*Operation `protobuf:"bytes,1,rep,name=operation" json:"operation,omitempty"`
}

func (*NasConfig_Operations) Descriptor

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

func (*NasConfig_Operations) GetOperation

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

func (*NasConfig_Operations) ProtoMessage

func (*NasConfig_Operations) ProtoMessage()

func (*NasConfig_Operations) Reset

func (m *NasConfig_Operations) Reset()

func (*NasConfig_Operations) String

func (m *NasConfig_Operations) String() string

type ObjectiveSpec

type ObjectiveSpec struct {
	Type                  ObjectiveType `protobuf:"varint,1,opt,name=type,enum=api.v1.alpha3.ObjectiveType" json:"type,omitempty"`
	Goal                  float64       `protobuf:"fixed64,2,opt,name=goal" json:"goal,omitempty"`
	ObjectiveMetricName   string        `protobuf:"bytes,3,opt,name=objective_metric_name,json=objectiveMetricName" json:"objective_metric_name,omitempty"`
	AdditionalMetricNames []string      `protobuf:"bytes,4,rep,name=additional_metric_names,json=additionalMetricNames" json:"additional_metric_names,omitempty"`
}

func (*ObjectiveSpec) Descriptor

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

func (*ObjectiveSpec) GetAdditionalMetricNames

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

func (*ObjectiveSpec) GetGoal

func (m *ObjectiveSpec) GetGoal() float64

func (*ObjectiveSpec) GetObjectiveMetricName

func (m *ObjectiveSpec) GetObjectiveMetricName() string

func (*ObjectiveSpec) GetType

func (m *ObjectiveSpec) GetType() ObjectiveType

func (*ObjectiveSpec) ProtoMessage

func (*ObjectiveSpec) ProtoMessage()

func (*ObjectiveSpec) Reset

func (m *ObjectiveSpec) Reset()

func (*ObjectiveSpec) String

func (m *ObjectiveSpec) String() string

type ObjectiveType

type ObjectiveType int32

* Direction of optimization. Minimize or Maximize.

const (
	ObjectiveType_UNKNOWN  ObjectiveType = 0
	ObjectiveType_MINIMIZE ObjectiveType = 1
	ObjectiveType_MAXIMIZE ObjectiveType = 2
)

func (ObjectiveType) EnumDescriptor

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

func (ObjectiveType) String

func (x ObjectiveType) String() string

type Observation

type Observation struct {
	Metrics []*Metric `protobuf:"bytes,1,rep,name=metrics" json:"metrics,omitempty"`
}

func (*Observation) Descriptor

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

func (*Observation) GetMetrics

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

func (*Observation) ProtoMessage

func (*Observation) ProtoMessage()

func (*Observation) Reset

func (m *Observation) Reset()

func (*Observation) String

func (m *Observation) String() string

type ObservationLog

type ObservationLog struct {
	MetricLogs []*MetricLog `protobuf:"bytes,1,rep,name=metric_logs,json=metricLogs" json:"metric_logs,omitempty"`
}

func (*ObservationLog) Descriptor

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

func (*ObservationLog) GetMetricLogs

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

func (*ObservationLog) ProtoMessage

func (*ObservationLog) ProtoMessage()

func (*ObservationLog) Reset

func (m *ObservationLog) Reset()

func (*ObservationLog) String

func (m *ObservationLog) String() string

type Operation

type Operation struct {
	OperationType  string                    `protobuf:"bytes,1,opt,name=operation_type,json=operationType" json:"operation_type,omitempty"`
	ParameterSpecs *Operation_ParameterSpecs `protobuf:"bytes,2,opt,name=parameter_specs,json=parameterSpecs" json:"parameter_specs,omitempty"`
}

* Config for operations in DAG

func (*Operation) Descriptor

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

func (*Operation) GetOperationType

func (m *Operation) GetOperationType() string

func (*Operation) GetParameterSpecs

func (m *Operation) GetParameterSpecs() *Operation_ParameterSpecs

func (*Operation) ProtoMessage

func (*Operation) ProtoMessage()

func (*Operation) Reset

func (m *Operation) Reset()

func (*Operation) String

func (m *Operation) String() string

type Operation_ParameterSpecs

type Operation_ParameterSpecs struct {
	Parameters []*ParameterSpec `protobuf:"bytes,1,rep,name=parameters" json:"parameters,omitempty"`
}

* List of ParameterSpec

func (*Operation_ParameterSpecs) Descriptor

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

func (*Operation_ParameterSpecs) GetParameters

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

func (*Operation_ParameterSpecs) ProtoMessage

func (*Operation_ParameterSpecs) ProtoMessage()

func (*Operation_ParameterSpecs) Reset

func (m *Operation_ParameterSpecs) Reset()

func (*Operation_ParameterSpecs) String

func (m *Operation_ParameterSpecs) String() string

type ParameterAssignment

type ParameterAssignment struct {
	Name  string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

func (*ParameterAssignment) Descriptor

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

func (*ParameterAssignment) GetName

func (m *ParameterAssignment) GetName() string

func (*ParameterAssignment) GetValue

func (m *ParameterAssignment) GetValue() string

func (*ParameterAssignment) ProtoMessage

func (*ParameterAssignment) ProtoMessage()

func (*ParameterAssignment) Reset

func (m *ParameterAssignment) Reset()

func (*ParameterAssignment) String

func (m *ParameterAssignment) String() string

type ParameterSpec

type ParameterSpec struct {
	Name          string         `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	ParameterType ParameterType  `` /* 127-byte string literal not displayed */
	FeasibleSpace *FeasibleSpace `protobuf:"bytes,3,opt,name=feasible_space,json=feasibleSpace" json:"feasible_space,omitempty"`
}

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

func (*ParameterSpec) Descriptor

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

func (*ParameterSpec) GetFeasibleSpace

func (m *ParameterSpec) GetFeasibleSpace() *FeasibleSpace

func (*ParameterSpec) GetName

func (m *ParameterSpec) GetName() string

func (*ParameterSpec) GetParameterType

func (m *ParameterSpec) GetParameterType() ParameterType

func (*ParameterSpec) ProtoMessage

func (*ParameterSpec) ProtoMessage()

func (*ParameterSpec) Reset

func (m *ParameterSpec) Reset()

func (*ParameterSpec) String

func (m *ParameterSpec) String() string

type ParameterType

type ParameterType int32

* Types of value for HyperParameter.

const (
	ParameterType_UNKNOWN_TYPE ParameterType = 0
	ParameterType_DOUBLE       ParameterType = 1
	ParameterType_INT          ParameterType = 2
	ParameterType_DISCRETE     ParameterType = 3
	ParameterType_CATEGORICAL  ParameterType = 4
)

func (ParameterType) EnumDescriptor

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

func (ParameterType) String

func (x ParameterType) String() string

type ReportObservationLogReply

type ReportObservationLogReply struct {
}

func (*ReportObservationLogReply) Descriptor

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

func (*ReportObservationLogReply) ProtoMessage

func (*ReportObservationLogReply) ProtoMessage()

func (*ReportObservationLogReply) Reset

func (m *ReportObservationLogReply) Reset()

func (*ReportObservationLogReply) String

func (m *ReportObservationLogReply) String() string

type ReportObservationLogRequest

type ReportObservationLogRequest struct {
	TrialName      string          `protobuf:"bytes,1,opt,name=trial_name,json=trialName" json:"trial_name,omitempty"`
	ObservationLog *ObservationLog `protobuf:"bytes,2,opt,name=observation_log,json=observationLog" json:"observation_log,omitempty"`
}

func (*ReportObservationLogRequest) Descriptor

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

func (*ReportObservationLogRequest) GetObservationLog

func (m *ReportObservationLogRequest) GetObservationLog() *ObservationLog

func (*ReportObservationLogRequest) GetTrialName

func (m *ReportObservationLogRequest) GetTrialName() string

func (*ReportObservationLogRequest) ProtoMessage

func (*ReportObservationLogRequest) ProtoMessage()

func (*ReportObservationLogRequest) Reset

func (m *ReportObservationLogRequest) Reset()

func (*ReportObservationLogRequest) String

func (m *ReportObservationLogRequest) 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)
}

func NewSuggestionClient

func NewSuggestionClient(cc *grpc.ClientConn) SuggestionClient

type SuggestionServer

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

type Trial

type Trial struct {
	Name   string       `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Spec   *TrialSpec   `protobuf:"bytes,2,opt,name=spec" json:"spec,omitempty"`
	Status *TrialStatus `protobuf:"bytes,3,opt,name=status" json:"status,omitempty"`
}

func (*Trial) Descriptor

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

func (*Trial) GetName

func (m *Trial) GetName() string

func (*Trial) GetSpec

func (m *Trial) GetSpec() *TrialSpec

func (*Trial) GetStatus

func (m *Trial) GetStatus() *TrialStatus

func (*Trial) ProtoMessage

func (*Trial) ProtoMessage()

func (*Trial) Reset

func (m *Trial) Reset()

func (*Trial) String

func (m *Trial) String() string

type TrialSpec

type TrialSpec struct {
	ExperimentName       string                          `protobuf:"bytes,1,opt,name=experiment_name,json=experimentName" json:"experiment_name,omitempty"`
	Objective            *ObjectiveSpec                  `protobuf:"bytes,2,opt,name=objective" json:"objective,omitempty"`
	ParameterAssignments *TrialSpec_ParameterAssignments `protobuf:"bytes,3,opt,name=parameter_assignments,json=parameterAssignments" json:"parameter_assignments,omitempty"`
	RunSpec              string                          `protobuf:"bytes,4,opt,name=run_spec,json=runSpec" json:"run_spec,omitempty"`
	MetricsCollectorSpec string                          `protobuf:"bytes,5,opt,name=metrics_collector_spec,json=metricsCollectorSpec" json:"metrics_collector_spec,omitempty"`
}

func (*TrialSpec) Descriptor

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

func (*TrialSpec) GetExperimentName

func (m *TrialSpec) GetExperimentName() string

func (*TrialSpec) GetMetricsCollectorSpec

func (m *TrialSpec) GetMetricsCollectorSpec() string

func (*TrialSpec) GetObjective

func (m *TrialSpec) GetObjective() *ObjectiveSpec

func (*TrialSpec) GetParameterAssignments

func (m *TrialSpec) GetParameterAssignments() *TrialSpec_ParameterAssignments

func (*TrialSpec) GetRunSpec

func (m *TrialSpec) GetRunSpec() string

func (*TrialSpec) ProtoMessage

func (*TrialSpec) ProtoMessage()

func (*TrialSpec) Reset

func (m *TrialSpec) Reset()

func (*TrialSpec) String

func (m *TrialSpec) String() string

type TrialSpec_ParameterAssignments

type TrialSpec_ParameterAssignments struct {
	Assignments []*ParameterAssignment `protobuf:"bytes,1,rep,name=assignments" json:"assignments,omitempty"`
}

* List of ParameterAssignment

func (*TrialSpec_ParameterAssignments) Descriptor

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

func (*TrialSpec_ParameterAssignments) GetAssignments

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

func (*TrialSpec_ParameterAssignments) ProtoMessage

func (*TrialSpec_ParameterAssignments) ProtoMessage()

func (*TrialSpec_ParameterAssignments) Reset

func (m *TrialSpec_ParameterAssignments) Reset()

func (*TrialSpec_ParameterAssignments) String

type TrialStatus

type TrialStatus struct {
	StartTime      string                         `protobuf:"bytes,1,opt,name=start_time,json=startTime" json:"start_time,omitempty"`
	CompletionTime string                         `protobuf:"bytes,2,opt,name=completion_time,json=completionTime" json:"completion_time,omitempty"`
	Condition      TrialStatus_TrialConditionType `protobuf:"varint,3,opt,name=condition,enum=api.v1.alpha3.TrialStatus_TrialConditionType" json:"condition,omitempty"`
	Observation    *Observation                   `protobuf:"bytes,4,opt,name=observation" json:"observation,omitempty"`
}

func (*TrialStatus) Descriptor

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

func (*TrialStatus) GetCompletionTime

func (m *TrialStatus) GetCompletionTime() string

func (*TrialStatus) GetCondition

func (m *TrialStatus) GetCondition() TrialStatus_TrialConditionType

func (*TrialStatus) GetObservation

func (m *TrialStatus) GetObservation() *Observation

func (*TrialStatus) GetStartTime

func (m *TrialStatus) GetStartTime() string

func (*TrialStatus) ProtoMessage

func (*TrialStatus) ProtoMessage()

func (*TrialStatus) Reset

func (m *TrialStatus) Reset()

func (*TrialStatus) String

func (m *TrialStatus) String() string

type TrialStatus_TrialConditionType

type TrialStatus_TrialConditionType int32
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_UNKNOWN   TrialStatus_TrialConditionType = 5
)

func (TrialStatus_TrialConditionType) EnumDescriptor

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

func (TrialStatus_TrialConditionType) String

type ValidateAlgorithmSettingsReply

type ValidateAlgorithmSettingsReply struct {
}

* Return INVALID_ARGUMENT Error if Algorithm Settings are not Valid

func (*ValidateAlgorithmSettingsReply) Descriptor

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

func (*ValidateAlgorithmSettingsReply) ProtoMessage

func (*ValidateAlgorithmSettingsReply) ProtoMessage()

func (*ValidateAlgorithmSettingsReply) Reset

func (m *ValidateAlgorithmSettingsReply) Reset()

func (*ValidateAlgorithmSettingsReply) String

type ValidateAlgorithmSettingsRequest

type ValidateAlgorithmSettingsRequest struct {
	Experiment *Experiment `protobuf:"bytes,1,opt,name=experiment" json:"experiment,omitempty"`
}

func (*ValidateAlgorithmSettingsRequest) Descriptor

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

func (*ValidateAlgorithmSettingsRequest) GetExperiment

func (m *ValidateAlgorithmSettingsRequest) GetExperiment() *Experiment

func (*ValidateAlgorithmSettingsRequest) ProtoMessage

func (*ValidateAlgorithmSettingsRequest) ProtoMessage()

func (*ValidateAlgorithmSettingsRequest) Reset

func (*ValidateAlgorithmSettingsRequest) String

Jump to

Keyboard shortcuts

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