Enhance tfjobs sdk docs (#1114)

kubeflow · Dec 10, 2019 · c729478 · c729478
1 parent f3509e6
commit c729478
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/hack/python-sdk/gen-sdk.sh b/hack/python-sdk/gen-sdk.sh
@@ -36,7 +36,7 @@ echo "Generating OpenAPI specification ..."
 go run vendor/k8s.io/code-generator/cmd/openapi-gen/main.go --input-dirs github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1,github.com/kubeflow/common/job_controller/api/v1 --output-package github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1 --go-header-file hack/boilerplate/boilerplate.go.txt
 
 echo "Generating swagger file ..."
-go run hack/python-sdk/main.go 0.1 > pkg/apis/tensorflow/v1/swagger.json
+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}

diff --git a/sdk/python/README.md b/sdk/python/README.md
@@ -29,12 +29,12 @@ python setup.py install --user
 
 ## Getting Started
 
-Please follow the [sample](../../examples/sdk/tfjob-sdk.ipynb) to create, update and delete TFJob.
+Please follow the [sample](examples/kubeflow-tfjob-sdk.ipynb) to create, update and delete TFJob.
 
 ## Documentation for API Endpoints
 
 Class | Method | Description
------------- | ------------- | ------------- | -------------
+------------ | -------------  | -------------
 [TFJobClient](docs/TFJobClient.md) | [create](docs/TFJobClient.md#create) | Create TFJob|
 [TFJobClient](docs/TFJobClient.md) | [get](docs/TFJobClient.md#get)    | Get or watch the specified TFJob or all TFJob in the namespace |
 [TFJobClient](docs/TFJobClient.md) | [patch](docs/TFJobClient.md#patch)  | Patch the specified TFJob|

diff --git a/examples/sdk/tfjob-sdk.ipynb → sdk/python/examples/kubeflow-tfjob-sdk.ipynb b/examples/sdk/tfjob-sdk.ipynb → sdk/python/examples/kubeflow-tfjob-sdk.ipynb
@@ -31,7 +31,6 @@
     "from kubeflow.tfjob import utils\n",
     "from kubeflow.tfjob import V1ReplicaSpec\n",
     "from kubeflow.tfjob import V1TFJob\n",
-    "from kubeflow.tfjob import V1TFJobList\n",
     "from kubeflow.tfjob import V1TFJobSpec\n",
     "from kubeflow.tfjob import TFJobClient"
    ]
@@ -219,3 +218,4 @@
  "nbformat": 4,
  "nbformat_minor": 2
 }
+