Add more APIs for SDK - Githubissues

kubeflow / pytorch-operator

PyTorch on Kubernetes

Apache License 2.0

307 stars 143 forks source link

Add more APIs for SDK #240

Closed jinchihe closed 4 years ago

jinchihe commented 4 years ago

From feedback, as done for the kubeflow-tfjob SDK, add more APIs for kubeflow-pytorchjob:

wait_for_job: Wait for the specified job to finish
wait_for_condition: Waits until any of the specified conditions occur
get_job_status: Quick way to get the PyTorchJob status
is_job_running: Quick way to check if the PyTorchJob status is Running
is_job_succeeded: Quick way to check if the PyTorchJob status is Succeeded

coveralls commented 4 years ago

Coverage remained the same at 22.97% when pulling e0a5820eae763532034d17de3637bd2db40f5145 on jinchihe:add_wait_sdk_api into 26f9d0ce381fe50926741b776e8a3f73bd77640d on kubeflow:master.

jinchihe commented 4 years ago

/cc @gaocegege @johnugeorge Could you please take a look? Thanks a lot!

gaocegege commented 4 years ago

Thanks for your contribution! :tada: :+1:

johnugeorge commented 4 years ago

Great. Do you think, if is_job_running makes more sense than if_job_running? Similarly for if_job_succeeded ?

jinchihe commented 4 years ago

@johnugeorge Great comments. Agree with you, is_job_running better than if_job_running, I'm going to update, and I'm also going to update TFJob side. Thanks!

jinchihe commented 4 years ago

@johnugeorge Updated, Thanks.

jinchihe commented 4 years ago

/retest

johnugeorge commented 4 years ago

@jinchihe Can you please update the PR comment too to reflect the new function names - https://github.com/kubeflow/pytorch-operator/pull/240#issue-354018739

jinchihe commented 4 years ago

@jinchihe Can you please update the PR comment too to reflect the new function names - #240 (comment)

Updated, thanks!

johnugeorge commented 4 years ago

Thanks @jinchihe /approve

k8s-ci-robot commented 4 years ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: johnugeorge

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: - ~~[sdk/python/OWNERS](https://github.com/kubeflow/pytorch-operator/blob/master/sdk/python/OWNERS)~~ [johnugeorge] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment

johnugeorge commented 4 years ago

/lgtm