README
¶
K8s Custom Resource and Operator For TensorFlow jobs
Overview
TFJob provides a Kubernetes custom resource that makes it easy to run distributed or non-distributed TensorFlow jobs on Kubernetes.
- For a complete reference of the custom resource definitions, please refer to the API Definition.
- For details on its design, please refer to the v1alpha2 design doc.
- For details on its obersibility, please refer to the monitoring design doc.
Prerequisites
- Version >= 1.16 of Kubernetes
Installation
Master Branch
kubectl kustomize "github.com/kubeflow/tf-operator.git/manifests/overlays/standalone?ref=master" | kubectl apply -f -
Specific Release
kubectl kustomize "github.com/kubeflow/tf-operator.git/manifests/overlays/standalone?ref=v1.1.0" | kubectl apply -f -
Quick Start
Please refer to the quick-start-v1.md and Kubeflow user guide for more information.
API Documentation
Please refer to API Documentation
Community
You can:
- Join our Slack channel.
- Check out who is using this operator.
This is a part of Kubeflow, so please see readme in kubeflow/kubeflow to get in touch with the community.
Contributing
Please refer to the developer_guide
Change Log
Please refer to CHANGELOG
Version Matrix
The following table lists the most recent few versions of the operator.
| Operator Version | API Version | Kubernetes Version |
|---|---|---|
latest (master HEAD) |
v1 |
1.16+ |
v1.0.x |
v1 |
1.16+ |
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
hack
|
|
|
pkg
|
|
|
apis/mxnet/v1
Package v1 is the v1 version of the API.
|
Package v1 is the v1 version of the API. |
|
apis/pytorch/v1
Package v1 is the v1 version of the API.
|
Package v1 is the v1 version of the API. |
|
apis/tensorflow/v1
Package v1 is the v1 version of the API.
|
Package v1 is the v1 version of the API. |
|
apis/xgboost/v1
Package v1 is the v1 version of the API.
|
Package v1 is the v1 version of the API. |
|
client/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/tensorflow/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/tensorflow/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
common/util/v1/unstructured
Package unstructured is the package for unstructured informer, which is from https://github.com/argoproj/argo/blob/master/util/unstructured/unstructured.go This is a temporary solution for https://github.com/kubeflow/tf-operator/issues/561
|
Package unstructured is the package for unstructured informer, which is from https://github.com/argoproj/argo/blob/master/util/unstructured/unstructured.go This is a temporary solution for https://github.com/kubeflow/tf-operator/issues/561 |
|
controller.v1/tensorflow
Package tensorflow provides a Kubernetes controller for a TFJob resource.
|
Package tensorflow provides a Kubernetes controller for a TFJob resource. |
Click to show internal directories.
Click to hide internal directories.