Update docs for v1beta1 SDK (#1304)

* Update docs for v1beta1 SDK * Fix samples in v1alpha3
kubeflow · Aug 19, 2020 · 2ceed7d · 2ceed7d
1 parent 1d18594
commit 2ceed7d
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -398,15 +398,13 @@ You can access the Katib UI using this URL: ```http://localhost:8080/katib/```.
 
 ### Katib SDK
 
-Currently Katib SDK supports only v1alpha3.
+Katib supports Python SDK for v1beta1 and v1alpha3 version.
 
-* Install the SDK
-  ```
-  pip install kubeflow-katib
-  ```
-* Get the Katib SDK documents from [here](sdk/python/README.md).
+* See the [Katib v1beta1 SDK documentation](https://github.com/kubeflow/katib/tree/master/sdk/python/v1beta1).
 
-* Follow the [example here](sdk/python/examples/bayesianoptimization-katib-sdk.ipynb) to use the Katib SDK to create, delete and get Hyperparameter values of experiment.
+* See the [Katib v1alpha3 SDK documentation](https://github.com/kubeflow/katib/tree/master/sdk/python/v1alpha3).
+
+Run [`gen_sdk.sh`](https://github.com/kubeflow/katib/blob/master/hack/gen-python-sdk/gen_sdk.sh) to update SDK.
 
 ### Cleanups
 

diff --git a/sdk/python/v1alpha3/README.md b/sdk/python/v1alpha3/README.md
@@ -31,7 +31,7 @@ python setup.py install --user
 
 ## Getting Started
 
-Please follow the [samples](examples/bayesianoptimization-katib-sdk.ipynb) to create, update, delete and get hyperparamaters of  Katib Experiment.
+Please follow the [samples](examples) to create, update, delete and get hyperparamaters of Katib Experiment.
 
 ## Documentation for API Endpoints
 

diff --git a/sdk/python/v1beta1/README.md b/sdk/python/v1beta1/README.md
@@ -31,7 +31,7 @@ python setup.py install --user
 
 ## Getting Started
 
-Please follow the [samples](examples/bayesianoptimization-katib-sdk.ipynb) to create, update, delete and get hyperparamaters of  Katib Experiment.
+TODO: Add examples for v1beta1.
 
 ## Documentation for API Endpoints