mirror of
https://github.com/hanzo-ml/trainer.git
synced 2026-09-24 00:31:34 +00:00
29c3feb9f4
* Add scheduler plugin for coscheduling Signed-off-by: Yuki Iwai <[email protected]> Co-authored-by: Wang Zhang <[email protected]> Signed-off-by: Yuki Iwai <[email protected]> * generate codes Signed-off-by: Yuki Iwai <[email protected]> * Add a custom Watcher for scheduler-plugins PodGroup to controllers Signed-off-by: Yuki Iwai <[email protected]> * Fix predicates of paddlepaddle-controller for scheduling.volcano.sh/v1beta1 PodGroup Signed-off-by: Yuki Iwai <[email protected]> * Upgrade kubeflow/common version to v0.4.6 with HPA changes Signed-off-by: Yuki Iwai <[email protected]> Signed-off-by: Yuki Iwai <[email protected]> Co-authored-by: Wang Zhang <[email protected]>
Kubeflow Training SDK
Python SDK for Training Operator
Requirements.
Python 2.7 and 3.5+
Installation & Usage
pip install
pip install kubeflow-training
Then import the package:
from kubeflow import training
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
TODO(andreyvelich): These docs are outdated. Please track this issue for the status: https://github.com/kubeflow/katib/issues/2081
| 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 | is_job_running | Check if the TFJob status is Running |
| TFJobClient | is_job_succeeded | Check if the TFJob status is Succeeded |
| TFJobClient | get_pod_names | Get pod names of TFJob |
| TFJobClient | get_logs | Get training logs of the TFJob |
| PyTorchJobClient | create | Create PyTorchJob |
| PyTorchJobClient | get | Get the specified PyTorchJob or all PyTorchJob in the namespace |
| PyTorchJobClient | patch | Patch the specified PyTorchJob |
| PyTorchJobClient | delete | Delete the specified PyTorchJob |
| PyTorchJobClient | wait_for_job | Wait for the specified job to finish |
| PyTorchJobClient | wait_for_condition | Waits until any of the specified conditions occur |
| PyTorchJobClient | get_job_status | Get the PyTorchJob status |
| PyTorchJobClient | is_job_running | Check if the PyTorchJob running |
| PyTorchJobClient | is_job_succeeded | Check if the PyTorchJob Succeeded |
| PyTorchJobClient | get_pod_names | Get pod names of PyTorchJob |
| PyTorchJobClient | get_logs | Get training logs of the PyTorchJob |