Skip to content

updating readme for singularity runner #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

updating readme for singularity runner #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 28 additions & 4 deletions emdenoise/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## EMDenoise: Electron Microscopy Benchmark

Authors: Patrick Austin (RAL, STFC), Keith Butler (SciML, STFC)*, Jeyan Thiyagalingam*, and Tony Hey.
Authors: Patrick Austin (RAL, STFC), Keith Butler (SciML, STFC)*, Jeyan Thiyagalingam(SciML, RAL, STFC)*, and Tony Hey.
*(Corresponding)

### Overview
Expand Down Expand Up @@ -69,16 +69,40 @@ git clone https://github.com/mlperf/mlcube_examples.git && cd ./mlcube_examples/
```

## Run EMDenoise MLCube on a local machine with Docker runner
```
# Configure EMDenoise MLCube

### Configure EMDenoise MLCube

```bash
mlcube_docker configure --mlcube=. --platform=platforms/docker.yaml
```

# Run EMDenoise tasks: download data, preprocess data train and test the model
### Run EMDenoise tasks: download data, preprocess data train and test the model

```bash
mlcube_docker run --mlcube=. --platform=platforms/docker.yaml --task=run/download.yaml
mlcube_docker run --mlcube=. --platform=platforms/docker.yaml --task=run/preprocess.yaml
mlcube_docker run --mlcube=. --platform=platforms/docker.yaml --task=run/train.yaml
mlcube_docker run --mlcube=. --platform=platforms/docker.yaml --task=run/test.yaml
```


## Run EMDenoise MLCube on a local machine with Docker runner

### Configure EMDenoise MLCube

```bash
mlcube_singularity configure --mlcube=. --platform=platforms/singularity.yaml
```

### Run EMDenoise tasks: download data, preprocess data train and test the model

```bash
mlcube_singularity run --mlcube=. --platform=platforms/singularity.yaml --task=run/download.yaml
mlcube_singularity run --mlcube=. --platform=platforms/singularity.yaml --task=run/preprocess.yaml
mlcube_singularity run --mlcube=. --platform=platforms/singularity.yaml --task=run/train.yaml
mlcube_singularity run --mlcube=. --platform=platforms/singularity.yaml --task=run/test.yaml
```

Go to `workspace/` directory and study its content.

## Contribution
Expand Down