tf-operator

module

v1.3.0 Latest Latest Go to latest Published: Oct 3, 2021 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kubeflow/tf-operator

Links

Open Source Insights

README ¶

Kubeflow Training Operator

Overview

Before v1.2 release, tensorflow-operator can only support TFJob on Kubernetes. Starting from v1.3, Training Operator provides Kubernetes custom resources that makes it easy to run distributed or non-distributed TensorFlow/PyTorch/MXNet/XGBoost jobs on Kubernetes.

For a complete reference of the custom resource definitions, please refer to the API Definition.
For details on API design, please refer to the v1alpha2 design doc.
For details of all-in-one operator design, please refer to the All-in-one Kubeflow Training Operator
For details on its obersibility, please refer to the monitoring design doc.

Prerequisites

Version >= 1.16 of Kubernetes
Version >= 3.x of Kustomize
Version >= 1.21.x of Kubectl

Installation

Master Branch

kubectl apply -k "github.com/kubeflow/tf-operator.git/manifests/overlays/standalone?ref=master"

Specific Release

kubectl apply -k "github.com/kubeflow/tf-operator.git/manifests/overlays/standalone?ref=v1.3.0"

Tensorflow Release Only

For users who prefer to use original tensorflow controllers, please checkout v1.2-branch, we will maintain the bug fix in this branch.

kubectl apply -k "github.com/kubeflow/tf-operator.git/manifests/overlays/standalone?ref=v1.2.0"

Quick Start

Please refer to the quick-start-v1.md and Kubeflow Training 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 DEVELOPMENT

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
`v1.0.x`	`v1`	1.16+
`v1.1.x`	`v1`	1.16+
`v1.2.x`	`v1`	1.16+
`v1.3.x`	`v1`	1.18+
`latest` (master HEAD)	`v1`	1.18+

Directories ¶

Path	Synopsis
cmd
training-operator.v1
hack
python-sdk
pkg
apis/mxnet/v1 Package v1 is the v1 version of the API.	Package v1 is the v1 version of the API.
apis/mxnet/validation
apis/pytorch/v1 Package v1 is the v1 version of the API.	Package v1 is the v1 version of the API.
apis/pytorch/validation
apis/tensorflow/v1 Package v1 is the v1 version of the API.	Package v1 is the v1 version of the API.
apis/tensorflow/validation
apis/xgboost/v1 Package v1 is the v1 version of the API.	Package v1 is the v1 version of the API.
apis/xgboost/validation
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.
client/informers/externalversions
client/informers/externalversions/internalinterfaces
client/informers/externalversions/tensorflow
client/informers/externalversions/tensorflow/v1
client/listers/tensorflow/v1
common
common/util
common/util/v1/testutil
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
controller.v1/mxnet
controller.v1/pytorch
controller.v1/tensorflow Package controller provides a Kubernetes controller for a TFJob resource.	Package controller provides a Kubernetes controller for a TFJob resource.
controller.v1/xgboost
version

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL