[python sdk] add v1beta1 models #1252

sperlingxx · 2020-07-03T09:57:42Z

Add replace v1alpha3 python models with v1beta1 python models.
Provide scripts to update python SDK.
Change default katib version in python SDK from v1alpha3 to v1beta1.
Upgrade python SDK version to 0.0.3.

What's your opinion about this PR, @prem0912 @andreyvelich @gaocegege @johnugeorge ?

kubeflow-bot · 2020-07-03T09:57:48Z

This change is

gaocegege

The idea LGTM. But I am not the Python expert.

/cc @jinchihe Would you mind helping review it?

andreyvelich

@sperlingxx Thank you for doing this!

Not sure what is the best way to support both version (v1alpha3 and v1beta1).
Store everything under /models?
Or we can have /sdk/v1alpha3 and /sdk/v1beta1.
What do you think @jinchihe @gaocegege @johnugeorge @prem0912 ?

@sperlingxx can you also add katib_client for v1beta1 ?

And maybe add one more example for the new version.

sdk/python/docs/V1beta1TrialTemplate.md

gaocegege · 2020-07-06T00:44:17Z

Or we can have /sdk/v1alpha3 and /sdk/v1beta1.

I think it works.

sperlingxx · 2020-07-07T03:39:55Z

@sperlingxx Thank you for doing this!

Not sure what is the best way to support both version (v1alpha3 and v1beta1).
Store everything under /models?
Or we can have /sdk/v1alpha3 and /sdk/v1beta1.
What do you think @jinchihe @gaocegege @johnugeorge @prem0912 ?

@sperlingxx can you also add katib_client for v1beta1 ?

And maybe add one more example for the new version.

Hi @andreyvelich , after second thoughts, I found it is not necessary to support out-dated versions, which will only make manitain work really complicated. So, I removed v1Alpha3 stuff. And add scripts to simplify the updation of python SDK.
Examples are still not updated to v1beta1, since I doesn't have proper environment to run the notebook files for now.

jinchihe · 2020-07-07T08:31:47Z

@gaocegege @sperlingxx That's huge, I will take a look as soon as possible. Great contribution!

jinchihe

Looks great.
@sperlingxx Would you mind to add E2E test cases (or Notebook example) for the Python SDK to ensure the basic function works fine? and some unit test cases have been generated automatically, better to add those cases to CI tests. Thanks.

jinchihe · 2020-07-07T09:11:59Z

sdk/python/docs/V1beta1ExperimentStatus.md

@@ -1,11 +1,11 @@
-# V1alpha3ExperimentStatus
+# V1beta1ExperimentStatus

 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **completion_time** | [**V1Time**](V1Time.md) | Represents time when the Experiment was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. | [optional] 


Seems V1Time.md missed? or is not generated. I guess that should be have traceback if this is not generated.

@jinchihe Yes, V1Time is not generated. Because it belongs to kubernetes/apimachinery rather than katib. V1UnstructuredUnstructured has the same problem. I can move their definitions from md files, but maybe the better way is adding them manually, just like tf-operator ?

I've applied the second approach.

I remember we need add related flag and then generate that. But I think that's OK to add that manually, that should be work.

sdk/python/docs/V1beta1ExperimentStatus.md

andreyvelich · 2020-07-07T12:52:30Z

@sperlingxx Thank you for doing this!
Not sure what is the best way to support both version (v1alpha3 and v1beta1).
Store everything under /models?
Or we can have /sdk/v1alpha3 and /sdk/v1beta1.
What do you think @jinchihe @gaocegege @johnugeorge @prem0912 ?
@sperlingxx can you also add katib_client for v1beta1 ?
And maybe add one more example for the new version.

Hi @andreyvelich , after second thoughts, I found it is not necessary to support out-dated versions, which will only make manitain work really complicated. So, I removed v1Alpha3 stuff. And add scripts to simplify the updation of python SDK.
Examples are still not updated to v1beta1, since I doesn't have proper environment to run the notebook files for now.

Why do you want to delete v1alpha3 version of SDK? Can we support 2 versions: sdk/v1alpha3 and sdk/v1beta1?
Currently, Kubeflow 1.1 uses Katib v1alpha3 release and on the website we say, that users can use Katib SDK: https://master.kubeflow.org/docs/components/hyperparameter-tuning/overview/#katib-interfaces.

sperlingxx · 2020-07-07T13:04:32Z

@sperlingxx Thank you for doing this!
Not sure what is the best way to support both version (v1alpha3 and v1beta1).
Store everything under /models?
Or we can have /sdk/v1alpha3 and /sdk/v1beta1.
What do you think @jinchihe @gaocegege @johnugeorge @prem0912 ?
@sperlingxx can you also add katib_client for v1beta1 ?
And maybe add one more example for the new version.

Hi @andreyvelich , after second thoughts, I found it is not necessary to support out-dated versions, which will only make manitain work really complicated. So, I removed v1Alpha3 stuff. And add scripts to simplify the updation of python SDK.
Examples are still not updated to v1beta1, since I doesn't have proper environment to run the notebook files for now.

Why do you want to delete v1alpha3 version of SDK? Can we support 2 versions: sdk/v1alpha3 and sdk/v1beta1?
Currently, Kubeflow 1.1 uses Katib v1alpha3 release and on the website we say, that users can use Katib SDK: https://master.kubeflow.org/docs/components/hyperparameter-tuning/overview/#katib-interfaces.

Okay, I'll add v1alpha3 back.

andreyvelich · 2020-07-08T17:01:39Z

Okay, I'll add v1alpha3 back.

Thanks @sperlingxx.

What do you think about folder structure proposed here: #1252 (review) with sdk/v1alpha3 and sdk/v1beta1, so we can easily manage 2 version in the repo?

Also, is it possible to handle 2 versions in pip and what do we need for that?
For example, if user wants to install v1alpha3, run: pip install kubeflow-katib=v1alpha3, for v1beta1 run: pip install kubeflow-katib=v1beta1.
I am not sure what is the best way to handle both version of API in python SDK.
What do you think @jinchihe ?

prem0912 · 2020-07-09T04:37:21Z

@andreyvelich @sperlingxx It will be better to have with version like pip install kubeflow-katib=0.0.2-v1alpha3, for v1beta1 run: pip install kubeflow-katib=0..0.3-v1beta1.

sperlingxx · 2020-07-09T05:52:08Z

Okay, I'll add v1alpha3 back.

Thanks @sperlingxx.

What do you think about folder structure proposed here: #1252 (review) with sdk/v1alpha3 and sdk/v1beta1, so we can easily manage 2 version in the repo?

Also, is it possible to handle 2 versions in pip and what do we need for that?
For example, if user wants to install v1alpha3, run: pip install kubeflow-katib=v1alpha3, for v1beta1 run: pip install kubeflow-katib=v1beta1.
I am not sure what is the best way to handle both version of API in python SDK.
What do you think @jinchihe ?

Since users of KatibClient can choose katib api versions by setting environment variableEXPERIMENT_VERSON, to me, it looks fine to provide both apiVersions in python SDK. In terms of python sdk version, I think it can be independent to katib apiVersion. For instance, I update version of katib python SDK from 0.0.2 to 0.0.3 in this PR. In future, we will increase the version number when meets large modification.

andreyvelich · 2020-07-09T11:49:33Z

SGTM @sperlingxx.
I agree with @prem0912 about version: 0.0.2-v1alpha3 for v1alpha3 and 0.0.3-v1beta1 for v1beta1.

sperlingxx · 2020-07-21T01:36:30Z

Any updates?

andreyvelich · 2020-07-21T10:12:01Z

@sperlingxx Do you have plans do create /sdk/python/v1alpha3 and /sdk/python/v1beta1 for split versions?

sperlingxx · 2020-07-27T03:51:01Z

@sperlingxx Do you have plans do create /sdk/python/v1alpha3 and /sdk/python/v1beta1 for split versions?

I have created separate folders for each version.

sperlingxx · 2020-07-27T05:04:25Z

/retest

andreyvelich · 2020-07-27T15:32:18Z

@sperlingxx You need to rebase to pass the tests.

sperlingxx · 2020-07-28T01:01:58Z

@andreyvelich Done.

andreyvelich · 2020-07-29T00:03:56Z

sdk/python/v1beta1/README.md

+### pip install
+
+```sh
+pip install kubeflow-katib


Do you need to add version here for v1beta1 and v1alpha3?

@andreyvelich
I've changed pip command of v1alpha3 README.md to pip install kubeflow-katib==0.0.2. To make sure v1alpha3 won't acquire v1beta1 package which is latest (default) version.
And I think we also need to upload 0.0.3 version onto https://pypi.org/project/kubeflow-katib/#files after this PR merged. I believe I don't have the authority to do this.

@prem0912 Can you give us permissions to upload versions in this project, please?

/cc @gaocegege @johnugeorge

@andreyvelich ok sure

@prem0912 Do you need @sperlingxx email to add him to the project ?

@sperlingxx Did you register in pypi ?

@andreyvelich Yes, I registered with email lovedreamf@gmail.com and user name sperlingxx.

@sperlingxx added in kubeflow-katib project

@sperlingxx Can you upload the package and we can merge this PR, please?

@andreyvelich @prem0912 It's done, please visit https://pypi.org/project/kubeflow-katib/0.0.3 . And I had also made some fixes during packaging and uploading.

andreyvelich · 2020-07-29T00:05:52Z

sdk/python/v1beta1/examples/bayesianoptimization-katib-sdk.ipynb

+    "import kubeflow.katib as kc\n",
+    "from kubeflow.katib import constants\n",
+    "from kubeflow.katib import utils\n",
+    "from kubeflow.katib import V1alpha3AlgorithmSetting\n",


Do you need to change it to v1beta1?

I've removed v1beta1 examples temporarily because I met some obstacles on setup environments for these notebook examples.

Ok.
@sperlingxx can you create an issue to add examples for v1beta1 SDK, please?

@andreyvelich It's Done #1300 .

sdk/python/v1alpha3/docs/V1Time.md

gaocegege · 2020-08-12T01:36:09Z

/lgtm
/assign @johnugeorge @andreyvelich @jinchihe

sperlingxx · 2020-08-17T04:41:13Z

/retest

gaocegege · 2020-08-17T06:52:02Z

/assign @andreyvelich @johnugeorge @jinchihe

Request another review, thanks.

andreyvelich · 2020-08-17T14:23:24Z

Thank you @sperlingxx!
Do you need to modify README for v1beta1: https://github.com/sperlingxx/katib/tree/add_v1beta1_python_models/sdk/python/v1beta1#documentation-for-models?
It still points on v1alpha3 models.

sperlingxx · 2020-08-18T04:51:08Z

Thank you @sperlingxx!
Do you need to modify README for v1beta1: https://github.com/sperlingxx/katib/tree/add_v1beta1_python_models/sdk/python/v1beta1#documentation-for-models?
It still points on v1alpha3 models.

@andreyvelich Done!

andreyvelich

Thank you for doing this @sperlingxx.
/lgtm
/approve

k8s-ci-robot · 2020-08-18T10:09:50Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andreyvelich

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [andreyvelich]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot requested review from gaocegege and hougangliu July 3, 2020 09:57

k8s-ci-robot added the size/XXL label Jul 3, 2020

gaocegege reviewed Jul 3, 2020

View reviewed changes

andreyvelich reviewed Jul 3, 2020

View reviewed changes

sdk/python/docs/V1beta1TrialTemplate.md Outdated Show resolved Hide resolved

jinchihe reviewed Jul 7, 2020

View reviewed changes

sperlingxx added 6 commits July 28, 2020 08:43

[python sdk] add v1beta1 models

efdff45

upgrade version of python SDK to 0.0.3

26180f5

remove v1Alpha3 python sdk

44b429c

add some python models manually: v1Time and V1UnstructuredUnstructured

793f30e

bring back v1alpha3

6eeab98

create separate python sdk for v1alpha3 and v1beta1

e68598e

sperlingxx force-pushed the add_v1beta1_python_models branch from 369f22e to e68598e Compare July 28, 2020 00:45

andreyvelich reviewed Jul 29, 2020

View reviewed changes

move on

2f11c1a

k8s-ci-robot requested review from gaocegege and johnugeorge August 11, 2020 13:23

k8s-ci-robot assigned andreyvelich, jinchihe, johnugeorge and gaocegege Aug 12, 2020

k8s-ci-robot added the lgtm label Aug 12, 2020

release pkg on pypi.org

7811687

k8s-ci-robot removed the lgtm label Aug 17, 2020

remove dist files

e55bd9e

refine

a391132

andreyvelich approved these changes Aug 18, 2020

View reviewed changes

k8s-ci-robot added the lgtm label Aug 18, 2020

k8s-ci-robot added the approved label Aug 18, 2020

k8s-ci-robot merged commit 1d18594 into kubeflow:master Aug 18, 2020

andreyvelich mentioned this pull request Aug 18, 2020

Fix link for v1alpha3 Katib SDK kubeflow/website#2142

Merged

andreyvelich mentioned this pull request Nov 18, 2020

Remove v1alpha3 version #1396

Merged

[python sdk] add v1beta1 models #1252

[python sdk] add v1beta1 models #1252

Conversation

sperlingxx commented Jul 3, 2020 • edited Loading

kubeflow-bot commented Jul 3, 2020

gaocegege left a comment

Choose a reason for hiding this comment

andreyvelich left a comment

Choose a reason for hiding this comment

gaocegege commented Jul 6, 2020

sperlingxx commented Jul 7, 2020 • edited Loading

jinchihe commented Jul 7, 2020

jinchihe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andreyvelich commented Jul 7, 2020

sperlingxx commented Jul 7, 2020

andreyvelich commented Jul 8, 2020

prem0912 commented Jul 9, 2020 • edited Loading

sperlingxx commented Jul 9, 2020

andreyvelich commented Jul 9, 2020

sperlingxx commented Jul 21, 2020

andreyvelich commented Jul 21, 2020

sperlingxx commented Jul 27, 2020

sperlingxx commented Jul 27, 2020

andreyvelich commented Jul 27, 2020

sperlingxx commented Jul 28, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andreyvelich Aug 11, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gaocegege commented Aug 12, 2020

sperlingxx commented Aug 17, 2020

gaocegege commented Aug 17, 2020

andreyvelich commented Aug 17, 2020

sperlingxx commented Aug 18, 2020

andreyvelich left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Aug 18, 2020

sperlingxx commented Jul 3, 2020 •

edited

Loading

sperlingxx commented Jul 7, 2020 •

edited

Loading

prem0912 commented Jul 9, 2020 •

edited

Loading

andreyvelich Aug 11, 2020 •

edited

Loading