mirror of
https://github.com/hanzo-ml/trainer.git
synced 2026-09-24 00:31:34 +00:00
4.6 KiB
4.6 KiB
Kubeflow Training SDK
Python SDK for Training Operator
Requirements.
Python >= 3.8
Training Python SDK follows Python release cycle for supported Python versions.
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 Getting Started guide or check Training Operator examples.
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 |
Documentation For Models
- V1JobCondition
- V1JobStatus
- V1PyTorchJob
- V1PyTorchJobList
- V1PyTorchJobSpec
- V1ReplicaSpec
- V1ReplicaStatus
- V1RunPolicy
- V1SchedulingPolicy
- V1TFJob
- V1TFJobList
- V1TFJobSpec
- V1XGBoostJob
- V1XGBoostJobList
- V1XGBoostJobSpec
Building conformance tests
Run
docker build . -f Dockerfile.conformance -t <tag>