fix(api): resolve all api voilation exceptions in katib api

Signed-off-by: truc0 <[email protected]>

Author: truc0

hack/violation_exception_v1beta1.list

@@ -1,30 +0,0 @@
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/common/v1beta1,AlgorithmSpec,AlgorithmSettings
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/common/v1beta1,EarlyStoppingSpec,AlgorithmSettings
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/common/v1beta1,FilterSpec,MetricsFormat
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/common/v1beta1,ObjectiveSpec,AdditionalMetricNames
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/common/v1beta1,ObjectiveSpec,MetricStrategies
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/common/v1beta1,Observation,Metrics
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,ExperimentSpec,Parameters
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,ExperimentStatus,Conditions
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,ExperimentStatus,EarlyStoppedTrialList
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,ExperimentStatus,FailedTrialList
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,ExperimentStatus,KilledTrialList
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,ExperimentStatus,MetricsUnavailableTrialList
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,ExperimentStatus,PendingTrialList
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,ExperimentStatus,RunningTrialList
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,ExperimentStatus,SucceededTrialList
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,FeasibleSpace,List
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,GraphConfig,InputSizes
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,GraphConfig,OutputSizes
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,NasConfig,Operations
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,Operation,Parameters
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,OptimalTrial,ParameterAssignments
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1,TrialTemplate,TrialParameters
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/suggestions/v1beta1,SuggestionStatus,AlgorithmSettings
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/suggestions/v1beta1,SuggestionStatus,Conditions
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/suggestions/v1beta1,SuggestionStatus,Suggestions
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/suggestions/v1beta1,TrialAssignment,EarlyStoppingRules
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/suggestions/v1beta1,TrialAssignment,ParameterAssignments
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/trials/v1beta1,TrialSpec,EarlyStoppingRules
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/trials/v1beta1,TrialSpec,ParameterAssignments
-API rule violation: list_type_missing,github.com/kubeflow/katib/pkg/apis/controller/trials/v1beta1,TrialStatus,Conditions

pkg/apis/controller/common/v1beta1/common_types.go

@@ -27,6 +27,9 @@ type AlgorithmSpec struct {
 	AlgorithmName string `json:"algorithmName,omitempty"`
 
 	// Key-value pairs representing settings for suggestion algorithms.
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
 	AlgorithmSettings []AlgorithmSetting `json:"algorithmSettings,omitempty"`
 }
 
@@ -46,6 +49,9 @@ type EarlyStoppingSpec struct {
 	AlgorithmName string `json:"algorithmName,omitempty"`
 
 	// Key-value pairs representing settings for early stopping algorithm.
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
 	AlgorithmSettings []EarlyStoppingSetting `json:"algorithmSettings,omitempty"`
 }
 
@@ -105,10 +111,15 @@ type ObjectiveSpec struct {
 	// AdditionalMetricNames represents metrics that should be collected from Trials.
 	// This can be empty if we only care about the objective metric.
 	// Note: If we adopt a push instead of pull mechanism, this can be omitted completely.
+	// +listType=set
+	// +optional
 	AdditionalMetricNames []string `json:"additionalMetricNames,omitempty"`
 
 	// MetricStrategies defines various rules (min, max or latest) to extract metrics values.
 	// This field is allowed to missing, experiment defaulter (webhook) will fill it.
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
 	MetricStrategies []MetricStrategy `json:"metricStrategies,omitempty"`
 }
 
@@ -150,6 +161,9 @@ type Metric struct {
 // +k8s:deepcopy-gen=true
 type Observation struct {
 	// Key-value pairs for metric names and values
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
 	Metrics []Metric `json:"metrics,omitempty"`
 }
 
@@ -177,6 +191,8 @@ type SourceSpec struct {
 type FilterSpec struct {
 	// When the metrics output follows format as this field specified, metricsCollector
 	// collects it and reports to metrics server, it can be "<metric_name>: <float>" or else
+	// +listType=set
+	// +optional
 	MetricsFormat []string `json:"metricsFormat,omitempty"`
 }
 

pkg/apis/controller/experiments/v1beta1/experiment_types.go

@@ -26,6 +26,9 @@ import (
 // ExperimentSpec is the specification of an Experiment.
 type ExperimentSpec struct {
 	// List of hyperparameter configurations.
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
 	Parameters []ParameterSpec `json:"parameters,omitempty"`
 
 	// Describes the objective of the experiment.
@@ -78,30 +81,47 @@ type ExperimentStatus struct {
 	LastReconcileTime *metav1.Time `json:"lastReconcileTime,omitempty"`
 
 	// List of observed runtime conditions for this Experiment.
+	// +listType=map
+	// +listMapKey=Type
+	// +optional
 	Conditions []ExperimentCondition `json:"conditions,omitempty"`
 
 	// Current optimal trial parameters and observations.
 	CurrentOptimalTrial OptimalTrial `json:"currentOptimalTrial,omitempty"`
 
 	// List of trial names which are running.
+	// +listType=set
+	// +optional
 	RunningTrialList []string `json:"runningTrialList,omitempty"`
 
 	// List of trial names which are pending.
+	// +listType=set
+	// +optional
 	PendingTrialList []string `json:"pendingTrialList,omitempty"`
 
 	// List of trial names which have already failed.
+	// +listType=set
+	// +optional
 	FailedTrialList []string `json:"failedTrialList,omitempty"`
 
 	// List of trial names which have already succeeded.
+	// +listType=set
+	// +optional
 	SucceededTrialList []string `json:"succeededTrialList,omitempty"`
 
 	// List of trial names which have been killed.
+	// +listType=set
+	// +optional
 	KilledTrialList []string `json:"killedTrialList,omitempty"`
 
 	// List of trial names which have been early stopped.
+	// +listType=set
+	// +optional
 	EarlyStoppedTrialList []string `json:"earlyStoppedTrialList,omitempty"`
 
 	// List of trial names which have been metrics unavailable
+	// +listType=set
+	// +optional
 	MetricsUnavailableTrialList []string `json:"metricsUnavailableTrialList,omitempty"`
 
 	// Trials is the total number of trials owned by the experiment.
@@ -134,6 +154,9 @@ type OptimalTrial struct {
 	// BestTrialName is the name of the best trial.
 	BestTrialName string `json:"bestTrialName,omitempty"`
 	// Key-value pairs for hyperparameters and assignment values.
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
 	ParameterAssignments []common.ParameterAssignment `json:"parameterAssignments,omitempty"`
 
 	// Observation for this trial
@@ -207,8 +230,11 @@ const (
 )
 
 type FeasibleSpace struct {
-	Max          string       `json:"max,omitempty"`
-	Min          string       `json:"min,omitempty"`
+	Max string `json:"max,omitempty"`
+	Min string `json:"min,omitempty"`
+
+	// +listType=set
+	// +optional
 	List         []string     `json:"list,omitempty"`
 	Step         string       `json:"step,omitempty"`
 	Distribution Distribution `json:"distribution,omitempty"`
@@ -233,6 +259,9 @@ type TrialTemplate struct {
 	TrialSource `json:",inline"`
 
 	// List of parameters that are used in trial template
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
 	TrialParameters []TrialParameterSpec `json:"trialParameters,omitempty"`
 
 	// Labels that determines if pod needs to be injected by Katib sidecar container.
@@ -314,20 +343,34 @@ type ExperimentList struct {
 // NasConfig contains config for NAS job
 type NasConfig struct {
 	GraphConfig GraphConfig `json:"graphConfig,omitempty"`
-	Operations  []Operation `json:"operations,omitempty"`
+
+	// +listType=map
+	// +listMapKey=OperationType
+	// +optional
+	Operations []Operation `json:"operations,omitempty"`
 }
 
 // GraphConfig contains a config of DAG
 type GraphConfig struct {
-	NumLayers   *int32  `json:"numLayers,omitempty"`
-	InputSizes  []int32 `json:"inputSizes,omitempty"`
+	NumLayers *int32 `json:"numLayers,omitempty"`
+
+	// +listType=set
+	// +optional
+	InputSizes []int32 `json:"inputSizes,omitempty"`
+
+	// +listType=set
+	// +optional
 	OutputSizes []int32 `json:"outputSizes,omitempty"`
 }
 
 // Operation contains type of operation in DAG
 type Operation struct {
-	OperationType string          `json:"operationType,omitempty"`
-	Parameters    []ParameterSpec `json:"parameters,omitempty"`
+	OperationType string `json:"operationType,omitempty"`
+
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
+	Parameters []ParameterSpec `json:"parameters,omitempty"`
 }
 
 func init() {

pkg/apis/controller/suggestions/v1beta1/suggestion_types.go

@@ -46,12 +46,18 @@ type SuggestionStatus struct {
 	// AlgorithmSettings defines HP or NAS algorithm settings which suggestion gRPC service returns.
 	// These settings overwrites Experiment's settings before the gRPC request.
 	// It can be empty if settings haven't been changed.
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
 	AlgorithmSettings []common.AlgorithmSetting `json:"algorithmSettings,omitempty"`
 
 	// Number of suggestion results
 	SuggestionCount int32 `json:"suggestionCount,omitempty"`
 
 	// Suggestion results
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
 	Suggestions []TrialAssignment `json:"suggestions,omitempty"`
 
 	// Represents time when the Suggestion was acknowledged by the Suggestion controller.
@@ -70,19 +76,28 @@ type SuggestionStatus struct {
 	LastReconcileTime *metav1.Time `json:"lastReconcileTime,omitempty"`
 
 	// List of observed runtime conditions for this Suggestion.
+	// +listType=map
+	// +listMapKey=Type
+	// +optional
 	Conditions []SuggestionCondition `json:"conditions,omitempty"`
 }
 
 // TrialAssignment is the assignment for one trial.
 type TrialAssignment struct {
 	// Suggestion results with Trial parameters
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
 	ParameterAssignments []common.ParameterAssignment `json:"parameterAssignments,omitempty"`
 
 	// Name of the suggestion
 	Name string `json:"name,omitempty"`
 
 	// Rules for early stopping techniques
 	// Contains rule name, value and comparison type
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
 	EarlyStoppingRules []common.EarlyStoppingRule `json:"earlyStoppingRules,omitempty"`
 
 	// Suggestion label metadata to attach to Trial job

pkg/apis/controller/trials/v1beta1/trial_types.go

@@ -29,10 +29,16 @@ type TrialSpec struct {
 	Objective *common.ObjectiveSpec `json:"objective,omitempty"`
 
 	// Key-value pairs for hyperparameters and assignment values.
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
 	ParameterAssignments []common.ParameterAssignment `json:"parameterAssignments,omitempty"`
 
 	// Rules for early stopping techniques.
 	// Each rule should be met to early stop Trial.
+	// +listType=map
+	// +listMapKey=Name
+	// +optional
 	EarlyStoppingRules []common.EarlyStoppingRule `json:"earlyStoppingRules,omitempty"`
 
 	// Raw text for the trial run spec. This can be any generic Kubernetes
@@ -84,6 +90,9 @@ type TrialStatus struct {
 	LastReconcileTime *metav1.Time `json:"lastReconcileTime,omitempty"`
 
 	// List of observed runtime conditions for this Trial.
+	// +listType=map
+	// +listMapKey=Type
+	// +optional
 	Conditions []TrialCondition `json:"conditions,omitempty"`
 
 	// Results of the Trial - objectives and other metrics values.