Generate Kubeflow PyTorchJob SDK

hack/python-sdk/gen-sdk.sh

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+
+# Copyright 2019 The Kubeflow Authors.
+#
+# 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.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+SWAGGER_JAR_URL="http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.6/swagger-codegen-cli-2.4.6.jar"
+SWAGGER_CODEGEN_JAR="hack/python-sdk/swagger-codegen-cli.jar"
+SWAGGER_CODEGEN_CONF="hack/python-sdk/swagger_config.json"
+SWAGGER_CODEGEN_FILE="pkg/apis/pytorch/v1/swagger.json"
+SDK_OUTPUT_PATH="sdk/python"
+
+if [ -z "${GOPATH:-}" ]; then
+    export GOPATH=$(go env GOPATH)
+fi
+
+echo "Generating OpenAPI specification ..."
+go run vendor/k8s.io/code-generator/cmd/openapi-gen/main.go --input-dirs github.com/kubeflow/pytorch-operator/pkg/apis/pytorch/v1,github.com/kubeflow/common/job_controller/api/v1 --output-package github.com/kubeflow/pytorch-operator/pkg/apis/pytorch/v1 --go-header-file hack/boilerplate/boilerplate.go.txt
+
+echo "Generating swagger file ..."
+go run hack/python-sdk/main.go 0.1 > ${SWAGGER_CODEGEN_FILE}
+
+echo "Downloading the swagger-codegen JAR package ..."
+wget -O ${SWAGGER_CODEGEN_JAR} ${SWAGGER_JAR_URL}
+
+echo "Generating Python SDK for Kubeflow PyTorch-Operator ..."
+java -jar ${SWAGGER_CODEGEN_JAR} generate -i ${SWAGGER_CODEGEN_FILE} -l python -o ${SDK_OUTPUT_PATH} -c ${SWAGGER_CODEGEN_CONF}
+
+echo "Kubeflow PyTorch Operator Python SDK is generated successfully to folder ${SDK_OUTPUT_PATH}/."

hack/python-sdk/main.go

@@ -0,0 +1,79 @@
+/*
+Copyright 2019 kubeflow.org.
+
+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 main
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/go-openapi/spec"
+	pytorchjob "github.com/kubeflow/pytorch-operator/pkg/apis/pytorch/v1"
+	"k8s.io/klog"
+	"k8s.io/kube-openapi/pkg/common"
+)
+
+// Generate OpenAPI spec definitions for PyTorchJob Resource
+func main() {
+	if len(os.Args) <= 1 {
+		klog.Fatal("Supply a version")
+	}
+	version := os.Args[1]
+	if !strings.HasPrefix(version, "v") {
+		version = "v" + version
+	}
+	oAPIDefs := pytorchjob.GetOpenAPIDefinitions(func(name string) spec.Ref {
+		return spec.MustCreateRef("#/definitions/" + common.EscapeJsonPointer(swaggify(name)))
+	})
+	defs := spec.Definitions{}
+	for defName, val := range oAPIDefs {
+		defs[swaggify(defName)] = val.Schema
+	}
+	swagger := spec.Swagger{
+		SwaggerProps: spec.SwaggerProps{
+			Swagger:     "2.0",
+			Definitions: defs,
+			Paths:       &spec.Paths{Paths: map[string]spec.PathItem{}},
+			Info: &spec.Info{
+				InfoProps: spec.InfoProps{
+					Title:       "pytorch",
+					Description: "Python SDK for PyTorch-Operator",
+					Version:     version,
+				},
+			},
+		},
+	}
+	jsonBytes, err := json.MarshalIndent(swagger, "", "  ")
+	if err != nil {
+		klog.Fatal(err.Error())
+	}
+	fmt.Println(string(jsonBytes))
+}
+
+func swaggify(name string) string {
+	name = strings.Replace(name, "github.com/kubeflow/pytorch-operator/pkg/apis/pytorch/", "", -1)
+	name = strings.Replace(name, "github.com/kubeflow/common/job_controller/api/", "", -1)
+	name = strings.Replace(name, "github.com/kubernetes-sigs/kube-batch/pkg/client/clientset/", "", -1)
+	name = strings.Replace(name, "k8s.io/api/core/", "", -1)
+	name = strings.Replace(name, "k8s.io/apimachinery/pkg/apis/meta/", "", -1)
+	name = strings.Replace(name, "k8s.io/kubernetes/pkg/controller/", "", -1)
+	name = strings.Replace(name, "k8s.io/client-go/listers/core/", "", -1)
+	name = strings.Replace(name, "k8s.io/client-go/util/workqueue", "", -1)
+	name = strings.Replace(name, "/", ".", -1)
+	return name
+}

hack/python-sdk/swagger_config.json

@@ -0,0 +1,13 @@
+{
+    "packageName" : "pytorchjob",
+    "projectName" : "pytorchjob",
+    "packageVersion": "0.1",
+    "importMappings": {
+        "V1Container": "from kubernetes.client import V1Container",
+        "V1ObjectMeta": "from kubernetes.client import V1ObjectMeta",
+        "V1ListMeta": "from kubernetes.client import V1ListMeta",
+        "V1ResourceRequirements": "from kubernetes.client import V1ResourceRequirements",
+        "V1JobCondition": "from kubernetes.client import V1JobCondition",
+        "V1PodTemplateSpec": "from kubernetes.client import V1PodTemplateSpec"
+    }
+}

pkg/apis/pytorch/v1/doc.go

@@ -14,6 +14,7 @@
 
 // +k8s:deepcopy-gen=package,register
 // +k8s:defaulter-gen=TypeMeta
+// +k8s:openapi-gen=true
 
 // Package v1 is the v1 version of the API.
 // +groupName=kubeflow.org

sdk/python/.gitignore

@@ -0,0 +1,72 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+venv/
+.python-version
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints
+
+# Add more useless files
+tox.ini
+test-requirements.txt
+git_push.sh
+.travis.yml
+.swagger-codegen
+.swagger-codegen-ignore

sdk/python/OWNERS

@@ -0,0 +1,2 @@
+approvers:
+  - jinchihe

sdk/python/README.md

@@ -0,0 +1,56 @@
+# Kubeflow PyTorchJob SDK
+Python SDK for PyTorch-Operator
+
+## Requirements.
+
+Python 2.7 and 3.5+
+
+## Installation & Usage
+### pip install
+
+```sh
+pip install kubeflow-pytorchjob
+```
+
+Then import the package:
+```python
+from kubeflow import pytorchjob 
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+
+## Getting Started
+
+Please follow the [sample](../../examples/sdk/pytorchjob-sdk.ipynb) to create, update and delete PyTorchJob.
+
+## Documentation for API Endpoints
+
+Class | Method | Description
+------------ | ------------- | ------------- | -------------
+[PyTorchJobClient](docs/PyTorchJobClient.md) | [create](docs/PyTorchJobClient.md#create) | Create PyTorchJob|
+[PyTorchJobClient](docs/PyTorchJobClient.md) | [get](docs/PyTorchJobClient.md#get)    | Get the specified PyTorchJob or all PyTorchJob in the namespace |
+[PyTorchJobClient](docs/PyTorchJobClient.md) | [patch](docs/PyTorchJobClient.md#patch)  | Patch the specified PyTorchJob|
+[PyTorchJobClient](docs/PyTorchJobClient.md) | [delete](docs/PyTorchJobClient.md#delete) | Delete the specified PyTorchJob |
+
+
+## Documentation For Models
+
+ - [V1JobCondition](docs/V1JobCondition.md)
+ - [V1JobStatus](docs/V1JobStatus.md)
+ - [V1PyTorchJob](docs/V1PyTorchJob.md)
+ - [V1PyTorchJobList](docs/V1PyTorchJobList.md)
+ - [V1PyTorchJobSpec](docs/V1PyTorchJobSpec.md)
+ - [V1ReplicaSpec](docs/V1ReplicaSpec.md)
+ - [V1ReplicaStatus](docs/V1ReplicaStatus.md)
+
+
+
+