Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update links and files with the new URL #1434

Merged
merged 9 commits into from
Oct 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,5 @@ examples/.ipynb_checkpoints/
# openapi-codegen tools and auto generated files but useless
hack/python-sdk/openapi-generator-cli.jar

# Coverage
cover.out
12 changes: 6 additions & 6 deletions PROJECT
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
layout:
- go.kubebuilder.io/v3
projectName: tf-operator
repo: github.com/kubeflow/tf-operator
projectName: training-operator
repo: github.com/kubeflow/training-operator
resources:
- api:
crdVersion: v1
namespaced: true
controller: true
group: kubeflow.org
kind: XGBoostJob
path: github.com/kubeflow/tf-operator/pkg/apis/xgboost/v1
path: github.com/kubeflow/training-operator/pkg/apis/xgboost/v1
version: v1
- api:
crdVersion: v1
namespaced: true
controller: true
group: kubeflow.org
kind: PyTorchJob
path: github.com/kubeflow/tf-operator/pkg/apis/pytorch/v1
path: github.com/kubeflow/training-operator/pkg/apis/pytorch/v1
version: v1
- api:
crdVersion: v1
namespaced: true
controller: true
group: kubeflow.org
kind: TFJob
path: github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1
path: github.com/kubeflow/training-operator/pkg/apis/tensorflow/v1
version: v1
- api:
crdVersion: v1
namespaced: true
controller: true
group: kubeflow.org
kind: MXJob
path: github.com/kubeflow/tf-operator/pkg/apis/mxnet/v1
path: github.com/kubeflow/training-operator/pkg/apis/mxnet/v1
version: v1
version: "3"
39 changes: 20 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Kubeflow Training Operator

[![Build Status](https://github.com/kubeflow/training-operator/actions/workflows/test-go.yaml/badge.svg?branch=master)](https://github.com/kubeflow/training-operator/actions/workflows/test-go.yaml?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/kubeflow/training-operator/badge.svg?branch=master)](https://coveralls.io/github/kubeflow/tf-operator?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/kubeflow/training-operator/badge.svg?branch=master)](https://coveralls.io/github/kubeflow/training-operator?branch=master)
[![Go Report Card](https://goreportcard.com/badge/github.com/kubeflow/training-operator)](https://goreportcard.com/report/github.com/kubeflow/training-operator)

## Overview
Expand All @@ -22,37 +22,38 @@ run distributed or non-distributed TensorFlow/PyTorch/MXNet/XGBoost jobs on Kube

## Prerequisites

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

## Installation

### Master Branch

```bash
kubectl apply -k "github.com/kubeflow/tf-operator/manifests/overlays/standalone"
kubectl apply -k "github.com/kubeflow/training-operator/manifests/overlays/standalone"
```

### Stable Release

```bash
kubectl apply -k "github.com/kubeflow/tf-operator/manifests/overlays/standalone?ref=v1.3.0"
kubectl apply -k "github.com/kubeflow/training-operator/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.

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

### Python SDK for Kubeflow Training Operator

Training Operator provides Python SDK for the custom resources. More docs are available in [sdk/python](sdk/python) folder.

Use `pip install` command to install the latest release of the SDK:

```
pip install kubeflow-training
```
Expand All @@ -64,6 +65,7 @@ Please refer to the [quick-start-v1.md](docs/quick-start-v1.md) and [Kubeflow Tr
## API Documentation

Please refer to API Documentation.

- [Tensorflow API Documentation](docs/api/tensorflow_generated.asciidoc)
- [PyTorch API Documentation](docs/api/pytorch_generated.asciidoc)
- [MXNet API Documentation](docs/api/mxnet_generated.asciidoc)
Expand All @@ -82,7 +84,6 @@ This is a part of Kubeflow, so please see [readme in kubeflow/kubeflow](https://

Please refer to the [DEVELOPMENT](docs/development/developer_guide.md)


## Change Log

Please refer to [CHANGELOG](CHANGELOG.md)
Expand All @@ -91,19 +92,19 @@ Please refer to [CHANGELOG](CHANGELOG.md)

The following table lists the most recent few versions of the operator.

| Operator Version | API Version | Kubernetes Version |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you use some format tools on this kind of format issue?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I am using Prettier to automatically format these docs.
Does it sounds good to you ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. I am thinking we should force to use same tool and probably add it to CI later.

| ------------- | ------------- | ------------- |
| `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+ |
| 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+ |

## Acknowledgement

This project was originally started as a distributed training operator for TensorFlow and later we merged efforts from other Kubeflow training operators to provide a unified and simplified experience for both users and developers. We are very grateful to all who filed issues or helped resolve them, asked and answered questions, and were part of inspiring discussions. We'd also like to thank everyone who's contributed to and maintained the original operators.

* PyTorch Operator: [list of contributors](https://github.com/kubeflow/pytorch-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/pytorch-operator/blob/master/OWNERS).
* MPI Operator: [list of contributors](https://github.com/kubeflow/mpi-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/mpi-operator/blob/master/OWNERS).
* XGBoost Operator: [list of contributors](https://github.com/kubeflow/xgboost-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/xgboost-operator/blob/master/OWNERS).
* MXNet Operator: [list of contributors](https://github.com/kubeflow/mxnet-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/mxnet-operator/blob/master/OWNERS).
- PyTorch Operator: [list of contributors](https://github.com/kubeflow/pytorch-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/pytorch-operator/blob/master/OWNERS).
- MPI Operator: [list of contributors](https://github.com/kubeflow/mpi-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/mpi-operator/blob/master/OWNERS).
- XGBoost Operator: [list of contributors](https://github.com/kubeflow/xgboost-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/xgboost-operator/blob/master/OWNERS).
- MXNet Operator: [list of contributors](https://github.com/kubeflow/mxnet-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/mxnet-operator/blob/master/OWNERS).
10 changes: 5 additions & 5 deletions cmd/training-operator.v1/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import (
"fmt"
"os"

controller_v1 "github.com/kubeflow/tf-operator/pkg/controller.v1"
controller_v1 "github.com/kubeflow/training-operator/pkg/controller.v1"

// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
// to ensure that exec-entrypoint and run can make use of them.
Expand All @@ -33,10 +33,10 @@ import (
"sigs.k8s.io/controller-runtime/pkg/healthz"
"sigs.k8s.io/controller-runtime/pkg/log/zap"

mxnetv1 "github.com/kubeflow/tf-operator/pkg/apis/mxnet/v1"
pytorchv1 "github.com/kubeflow/tf-operator/pkg/apis/pytorch/v1"
tensorflowv1 "github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1"
xgboostv1 "github.com/kubeflow/tf-operator/pkg/apis/xgboost/v1"
mxnetv1 "github.com/kubeflow/training-operator/pkg/apis/mxnet/v1"
pytorchv1 "github.com/kubeflow/training-operator/pkg/apis/pytorch/v1"
tensorflowv1 "github.com/kubeflow/training-operator/pkg/apis/tensorflow/v1"
xgboostv1 "github.com/kubeflow/training-operator/pkg/apis/xgboost/v1"
//+kubebuilder:scaffold:imports
)

Expand Down
24 changes: 12 additions & 12 deletions docs/api/mxnet_generated.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,32 +16,32 @@ Package v1 is the v1 version of the API.
Package v1 contains API Schema definitions for the kubeflow.org v1 API group

.Resource Types
- xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]
- xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjoblist[$$MXJobList$$]
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjoblist[$$MXJobList$$]


=== Definitions

[id="{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-mxnet-v1-jobmodetype"]
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-jobmodetype"]
==== JobModeType (string)

JobModeType id the type for JobMode

.Appears In:
****
- xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjobspec[$$MXJobSpec$$]
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjobspec[$$MXJobSpec$$]
****



[id="{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjob"]
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjob"]
==== MXJob

MXJob is the Schema for the mxjobs API

.Appears In:
****
- xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjoblist[$$MXJobList$$]
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjoblist[$$MXJobList$$]
****

[cols="25a,75a", options="header"]
Expand All @@ -52,12 +52,12 @@ MXJob is the Schema for the mxjobs API
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ |
| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.

| *`spec`* __xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjobspec[$$MXJobSpec$$]__ |
| *`spec`* __xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjobspec[$$MXJobSpec$$]__ |
| *`status`* __xref:{anchor_prefix}-github-com-kubeflow-common-pkg-apis-common-v1-jobstatus[$$JobStatus$$]__ |
|===


[id="{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjoblist"]
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjoblist"]
==== MXJobList

MXJobList contains a list of MXJob
Expand All @@ -72,25 +72,25 @@ MXJobList contains a list of MXJob
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ |
| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.

| *`items`* __xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]__ |
| *`items`* __xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]__ |
|===


[id="{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjobspec"]
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjobspec"]
==== MXJobSpec

MXJobSpec defines the desired state of MXJob

.Appears In:
****
- xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]
****

[cols="25a,75a", options="header"]
|===
| Field | Description
| *`runPolicy`* __xref:{anchor_prefix}-github-com-kubeflow-common-pkg-apis-common-v1-runpolicy[$$RunPolicy$$]__ | RunPolicy encapsulates various runtime policies of the distributed training job, for example how to clean up resources and how long the job can stay active.
| *`jobMode`* __xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-mxnet-v1-jobmodetype[$$JobModeType$$]__ | JobMode specify the kind of MXjob to do. Different mode may have different MXReplicaSpecs request
| *`jobMode`* __xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-jobmodetype[$$JobModeType$$]__ | JobMode specify the kind of MXjob to do. Different mode may have different MXReplicaSpecs request
| *`mxReplicaSpecs`* __object (keys:ReplicaType, values:ReplicaSpec)__ | MXReplicaSpecs is map of common.ReplicaType and common.ReplicaSpec specifies the MX replicas to run. For example, { "Scheduler": common.ReplicaSpec, "Server": common.ReplicaSpec, "Worker": common.ReplicaSpec, }
|===

Expand Down
18 changes: 9 additions & 9 deletions docs/api/pytorch_generated.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,20 @@ Package v1 is the v1 version of the API.
Package v1 contains API Schema definitions for the kubeflow.org v1 API group

.Resource Types
- xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjob[$$PyTorchJob$$]
- xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjoblist[$$PyTorchJobList$$]
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjob[$$PyTorchJob$$]
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjoblist[$$PyTorchJobList$$]


=== Definitions

[id="{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjob"]
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjob"]
==== PyTorchJob

PyTorchJob Represents a PyTorchJob resource.

.Appears In:
****
- xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjoblist[$$PyTorchJobList$$]
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjoblist[$$PyTorchJobList$$]
****

[cols="25a,75a", options="header"]
Expand All @@ -40,12 +40,12 @@ PyTorchJob Represents a PyTorchJob resource.
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ | Standard Kubernetes type metadata.
| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.

| *`spec`* __xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjobspec[$$PyTorchJobSpec$$]__ | Specification of the desired state of the PyTorchJob.
| *`spec`* __xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjobspec[$$PyTorchJobSpec$$]__ | Specification of the desired state of the PyTorchJob.
| *`status`* __xref:{anchor_prefix}-github-com-kubeflow-common-pkg-apis-common-v1-jobstatus[$$JobStatus$$]__ | Most recently observed status of the PyTorchJob. Read-only (modified by the system).
|===


[id="{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjoblist"]
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjoblist"]
==== PyTorchJobList

PyTorchJobList is a list of PyTorchJobs.
Expand All @@ -60,18 +60,18 @@ PyTorchJobList is a list of PyTorchJobs.
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ | Standard type metadata.
| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.

| *`items`* __xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjob[$$PyTorchJob$$]__ | List of PyTorchJobs.
| *`items`* __xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjob[$$PyTorchJob$$]__ | List of PyTorchJobs.
|===


[id="{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjobspec"]
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjobspec"]
==== PyTorchJobSpec

PyTorchJobSpec is a desired state description of the PyTorchJob.

.Appears In:
****
- xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjob[$$PyTorchJob$$]
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjob[$$PyTorchJob$$]
****

[cols="25a,75a", options="header"]
Expand Down
18 changes: 9 additions & 9 deletions docs/api/tensorflow_generated.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,20 @@ Package v1 is the v1 version of the API.
Package v1 contains API Schema definitions for the kubeflow.org v1 API group

.Resource Types
- xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjob[$$TFJob$$]
- xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjoblist[$$TFJobList$$]
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjob[$$TFJob$$]
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjoblist[$$TFJobList$$]


=== Definitions

[id="{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjob"]
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjob"]
==== TFJob

TFJob represents a TFJob resource.

.Appears In:
****
- xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjoblist[$$TFJobList$$]
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjoblist[$$TFJobList$$]
****

[cols="25a,75a", options="header"]
Expand All @@ -40,12 +40,12 @@ TFJob represents a TFJob resource.
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ | Standard Kubernetes type metadata.
| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.

| *`spec`* __xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjobspec[$$TFJobSpec$$]__ | Specification of the desired state of the TFJob.
| *`spec`* __xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjobspec[$$TFJobSpec$$]__ | Specification of the desired state of the TFJob.
| *`status`* __xref:{anchor_prefix}-github-com-kubeflow-common-pkg-apis-common-v1-jobstatus[$$JobStatus$$]__ | Most recently observed status of the TFJob. Populated by the system. Read-only.
|===


[id="{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjoblist"]
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjoblist"]
==== TFJobList

TFJobList is a list of TFJobs.
Expand All @@ -60,18 +60,18 @@ TFJobList is a list of TFJobs.
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ | Standard type metadata.
| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.

| *`items`* __xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjob[$$TFJob$$]__ | List of TFJobs.
| *`items`* __xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjob[$$TFJob$$]__ | List of TFJobs.
|===


[id="{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjobspec"]
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjobspec"]
==== TFJobSpec

TFJobSpec is a desired state description of the TFJob.

.Appears In:
****
- xref:{anchor_prefix}-github-com-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjob[$$TFJob$$]
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjob[$$TFJob$$]
****

[cols="25a,75a", options="header"]
Expand Down
Loading