Skip to content

Commit 9380ad8

Browse files
committed
Modify developer guide
1 parent 7f33518 commit 9380ad8

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
## Requirements
66

@@ -15,7 +15,7 @@ mkdir -p ${go env GOPATH}/src/github.com/kubeflow
1515
ln -sf ${GIT_TRAINING} ${go env GOPATH}/src/github.com/kubeflow/training-operator
1616
```
1717

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

2020
Install dependencies
2121

@@ -54,7 +54,7 @@ export KUBECONFIG=$(echo ~/.kube/config)
5454
export KUBEFLOW_NAMESPACE=$(your_namespace)
5555
```
5656

57-
* 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.
57+
- 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.
5858

5959
### Create the TFJob CRD
6060

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

8989
To generate Python SDK for the operator, run:
90+
9091
```
9192
./hack/python-sdk/gen-sdk.sh
9293
```
94+
9395
This command will re-generate the api and model files together with the documentation and model tests.
9496
The following files/folders in `sdk/python` are auto-generated and should not be modified directly:
97+
9598
```
9699
docs
97100
kubeflow/training/models
@@ -103,15 +106,15 @@ test/*.py
103106

104107
### Python
105108

106-
* Use [yapf](https://github.com/google/yapf) to format Python code
107-
* `yapf` style is configured in `.style.yapf` file
108-
* To autoformat code
109+
- Use [yapf](https://github.com/google/yapf) to format Python code
110+
- `yapf` style is configured in `.style.yapf` file
111+
- To autoformat code
109112

110113
```sh
111114
yapf -i py/**/*.py
112115
```
113116

114-
* To sort imports
117+
- To sort imports
115118

116119
```sh
117120
isort path/to/module.py

0 commit comments

Comments
 (0)