Skip to content

Commit 4047bd7

Browse files
committed
Modify developer guide
1 parent 1c5d70a commit 4047bd7

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/development/developer_guide.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Developer Guide
22

3-
Tf-operator is currently at v1.
3+
Kubeflow Training Operator is currently at v1.
44

55
## Building the operator
66

@@ -11,7 +11,7 @@ mkdir -p ${go env GOPATH}/src/github.com/kubeflow
1111
ln -sf ${GIT_TRAINING} ${go env GOPATH}/src/github.com/kubeflow/training-operator
1212
```
1313

14-
* GIT_TRAINING should be the location where you checked out https://github.com/kubeflow/training-operator
14+
- GIT_TRAINING should be the location where you checked out https://github.com/kubeflow/training-operator
1515

1616
Install dependencies
1717

@@ -50,7 +50,7 @@ export KUBECONFIG=$(echo ~/.kube/config)
5050
export KUBEFLOW_NAMESPACE=$(your_namespace)
5151
```
5252

53-
* KUBEFLOW_NAMESPACE is used when deployed on Kubernetes, we use this variable to create other resources (e.g. the resource lock) internal in the same namespace. It is optional, use `default` namespace if not set.
53+
- KUBEFLOW_NAMESPACE is used when deployed on Kubernetes, we use this variable to create other resources (e.g. the resource lock) internal in the same namespace. It is optional, use `default` namespace if not set.
5454

5555
### Create the TFJob CRD
5656

@@ -83,11 +83,14 @@ On ubuntu the default go package appears to be gccgo-go which has problems see [
8383
## Generate Python SDK
8484

8585
To generate Python SDK for the operator, run:
86+
8687
```
8788
./hack/python-sdk/gen-sdk.sh
8889
```
90+
8991
This command will re-generate the api and model files together with the documentation and model tests.
9092
The following files/folders in `sdk/python` are auto-generated and should not be modified directly:
93+
9194
```
9295
docs
9396
kubeflow/training/models
@@ -99,15 +102,15 @@ test/*.py
99102

100103
### Python
101104

102-
* Use [yapf](https://github.com/google/yapf) to format Python code
103-
* `yapf` style is configured in `.style.yapf` file
104-
* To autoformat code
105+
- Use [yapf](https://github.com/google/yapf) to format Python code
106+
- `yapf` style is configured in `.style.yapf` file
107+
- To autoformat code
105108

106109
```sh
107110
yapf -i py/**/*.py
108111
```
109112

110-
* To sort imports
113+
- To sort imports
111114

112115
```sh
113116
isort path/to/module.py

0 commit comments

Comments
 (0)