Add validation for NAS job in Katib controller

pkg/controller/studyjob/const.go

@@ -12,11 +12,12 @@ limitations under the License.
 package studyjob
 
 const (
-	DefaultJobWorker = "Job"
-	TFJobWorker      = "TFJob"
-	PyTorchJobWorker = "PyTorchJob"
-	jobTypeNAS       = "NAS"
-	jobTypeHP        = "HP"
+	DefaultJobWorker      = "Job"
+	TFJobWorker           = "TFJob"
+	PyTorchJobWorker      = "PyTorchJob"
+	jobTypeNAS            = "NAS"
+	jobTypeHP             = "HP"
+	suggestionAlgorithmRL = "nasrl"
 )
 
 var ValidWorkerKindList = [...]string{DefaultJobWorker, TFJobWorker, PyTorchJobWorker}

pkg/controller/studyjob/katib_api_util.go

@@ -25,6 +25,25 @@ import (
 )
 
 func initializeStudy(instance *katibv1alpha1.StudyJob) error {
+	if validErr := validateStudy(instance); validErr != nil {
+		instance.Status.Condition = katibv1alpha1.ConditionFailed
+		return validErr
+	}
+
+	if getJobType(instance) != jobTypeNAS {
+		//Validate HP job
+		if validJobErr := validateHPJob(instance); validJobErr != nil {
+			instance.Status.Condition = katibv1alpha1.ConditionFailed
+			return validJobErr
+		}
+	} else {
+		//Validate NAS job
+		if validJobErr := validateNASJob(instance); validJobErr != nil {
+			instance.Status.Condition = katibv1alpha1.ConditionFailed
+			return validJobErr
+		}
+	}
+
 	if instance.Spec.SuggestionSpec.SuggestionAlgorithm == "" {
 		instance.Spec.SuggestionSpec.SuggestionAlgorithm = "random"
 	}

pkg/controller/studyjob/utils.go

@@ -15,6 +15,7 @@ import (
 	"fmt"
 	"io/ioutil"
 	"log"
+	"reflect"
 	"strings"
 
 	katibapi "github.com/kubeflow/katib/pkg/api"
@@ -206,6 +207,91 @@ func contains(l []string, s string) bool {
 	return false
 }
 
+func validateHPJob(instance *katibv1alpha1.StudyJob) error {
+	log.Printf("Validation for the HP job")
+	if instance.Spec.ParameterConfigs == nil {
+		return fmt.Errorf("No Spec.ParameterConfigs specified")
+	}
+	err := validateParameterConfigs(instance.Spec.ParameterConfigs, jobTypeHP, instance.Spec.SuggestionSpec.SuggestionAlgorithm)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+func validateNASJob(instance *katibv1alpha1.StudyJob) error {
+	log.Printf("Validation for the NAS job")
+	if instance.Spec.NasConfig == nil {
+		return fmt.Errorf("No Spec.NasConfig specified")
+	}
+
+	if reflect.DeepEqual(instance.Spec.NasConfig.GraphConfig, katibv1alpha1.GraphConfig{}) {
+		return fmt.Errorf("Missing GraphConfig in NasConfig: %v", instance.Spec.NasConfig)
+	}
+
+	if instance.Spec.NasConfig.GraphConfig.InputSize == nil {
+		return fmt.Errorf("Missing InputSize in NasConfig.GraphConfig: %v", instance.Spec.NasConfig.GraphConfig)
+	}
+
+	if instance.Spec.NasConfig.GraphConfig.OutputSize == nil {
+		return fmt.Errorf("Missing OutputSize in NasConfig.GraphConfig: %v", instance.Spec.NasConfig.GraphConfig)
+	}
+
+	if instance.Spec.NasConfig.GraphConfig.NumLayers == 0 && instance.Spec.SuggestionSpec.SuggestionAlgorithm == suggestionAlgorithmRL {
+		return fmt.Errorf("Missing NumLayers in NasConfig.GraphConfig: %v", instance.Spec.NasConfig.GraphConfig)
+	}
+
+	if instance.Spec.NasConfig.Operations == nil {
+		return fmt.Errorf("Missing Operations in NasConfig: %v", instance.Spec.NasConfig)
+	}
+
+	for _, op := range instance.Spec.NasConfig.Operations {
+		if op.OperationType == "" {
+			return fmt.Errorf("Missing OperationType in Operation: %v", op)
+		}
+		if op.ParameterConfigs == nil {
+			return fmt.Errorf("Missing ParameterConfig in Operation: %v", op)
+		}
+		err := validateParameterConfigs(op.ParameterConfigs, jobTypeNAS, instance.Spec.SuggestionSpec.SuggestionAlgorithm)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func validateParameterConfigs(parameterConfigs []katibv1alpha1.ParameterConfig, jobType string, suggestionAlgorithm string) error {
+	for _, pc := range parameterConfigs {
+		if pc.Name == "" {
+			return fmt.Errorf("Missing Name in ParameterConfig: %v", pc)
+		}
+		if pc.ParameterType == "" {
+			return fmt.Errorf("Missing ParameterType in ParameterConfig: %v", pc)
+		}
+		if reflect.DeepEqual(pc.Feasible, katibv1alpha1.FeasibleSpace{}) {
+			return fmt.Errorf("Missing Feasible in ParameterConfig: %v", pc)
+		}
+		if pc.ParameterType == katibv1alpha1.ParameterTypeCategorical {
+			if pc.Feasible.List == nil {
+				return fmt.Errorf("Missing List in ParameterConfig.Feasible: %v", pc.Feasible)
+			}
+		}
+		if pc.ParameterType == katibv1alpha1.ParameterTypeDouble || pc.ParameterType == katibv1alpha1.ParameterTypeInt {
+			if pc.Feasible.Min == "" {
+				return fmt.Errorf("Missing Min in ParameterConfig.Feasible: %v", pc.Feasible)
+			}
+			if pc.Feasible.Max == "" {
+				return fmt.Errorf("Missing Max in ParameterConfig.Feasible: %v", pc.Feasible)
+			}
+			if jobType == jobTypeNAS && pc.Feasible.Step == "" && pc.ParameterType == katibv1alpha1.ParameterTypeDouble && suggestionAlgorithm == suggestionAlgorithmRL {
+				return fmt.Errorf("Missing Step in ParameterConfig.Feasible for NAS job: %v", pc.Feasible)
+			}
+		}
+	}
+	return nil
+}
+
 func getMyNamespace() string {
 	data, _ := ioutil.ReadFile("/var/run/secrets/kubernetes.io/serviceaccount/namespace")
 	return strings.TrimSpace(string(data))