Support for Custom Job resources

examples/v1alpha2/pytorchjob-example.yaml

@@ -0,0 +1,71 @@
+apiVersion: "kubeflow.org/v1alpha2"
+kind: Experiment
+metadata:
+  namespace: kubeflow
+  name: random-experiment
+spec:
+  parallelTrialCount: 3
+  maxTrialCount: 12
+  maxFailedTrialCount: 3
+  objective:
+    type: maximize
+    goal: 0.99
+    objectiveMetricName: accuracy
+  algorithm:
+    algorithmName: random
+  trialTemplate:
+    retain: true
+    goTemplate:
+        rawTemplate: |-
+          apiVersion: "kubeflow.org/v1beta2"
+          kind: PyTorchJob
+          metadata:
+            name: {{.Trial}}
+            namespace: {{.NameSpace}}
+          spec:
+           pytorchReplicaSpecs:
+            Master:
+              replicas: 1
+              restartPolicy: OnFailure
+              template:
+                spec:
+                  containers:
+                    - name: pytorch
+                      image: gcr.io/kubeflow-ci/pytorch-dist-mnist-test:v1.0
+                      imagePullPolicy: Always
+                      command:
+                        - "python"
+                        - "/var/mnist.py"
+                        {{- with .HyperParameters}}
+                        {{- range .}}
+                        - "{{.Name}}={{.Value}}"
+                        {{- end}}
+                        {{- end}}
+            Worker:
+              replicas: 2
+              restartPolicy: OnFailure
+              template:
+                spec:
+                  containers:
+                    - name: pytorch
+                      image: gcr.io/kubeflow-ci/pytorch-dist-mnist-test:v1.0
+                      imagePullPolicy: Always
+                      command:
+                        - "python"
+                        - "/var/mnist.py"
+                        {{- with .HyperParameters}}
+                        {{- range .}}
+                        - "{{.Name}}={{.Value}}"
+                        {{- end}}
+                        {{- end}}
+  parameters:
+    - name: --lr
+      parameterType: double
+      feasibleSpace:
+        min: "0.01"
+        max: "0.05"
+    - name: --momentum
+      parameterType: double
+      feasibleSpace:
+        min: "0.5"
+        max: "0.9"

pkg/controller/v1alpha2/experiment/util/runjob_util.go → pkg/api/operators/apis/addtoscheme_pytorchjob_v1beta2.go

@@ -1,32 +1,22 @@
 /*
-
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
-
     http://www.apache.org/licenses/LICENSE-2.0
-
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package util
+package apis
 
 import (
-	"k8s.io/apimachinery/pkg/runtime/schema"
+	"github.com/kubeflow/pytorch-operator/pkg/apis/pytorch/v1beta2"
 )
 
-func GetSupportedJobList() []schema.GroupVersionKind {
-	// TODO: append other supported jobs, such as tfjob, pytorch and so on
-	supportedJobList := []schema.GroupVersionKind{
-		schema.GroupVersionKind{
-			Group:   "batch",
-			Version: "v1",
-			Kind:    "Job",
-		},
-	}
-	return supportedJobList
+func init() {
+	// Register the types with the Scheme so the components can map objects to GroupVersionKinds and back
+	AddToSchemes = append(AddToSchemes, v1beta2.SchemeBuilder.AddToScheme)
 }

pkg/api/operators/apis/addtoscheme_tfjob_v1beta2.go

@@ -0,0 +1,22 @@
+/*
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package apis
+
+import (
+	"github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1beta2"
+)
+
+func init() {
+	// Register the types with the Scheme so the components can map objects to GroupVersionKinds and back
+	AddToSchemes = append(AddToSchemes, v1beta2.SchemeBuilder.AddToScheme)
+}

pkg/common/v1alpha2/common.go

@@ -0,0 +1,26 @@
+package v1alpha2
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+)
+
+func GetSupportedJobList() []schema.GroupVersionKind {
+	supportedJobList := []schema.GroupVersionKind{
+		schema.GroupVersionKind{
+			Group:   "batch",
+			Version: "v1",
+			Kind:    "Job",
+		},
+		schema.GroupVersionKind{
+			Group:   "kubeflow.org",
+			Version: "v1beta2",
+			Kind:    "TFJob",
+		},
+		schema.GroupVersionKind{
+			Group:   "kubeflow.org",
+			Version: "v1beta2",
+			Kind:    "PyTorchJob",
+		},
+	}
+	return supportedJobList
+}

pkg/controller/v1alpha2/experiment/util/webhook_util.go

@@ -22,14 +22,16 @@ import (
 	"fmt"
 	logger "log"
 
-	commonv1alpha2 "github.com/kubeflow/katib/pkg/api/operators/apis/common/v1alpha2"
-	ep_v1alpha2 "github.com/kubeflow/katib/pkg/api/operators/apis/experiment/v1alpha2"
 	batchv1beta "k8s.io/api/batch/v1beta1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	k8syaml "k8s.io/apimachinery/pkg/util/yaml"
+
+	commonapiv1alpha2 "github.com/kubeflow/katib/pkg/api/operators/apis/common/v1alpha2"
+	experimentsv1alpha2 "github.com/kubeflow/katib/pkg/api/operators/apis/experiment/v1alpha2"
+	commonv1alpha2 "github.com/kubeflow/katib/pkg/common/v1alpha2"
 )
 
-func ValidateExperiment(instance *ep_v1alpha2.Experiment) error {
+func ValidateExperiment(instance *experimentsv1alpha2.Experiment) error {
 	if !instance.IsCreated() {
 		if err := validateForCreate(instance); err != nil {
 			return err
@@ -65,25 +67,25 @@ func ValidateExperiment(instance *ep_v1alpha2.Experiment) error {
 	return nil
 }
 
-func validateAlgorithmSettings(inst *ep_v1alpha2.Experiment) error {
+func validateAlgorithmSettings(inst *experimentsv1alpha2.Experiment) error {
 	// TODO: it need call ValidateAlgorithmSettings API of vizier-core manager, implement it when vizier-core done
 	return nil
 }
 
-func validateObjective(obj *commonv1alpha2.ObjectiveSpec) error {
+func validateObjective(obj *commonapiv1alpha2.ObjectiveSpec) error {
 	if obj == nil {
 		return fmt.Errorf("No spec.objective specified.")
 	}
-	if obj.Type != commonv1alpha2.ObjectiveTypeMinimize && obj.Type != commonv1alpha2.ObjectiveTypeMaximize {
-		return fmt.Errorf("spec.objective.type must be %s or %s.", commonv1alpha2.ObjectiveTypeMinimize, commonv1alpha2.ObjectiveTypeMaximize)
+	if obj.Type != commonapiv1alpha2.ObjectiveTypeMinimize && obj.Type != commonapiv1alpha2.ObjectiveTypeMaximize {
+		return fmt.Errorf("spec.objective.type must be %s or %s.", commonapiv1alpha2.ObjectiveTypeMinimize, commonapiv1alpha2.ObjectiveTypeMaximize)
 	}
 	if obj.ObjectiveMetricName == "" {
 		return fmt.Errorf("No spec.objective.objectiveMetricName specified.")
 	}
 	return nil
 }
 
-func validateAlgorithm(ag *ep_v1alpha2.AlgorithmSpec) error {
+func validateAlgorithm(ag *experimentsv1alpha2.AlgorithmSpec) error {
 	if ag == nil {
 		return fmt.Errorf("No spec.algorithm specified.")
 	}
@@ -94,7 +96,7 @@ func validateAlgorithm(ag *ep_v1alpha2.AlgorithmSpec) error {
 	return nil
 }
 
-func validateTrialTemplate(instance *ep_v1alpha2.Experiment) error {
+func validateTrialTemplate(instance *experimentsv1alpha2.Experiment) error {
 	trialName := fmt.Sprintf("%s-trial", instance.GetName())
 	trialParams := TrialTemplateParams{
 		Experiment: instance.GetName(),
@@ -129,16 +131,16 @@ func validateTrialTemplate(instance *ep_v1alpha2.Experiment) error {
 
 func validateSupportedJob(job *unstructured.Unstructured) error {
 	gvk := job.GroupVersionKind()
-	supportedJobs := GetSupportedJobList()
+	supportedJobs := commonv1alpha2.GetSupportedJobList()
 	for _, sJob := range supportedJobs {
 		if gvk == sJob {
 			return nil
 		}
 	}
-	return fmt.Errorf("Cannot support to run job: %v", gvk)
+	return fmt.Errorf("Job type %v not supported", gvk)
 }
 
-func validateForCreate(inst *ep_v1alpha2.Experiment) error {
+func validateForCreate(inst *experimentsv1alpha2.Experiment) error {
 	if _, err := GetExperimentFromDB(inst); err != nil {
 		if err != sql.ErrNoRows {
 			return fmt.Errorf("Fail to check record for the experiment in DB: %v", err)
@@ -149,7 +151,7 @@ func validateForCreate(inst *ep_v1alpha2.Experiment) error {
 	}
 }
 
-func validateMetricsCollector(inst *ep_v1alpha2.Experiment) error {
+func validateMetricsCollector(inst *experimentsv1alpha2.Experiment) error {
 	BUFSIZE := 1024
 	experimentName := inst.GetName()
 	trialName := fmt.Sprintf("%s-trial", inst.GetName())