Skip to content

Commit

Permalink
direct users to helm chart repo (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
dgrove-oss authored Jun 28, 2024
1 parent 0dd15f5 commit 55fd18b
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions tools/pytorchjob-generator/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,26 @@
# PyTorchJob Generator

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

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

## Obtaining the Chart

To start with, recursively clone and enter this repository:
To start with, add the `mlbatch` Helm chart repository.
```sh
git clone --recursive https://github.com/project-codeflare/mlbatch.git
cd mlbatch
helm repo add mlbatch https://project-codeflare.github.io/mlbatch
helm repo update
```
To verify the chart was installed correctly, search for `AppWrapper`.
```sh
helm search repo AppWrapper
```
You should see output similar to the following:
```sh
NAME CHART VERSION APP VERSION DESCRIPTION
mlbatch/pytorchjob-generator 1.0.0 v1beta2 An AppWrapper generator for PyTorchJobs
```

## Configuring the Job
Expand Down Expand Up @@ -48,13 +57,13 @@ To learn more about the available settings see [chart/README.md](chart/README.md
To submit the Pytorch job to the cluster using the `settings.yaml` file, run:
```sh
helm template -f settings.yaml tools/pytorchjob-generator/chart | oc create -f-
helm template -f settings.yaml mlbatch/pytorchjob-generator | oc create -f-
```

+
To optionally capture the generated `AppWrapper` specification as a
`generated.yaml` file, run instead:
```sh
helm template -f settings.yaml tools/pytorchjob-generator/chart | tee generated.yaml | oc create -f-
helm template -f settings.yaml mlbatch/pytorchjob-generator | tee generated.yaml | oc create -f-
```

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

0 comments on commit 55fd18b

Please sign in to comment.