Skip to content

Commit 4b5d651

Browse files
authored
Update links and files with the new URL (#1434)
* Update links and corresponding files for training-operator repository Use Go 1.17 * Generate SDK * Remove Travis * Modify developer guide * Fix go mod * Fix legacy docs * Generate SDK * Remove travis * Update ignore files
1 parent 75d4c3b commit 4b5d651

File tree

90 files changed

+407
-380
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+407
-380
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,5 @@ examples/.ipynb_checkpoints/
4141
# openapi-codegen tools and auto generated files but useless
4242
hack/python-sdk/openapi-generator-cli.jar
4343

44+
# Coverage
45+
cover.out

PROJECT

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
11
layout:
22
- go.kubebuilder.io/v3
3-
projectName: tf-operator
4-
repo: github.com/kubeflow/tf-operator
3+
projectName: training-operator
4+
repo: github.com/kubeflow/training-operator
55
resources:
66
- api:
77
crdVersion: v1
88
namespaced: true
99
controller: true
1010
group: kubeflow.org
1111
kind: XGBoostJob
12-
path: github.com/kubeflow/tf-operator/pkg/apis/xgboost/v1
12+
path: github.com/kubeflow/training-operator/pkg/apis/xgboost/v1
1313
version: v1
1414
- api:
1515
crdVersion: v1
1616
namespaced: true
1717
controller: true
1818
group: kubeflow.org
1919
kind: PyTorchJob
20-
path: github.com/kubeflow/tf-operator/pkg/apis/pytorch/v1
20+
path: github.com/kubeflow/training-operator/pkg/apis/pytorch/v1
2121
version: v1
2222
- api:
2323
crdVersion: v1
2424
namespaced: true
2525
controller: true
2626
group: kubeflow.org
2727
kind: TFJob
28-
path: github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1
28+
path: github.com/kubeflow/training-operator/pkg/apis/tensorflow/v1
2929
version: v1
3030
- api:
3131
crdVersion: v1
3232
namespaced: true
3333
controller: true
3434
group: kubeflow.org
3535
kind: MXJob
36-
path: github.com/kubeflow/tf-operator/pkg/apis/mxnet/v1
36+
path: github.com/kubeflow/training-operator/pkg/apis/mxnet/v1
3737
version: v1
3838
version: "3"

README.md

+20-19
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Kubeflow Training Operator
22

33
[![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)
4-
[![Coverage Status](https://coveralls.io/repos/github/kubeflow/training-operator/badge.svg?branch=master)](https://coveralls.io/github/kubeflow/tf-operator?branch=master)
4+
[![Coverage Status](https://coveralls.io/repos/github/kubeflow/training-operator/badge.svg?branch=master)](https://coveralls.io/github/kubeflow/training-operator?branch=master)
55
[![Go Report Card](https://goreportcard.com/badge/github.com/kubeflow/training-operator)](https://goreportcard.com/report/github.com/kubeflow/training-operator)
66

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

2323
## Prerequisites
2424

25-
* Version >= 1.16 of Kubernetes
26-
* Version >= 3.x of Kustomize
27-
* Version >= 1.21.x of Kubectl
25+
- Version >= 1.16 of Kubernetes
26+
- Version >= 3.x of Kustomize
27+
- Version >= 1.21.x of Kubectl
2828

2929
## Installation
3030

3131
### Master Branch
3232

3333
```bash
34-
kubectl apply -k "github.com/kubeflow/tf-operator/manifests/overlays/standalone"
34+
kubectl apply -k "github.com/kubeflow/training-operator/manifests/overlays/standalone"
3535
```
3636

3737
### Stable Release
3838

3939
```bash
40-
kubectl apply -k "github.com/kubeflow/tf-operator/manifests/overlays/standalone?ref=v1.3.0"
40+
kubectl apply -k "github.com/kubeflow/training-operator/manifests/overlays/standalone?ref=v1.3.0"
4141
```
4242

4343
### Tensorflow Release Only
4444

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

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

5151
### Python SDK for Kubeflow Training Operator
5252

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

5555
Use `pip install` command to install the latest release of the SDK:
56+
5657
```
5758
pip install kubeflow-training
5859
```
@@ -64,6 +65,7 @@ Please refer to the [quick-start-v1.md](docs/quick-start-v1.md) and [Kubeflow Tr
6465
## API Documentation
6566

6667
Please refer to API Documentation.
68+
6769
- [Tensorflow API Documentation](docs/api/tensorflow_generated.asciidoc)
6870
- [PyTorch API Documentation](docs/api/pytorch_generated.asciidoc)
6971
- [MXNet API Documentation](docs/api/mxnet_generated.asciidoc)
@@ -82,7 +84,6 @@ This is a part of Kubeflow, so please see [readme in kubeflow/kubeflow](https://
8284

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

85-
8687
## Change Log
8788

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

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

94-
| Operator Version | API Version | Kubernetes Version |
95-
| ------------- | ------------- | ------------- |
96-
| `v1.0.x`| `v1` | 1.16+ |
97-
| `v1.1.x`| `v1` | 1.16+ |
98-
| `v1.2.x`| `v1` | 1.16+ |
99-
| `v1.3.x`| `v1` | 1.18+ |
100-
| `latest` (master HEAD) | `v1` | 1.18+ |
95+
| Operator Version | API Version | Kubernetes Version |
96+
| ---------------------- | ----------- | ------------------ |
97+
| `v1.0.x` | `v1` | 1.16+ |
98+
| `v1.1.x` | `v1` | 1.16+ |
99+
| `v1.2.x` | `v1` | 1.16+ |
100+
| `v1.3.x` | `v1` | 1.18+ |
101+
| `latest` (master HEAD) | `v1` | 1.18+ |
101102

102103
## Acknowledgement
103104

104105
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.
105106

106-
* PyTorch Operator: [list of contributors](https://github.com/kubeflow/pytorch-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/pytorch-operator/blob/master/OWNERS).
107-
* MPI Operator: [list of contributors](https://github.com/kubeflow/mpi-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/mpi-operator/blob/master/OWNERS).
108-
* XGBoost Operator: [list of contributors](https://github.com/kubeflow/xgboost-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/xgboost-operator/blob/master/OWNERS).
109-
* MXNet Operator: [list of contributors](https://github.com/kubeflow/mxnet-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/mxnet-operator/blob/master/OWNERS).
107+
- PyTorch Operator: [list of contributors](https://github.com/kubeflow/pytorch-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/pytorch-operator/blob/master/OWNERS).
108+
- MPI Operator: [list of contributors](https://github.com/kubeflow/mpi-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/mpi-operator/blob/master/OWNERS).
109+
- XGBoost Operator: [list of contributors](https://github.com/kubeflow/xgboost-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/xgboost-operator/blob/master/OWNERS).
110+
- MXNet Operator: [list of contributors](https://github.com/kubeflow/mxnet-operator/graphs/contributors) and [maintainers](https://github.com/kubeflow/mxnet-operator/blob/master/OWNERS).

cmd/training-operator.v1/main.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import (
2121
"fmt"
2222
"os"
2323

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

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

36-
mxnetv1 "github.com/kubeflow/tf-operator/pkg/apis/mxnet/v1"
37-
pytorchv1 "github.com/kubeflow/tf-operator/pkg/apis/pytorch/v1"
38-
tensorflowv1 "github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1"
39-
xgboostv1 "github.com/kubeflow/tf-operator/pkg/apis/xgboost/v1"
36+
mxnetv1 "github.com/kubeflow/training-operator/pkg/apis/mxnet/v1"
37+
pytorchv1 "github.com/kubeflow/training-operator/pkg/apis/pytorch/v1"
38+
tensorflowv1 "github.com/kubeflow/training-operator/pkg/apis/tensorflow/v1"
39+
xgboostv1 "github.com/kubeflow/training-operator/pkg/apis/xgboost/v1"
4040
//+kubebuilder:scaffold:imports
4141
)
4242

docs/api/mxnet_generated.asciidoc

+12-12
Original file line numberDiff line numberDiff line change
@@ -16,32 +16,32 @@ Package v1 is the v1 version of the API.
1616
Package v1 contains API Schema definitions for the kubeflow.org v1 API group
1717

1818
.Resource Types
19-
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]
20-
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjoblist[$$MXJobList$$]
19+
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]
20+
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjoblist[$$MXJobList$$]
2121

2222

2323
=== Definitions
2424

25-
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-mxnet-v1-jobmodetype"]
25+
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-mxnet-v1-jobmodetype"]
2626
==== JobModeType (string)
2727

2828
JobModeType id the type for JobMode
2929

3030
.Appears In:
3131
****
32-
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjobspec[$$MXJobSpec$$]
32+
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjobspec[$$MXJobSpec$$]
3333
****
3434

3535

3636

37-
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjob"]
37+
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjob"]
3838
==== MXJob
3939

4040
MXJob is the Schema for the mxjobs API
4141

4242
.Appears In:
4343
****
44-
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjoblist[$$MXJobList$$]
44+
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjoblist[$$MXJobList$$]
4545
****
4646

4747
[cols="25a,75a", options="header"]
@@ -52,12 +52,12 @@ MXJob is the Schema for the mxjobs API
5252
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ |
5353
| *`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`.
5454

55-
| *`spec`* __xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjobspec[$$MXJobSpec$$]__ |
55+
| *`spec`* __xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjobspec[$$MXJobSpec$$]__ |
5656
| *`status`* __xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-common-pkg-apis-common-v1-jobstatus[$$JobStatus$$]__ |
5757
|===
5858

5959

60-
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjoblist"]
60+
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjoblist"]
6161
==== MXJobList
6262

6363
MXJobList contains a list of MXJob
@@ -72,25 +72,25 @@ MXJobList contains a list of MXJob
7272
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ |
7373
| *`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`.
7474

75-
| *`items`* __xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]__ |
75+
| *`items`* __xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]__ |
7676
|===
7777

7878

79-
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjobspec"]
79+
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjobspec"]
8080
==== MXJobSpec
8181

8282
MXJobSpec defines the desired state of MXJob
8383

8484
.Appears In:
8585
****
86-
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]
86+
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]
8787
****
8888

8989
[cols="25a,75a", options="header"]
9090
|===
9191
| Field | Description
9292
| *`runPolicy`* __xref:{anchor_prefix}-g.yxqyang.asia-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.
93-
| *`jobMode`* __xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-mxnet-v1-jobmodetype[$$JobModeType$$]__ | JobMode specify the kind of MXjob to do. Different mode may have different MXReplicaSpecs request
93+
| *`jobMode`* __xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-mxnet-v1-jobmodetype[$$JobModeType$$]__ | JobMode specify the kind of MXjob to do. Different mode may have different MXReplicaSpecs request
9494
| *`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, }
9595
|===
9696

docs/api/pytorch_generated.asciidoc

+9-9
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,20 @@ Package v1 is the v1 version of the API.
1616
Package v1 contains API Schema definitions for the kubeflow.org v1 API group
1717

1818
.Resource Types
19-
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjob[$$PyTorchJob$$]
20-
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjoblist[$$PyTorchJobList$$]
19+
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjob[$$PyTorchJob$$]
20+
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjoblist[$$PyTorchJobList$$]
2121

2222

2323
=== Definitions
2424

25-
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjob"]
25+
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjob"]
2626
==== PyTorchJob
2727

2828
PyTorchJob Represents a PyTorchJob resource.
2929

3030
.Appears In:
3131
****
32-
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjoblist[$$PyTorchJobList$$]
32+
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjoblist[$$PyTorchJobList$$]
3333
****
3434

3535
[cols="25a,75a", options="header"]
@@ -40,12 +40,12 @@ PyTorchJob Represents a PyTorchJob resource.
4040
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ | Standard Kubernetes type metadata.
4141
| *`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`.
4242

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

4747

48-
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjoblist"]
48+
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjoblist"]
4949
==== PyTorchJobList
5050

5151
PyTorchJobList is a list of PyTorchJobs.
@@ -60,18 +60,18 @@ PyTorchJobList is a list of PyTorchJobs.
6060
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ | Standard type metadata.
6161
| *`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`.
6262

63-
| *`items`* __xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjob[$$PyTorchJob$$]__ | List of PyTorchJobs.
63+
| *`items`* __xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjob[$$PyTorchJob$$]__ | List of PyTorchJobs.
6464
|===
6565

6666

67-
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjobspec"]
67+
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjobspec"]
6868
==== PyTorchJobSpec
6969

7070
PyTorchJobSpec is a desired state description of the PyTorchJob.
7171

7272
.Appears In:
7373
****
74-
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-pytorch-v1-pytorchjob[$$PyTorchJob$$]
74+
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-pytorch-v1-pytorchjob[$$PyTorchJob$$]
7575
****
7676

7777
[cols="25a,75a", options="header"]

docs/api/tensorflow_generated.asciidoc

+9-9
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,20 @@ Package v1 is the v1 version of the API.
1616
Package v1 contains API Schema definitions for the kubeflow.org v1 API group
1717

1818
.Resource Types
19-
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjob[$$TFJob$$]
20-
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjoblist[$$TFJobList$$]
19+
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjob[$$TFJob$$]
20+
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjoblist[$$TFJobList$$]
2121

2222

2323
=== Definitions
2424

25-
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjob"]
25+
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjob"]
2626
==== TFJob
2727

2828
TFJob represents a TFJob resource.
2929

3030
.Appears In:
3131
****
32-
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjoblist[$$TFJobList$$]
32+
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjoblist[$$TFJobList$$]
3333
****
3434

3535
[cols="25a,75a", options="header"]
@@ -40,12 +40,12 @@ TFJob represents a TFJob resource.
4040
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ | Standard Kubernetes type metadata.
4141
| *`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`.
4242

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

4747

48-
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjoblist"]
48+
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjoblist"]
4949
==== TFJobList
5050

5151
TFJobList is a list of TFJobs.
@@ -60,18 +60,18 @@ TFJobList is a list of TFJobs.
6060
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ | Standard type metadata.
6161
| *`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`.
6262

63-
| *`items`* __xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjob[$$TFJob$$]__ | List of TFJobs.
63+
| *`items`* __xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjob[$$TFJob$$]__ | List of TFJobs.
6464
|===
6565

6666

67-
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjobspec"]
67+
[id="{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjobspec"]
6868
==== TFJobSpec
6969

7070
TFJobSpec is a desired state description of the TFJob.
7171

7272
.Appears In:
7373
****
74-
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-tf-operator-pkg-apis-tensorflow-v1-tfjob[$$TFJob$$]
74+
- xref:{anchor_prefix}-g.yxqyang.asia-kubeflow-training-operator-pkg-apis-tensorflow-v1-tfjob[$$TFJob$$]
7575
****
7676

7777
[cols="25a,75a", options="header"]

0 commit comments

Comments
 (0)