trainer/sdk/python

Kubeflow TFJob SDK

Python SDK for TF-Operator

Requirements.

Python 2.7 and 3.5+

Installation & Usage

pip install

pip install kubeflow-tfjob

Then import the package:

from kubeflow import tfjob 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Getting Started

Please follow the sample to create, update and delete TFJob.

Documentation for API Endpoints

Class	Method	Description
TFJobClient	create	Create TFJob
TFJobClient	get	Get or watch the specified TFJob or all TFJob in the namespace
TFJobClient	patch	Patch the specified TFJob
TFJobClient	delete	Delete the specified TFJob
TFJobClient	wait_for_job	Wait for the specified job to finish
TFJobClient	wait_for_condition	Waits until any of the specified conditions occur
TFJobClient	get_job_status	Get the TFJob status
TFJobClient	if_job_running	Check if the TFJob running
TFJobClient	if_job_succeeded	Check if the TFJob Succeeded

Documentation For Models

• V1JobCondition
• V1JobStatus
• V1ReplicaSpec
• V1ReplicaStatus
• V1TFJob
• V1TFJobList
• V1TFJobSpec