Skip to content

Commit 55fd18b

Browse files
authored
direct users to helm chart repo (#9)
1 parent 0dd15f5 commit 55fd18b

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

tools/pytorchjob-generator/README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,26 @@
11
# PyTorchJob Generator
22

3-
The Helm chart provided in this folder facilitates the configuration of PyTorch
3+
The Helm chart defined in this folder facilitates the configuration of PyTorch
44
jobs for submission to an OpenShift cluster implementing MLBatch.
55

66
Invocations of this chart generate a `PyTorchJob` wrapped into an `AppWrapper`
77
for better traceability and fault-tolerance.
88

99
## Obtaining the Chart
1010

11-
To start with, recursively clone and enter this repository:
11+
To start with, add the `mlbatch` Helm chart repository.
1212
```sh
13-
git clone --recursive https://github.com/project-codeflare/mlbatch.git
14-
cd mlbatch
13+
helm repo add mlbatch https://project-codeflare.github.io/mlbatch
14+
helm repo update
15+
```
16+
To verify the chart was installed correctly, search for `AppWrapper`.
17+
```sh
18+
helm search repo AppWrapper
19+
```
20+
You should see output similar to the following:
21+
```sh
22+
NAME CHART VERSION APP VERSION DESCRIPTION
23+
mlbatch/pytorchjob-generator 1.0.0 v1beta2 An AppWrapper generator for PyTorchJobs
1524
```
1625

1726
## Configuring the Job
@@ -48,13 +57,13 @@ To learn more about the available settings see [chart/README.md](chart/README.md
4857
4958
To submit the Pytorch job to the cluster using the `settings.yaml` file, run:
5059
```sh
51-
helm template -f settings.yaml tools/pytorchjob-generator/chart | oc create -f-
60+
helm template -f settings.yaml mlbatch/pytorchjob-generator | oc create -f-
5261
```
53-
62+
+
5463
To optionally capture the generated `AppWrapper` specification as a
5564
`generated.yaml` file, run instead:
5665
```sh
57-
helm template -f settings.yaml tools/pytorchjob-generator/chart | tee generated.yaml | oc create -f-
66+
helm template -f settings.yaml mlbatch/pytorchjob-generator | tee generated.yaml | oc create -f-
5867
```
5968

6069
To remove the PyTorch job from the cluster, delete the generated `AppWrapper`

0 commit comments

Comments
 (0)