api_v1_beta1

package
v0.10.1 Latest Latest
Warning

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

Go to latest
Published: Mar 2, 2021 License: Apache-2.0 Imports: 6 Imported by: 16

Documentation

Overview

Package api_v1_beta1 is a generated protocol buffer package.

It is generated from these files:

api.proto

It has these top-level messages:

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

Index

Constants

This section is empty.

Variables

View Source
var ComparisonType_name = map[int32]string{
	0: "UNKNOWN_COMPARISON",
	1: "EQUAL",
	2: "LESS",
	3: "GREATER",
}
View Source
var ComparisonType_value = map[string]int32{
	"UNKNOWN_COMPARISON": 0,
	"EQUAL":              1,
	"LESS":               2,
	"GREATER":            3,
}
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: "EARLYSTOPPED",
	6: "UNKNOWN",
}
View Source
var TrialStatus_TrialConditionType_value = map[string]int32{
	"CREATED":      0,
	"RUNNING":      1,
	"SUCCEEDED":    2,
	"KILLED":       3,
	"FAILED":       4,
	"EARLYSTOPPED": 5,
	"UNKNOWN":      6,
}

Functions

func RegisterDBManagerServer added in v0.10.0

func RegisterDBManagerServer(s *grpc.Server, srv DBManagerServer)

func RegisterEarlyStoppingServer

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

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

* HP or NAS algorithm settings.

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"`
	AlgorithmSettings []*AlgorithmSetting `protobuf:"bytes,2,rep,name=algorithm_settings,json=algorithmSettings" json:"algorithm_settings,omitempty"`
}

* HP or NAS algorithm specification.

func (*AlgorithmSpec) Descriptor

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

func (*AlgorithmSpec) GetAlgorithmName

func (m *AlgorithmSpec) GetAlgorithmName() string

func (*AlgorithmSpec) GetAlgorithmSettings

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

func (*AlgorithmSpec) ProtoMessage

func (*AlgorithmSpec) ProtoMessage()

func (*AlgorithmSpec) Reset

func (m *AlgorithmSpec) Reset()

func (*AlgorithmSpec) String

func (m *AlgorithmSpec) String() string

type ComparisonType added in v0.10.0

type ComparisonType int32
const (
	ComparisonType_UNKNOWN_COMPARISON ComparisonType = 0
	ComparisonType_EQUAL              ComparisonType = 1
	ComparisonType_LESS               ComparisonType = 2
	ComparisonType_GREATER            ComparisonType = 3
)

func (ComparisonType) EnumDescriptor added in v0.10.0

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

func (ComparisonType) String added in v0.10.0

func (x ComparisonType) String() string

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

func NewDBManagerClient added in v0.10.0

func NewDBManagerClient(cc *grpc.ClientConn) 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)
}

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 {
	GetEarlyStoppingRules(ctx context.Context, in *GetEarlyStoppingRulesRequest, opts ...grpc.CallOption) (*GetEarlyStoppingRulesReply, error)
	SetTrialStatus(ctx context.Context, in *SetTrialStatusRequest, opts ...grpc.CallOption) (*SetTrialStatusReply, error)
}

func NewEarlyStoppingClient

func NewEarlyStoppingClient(cc *grpc.ClientConn) EarlyStoppingClient

type EarlyStoppingRule added in v0.10.0

type EarlyStoppingRule struct {
	Name       string         `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Value      string         `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
	Comparison ComparisonType `protobuf:"varint,3,opt,name=comparison,enum=api.v1.beta1.ComparisonType" json:"comparison,omitempty"`
	// 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" json:"start_step,omitempty"`
}

* EarlyStoppingRule represents single early stopping rule.

func (*EarlyStoppingRule) Descriptor added in v0.10.0

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

func (*EarlyStoppingRule) GetComparison added in v0.10.0

func (m *EarlyStoppingRule) GetComparison() ComparisonType

func (*EarlyStoppingRule) GetName added in v0.10.0

func (m *EarlyStoppingRule) GetName() string

func (*EarlyStoppingRule) GetStartStep added in v0.10.0

func (m *EarlyStoppingRule) GetStartStep() int32

func (*EarlyStoppingRule) GetValue added in v0.10.0

func (m *EarlyStoppingRule) GetValue() string

func (*EarlyStoppingRule) ProtoMessage added in v0.10.0

func (*EarlyStoppingRule) ProtoMessage()

func (*EarlyStoppingRule) Reset added in v0.10.0

func (m *EarlyStoppingRule) Reset()

func (*EarlyStoppingRule) String added in v0.10.0

func (m *EarlyStoppingRule) String() string

type EarlyStoppingServer

type EarlyStoppingServer interface {
	GetEarlyStoppingRules(context.Context, *GetEarlyStoppingRulesRequest) (*GetEarlyStoppingRulesReply, error)
	SetTrialStatus(context.Context, *SetTrialStatusRequest) (*SetTrialStatusReply, error)
}

type EarlyStoppingSetting added in v0.10.0

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

* Early stopping algorithm settings.

func (*EarlyStoppingSetting) Descriptor added in v0.10.0

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

func (*EarlyStoppingSetting) GetName added in v0.10.0

func (m *EarlyStoppingSetting) GetName() string

func (*EarlyStoppingSetting) GetValue added in v0.10.0

func (m *EarlyStoppingSetting) GetValue() string

func (*EarlyStoppingSetting) ProtoMessage added in v0.10.0

func (*EarlyStoppingSetting) ProtoMessage()

func (*EarlyStoppingSetting) Reset added in v0.10.0

func (m *EarlyStoppingSetting) Reset()

func (*EarlyStoppingSetting) String added in v0.10.0

func (m *EarlyStoppingSetting) String() string

type EarlyStoppingSpec

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

* Early stopping algorithm specification.

func (*EarlyStoppingSpec) Descriptor

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

func (*EarlyStoppingSpec) GetAlgorithmName added in v0.10.0

func (m *EarlyStoppingSpec) GetAlgorithmName() string

func (*EarlyStoppingSpec) GetAlgorithmSettings added in v0.10.0

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

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

* Structure for a single Experiment.

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"`
	EarlyStopping      *EarlyStoppingSpec             `protobuf:"bytes,4,opt,name=early_stopping,json=earlyStopping" json:"early_stopping,omitempty"`
	ParallelTrialCount int32                          `protobuf:"varint,5,opt,name=parallel_trial_count,json=parallelTrialCount" json:"parallel_trial_count,omitempty"`
	MaxTrialCount      int32                          `protobuf:"varint,6,opt,name=max_trial_count,json=maxTrialCount" json:"max_trial_count,omitempty"`
	NasConfig          *NasConfig                     `protobuf:"bytes,7,opt,name=nas_config,json=nasConfig" json:"nas_config,omitempty"`
}

* 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

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

func (*ExperimentSpec) GetAlgorithm

func (m *ExperimentSpec) GetAlgorithm() *AlgorithmSpec

func (*ExperimentSpec) GetEarlyStopping added in v0.10.0

func (m *ExperimentSpec) GetEarlyStopping() *EarlyStoppingSpec

func (*ExperimentSpec) GetMaxTrialCount

func (m *ExperimentSpec) GetMaxTrialCount() int32

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) 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 GetEarlyStoppingRulesReply added in v0.10.0

type GetEarlyStoppingRulesReply struct {
	EarlyStoppingRules []*EarlyStoppingRule `protobuf:"bytes,1,rep,name=early_stopping_rules,json=earlyStoppingRules" json:"early_stopping_rules,omitempty"`
}

func (*GetEarlyStoppingRulesReply) Descriptor added in v0.10.0

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

func (*GetEarlyStoppingRulesReply) GetEarlyStoppingRules added in v0.10.0

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

func (*GetEarlyStoppingRulesReply) ProtoMessage added in v0.10.0

func (*GetEarlyStoppingRulesReply) ProtoMessage()

func (*GetEarlyStoppingRulesReply) Reset added in v0.10.0

func (m *GetEarlyStoppingRulesReply) Reset()

func (*GetEarlyStoppingRulesReply) String added in v0.10.0

func (m *GetEarlyStoppingRulesReply) String() string

type GetEarlyStoppingRulesRequest added in v0.10.0

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

func (*GetEarlyStoppingRulesRequest) Descriptor added in v0.10.0

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

func (*GetEarlyStoppingRulesRequest) GetDbManagerAddress added in v0.10.0

func (m *GetEarlyStoppingRulesRequest) GetDbManagerAddress() string

func (*GetEarlyStoppingRulesRequest) GetExperiment added in v0.10.0

func (m *GetEarlyStoppingRulesRequest) GetExperiment() *Experiment

func (*GetEarlyStoppingRulesRequest) GetTrials added in v0.10.0

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

func (*GetEarlyStoppingRulesRequest) ProtoMessage added in v0.10.0

func (*GetEarlyStoppingRulesRequest) ProtoMessage()

func (*GetEarlyStoppingRulesRequest) Reset added in v0.10.0

func (m *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" 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"`
	EarlyStoppingRules   []*EarlyStoppingRule                        `protobuf:"bytes,3,rep,name=early_stopping_rules,json=earlyStoppingRules" json:"early_stopping_rules,omitempty"`
}

func (*GetSuggestionsReply) Descriptor

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

func (*GetSuggestionsReply) GetAlgorithm

func (m *GetSuggestionsReply) GetAlgorithm() *AlgorithmSpec

func (*GetSuggestionsReply) GetEarlyStoppingRules added in v0.10.0

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

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 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.beta1.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"`
	// List of additional metrics to record from Trial.
	// This can be empty if we only care about the objective metric.
	AdditionalMetricNames []string `protobuf:"bytes,4,rep,name=additional_metric_names,json=additionalMetricNames" json:"additional_metric_names,omitempty"`
}

* Objective specification.

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  `` /* 126-byte string literal not displayed */
	FeasibleSpace *FeasibleSpace `protobuf:"bytes,3,opt,name=feasible_space,json=feasibleSpace" json:"feasible_space,omitempty"`
}

* Config for a hyperparameter. 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 SetTrialStatusReply added in v0.10.0

type SetTrialStatusReply struct {
}

func (*SetTrialStatusReply) Descriptor added in v0.10.0

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

func (*SetTrialStatusReply) ProtoMessage added in v0.10.0

func (*SetTrialStatusReply) ProtoMessage()

func (*SetTrialStatusReply) Reset added in v0.10.0

func (m *SetTrialStatusReply) Reset()

func (*SetTrialStatusReply) String added in v0.10.0

func (m *SetTrialStatusReply) String() string

type SetTrialStatusRequest added in v0.10.0

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

func (*SetTrialStatusRequest) Descriptor added in v0.10.0

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

func (*SetTrialStatusRequest) GetTrialName added in v0.10.0

func (m *SetTrialStatusRequest) GetTrialName() string

func (*SetTrialStatusRequest) ProtoMessage added in v0.10.0

func (*SetTrialStatusRequest) ProtoMessage()

func (*SetTrialStatusRequest) Reset added in v0.10.0

func (m *SetTrialStatusRequest) Reset()

func (*SetTrialStatusRequest) String added in v0.10.0

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

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

* Structure for a single Trial.

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 {
	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"`
}

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

func (*TrialSpec) Descriptor

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

func (*TrialSpec) GetObjective

func (m *TrialSpec) GetObjective() *ObjectiveSpec

func (*TrialSpec) GetParameterAssignments

func (m *TrialSpec) GetParameterAssignments() *TrialSpec_ParameterAssignments

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.beta1.TrialStatus_TrialConditionType" json:"condition,omitempty"`
	Observation    *Observation                   `protobuf:"bytes,4,opt,name=observation" json:"observation,omitempty"`
}

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

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

Trial can be in one of 6 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_EARLYSTOPPED TrialStatus_TrialConditionType = 5
	TrialStatus_UNKNOWN      TrialStatus_TrialConditionType = 6
)

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