|
1 | 1 | # PyTorchJob Generator
|
2 | 2 |
|
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 |
4 | 4 | jobs for submission to an OpenShift cluster implementing MLBatch.
|
5 | 5 |
|
6 | 6 | Invocations of this chart generate a `PyTorchJob` wrapped into an `AppWrapper`
|
7 | 7 | for better traceability and fault-tolerance.
|
8 | 8 |
|
9 | 9 | ## Obtaining the Chart
|
10 | 10 |
|
11 |
| -To start with, recursively clone and enter this repository: |
| 11 | +To start with, add the `mlbatch` Helm chart repository. |
12 | 12 | ```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 |
15 | 24 | ```
|
16 | 25 |
|
17 | 26 | ## Configuring the Job
|
@@ -48,13 +57,13 @@ To learn more about the available settings see [chart/README.md](chart/README.md
|
48 | 57 |
|
49 | 58 | To submit the Pytorch job to the cluster using the `settings.yaml` file, run:
|
50 | 59 | ```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- |
52 | 61 | ```
|
53 |
| - |
| 62 | ++ |
54 | 63 | To optionally capture the generated `AppWrapper` specification as a
|
55 | 64 | `generated.yaml` file, run instead:
|
56 | 65 | ```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- |
58 | 67 | ```
|
59 | 68 |
|
60 | 69 | To remove the PyTorch job from the cluster, delete the generated `AppWrapper`
|
|
0 commit comments