Running Jupyter Trainings

Introduction

End Goal

  • Submit Jupyter trainings using the runai-bgu CLI.

Submitting a Jupyter Training Job

Example 1. Explicit resources
$ ssh bhn20 (1)
$ runai-bgu submit jupyter \ (2)
  -n conv-2-64 \ (3)
  -c 2 \ (4)
  -m 4Gi \ (5)
  -g 1 \ (6)
  -- "jupyter execute notebook.ipynb" (7)
1 Configure SSH connection to bhn20
2 Specifies it is a Jupyter.
3 Specifies the name of the job.
4 Allocates 2 CPU cores.
5 Allocates 4GiB of memory*.
6 Specifies the GPU allocation(Whole or fractions). If you do not need GPU, do not use this flag.
7 The command to run, here jupyter execute.
The space ( ) between the two dashes (--) and the command is intentional. As are the quotes (") surrounding the command.
When running the command you can change directory to the location of your jupyter file (cd ~/path/to/file && jupyter execute notebook.ipynb), or give the full path (jupyter execute ~/path/to/file/notebook.ipynb).

You can also use a predefined resource template. Check out the guide for the template CLI Introduction.

Example 2. Using User Templates:
$ runai-bgu submit jupyter \ (1)
  -n conv-2-64 (2)
  --ut train-over-quota-user (3)
  -- "jupyter execute notebook.ipynb" (4)
1 Submit a jupyter workload
2 Specify the job name
3 Use the --ut specify the user template
4 The command to run, here jupyter execute.
The space ( ) between the two dashes (--) and the command is intentional. As are the quotes (") surrounding the command.
When running the command you can change directory to the location of your jupyter file (cd ~/path/to/file && jupyter execute notebook.ipynb), or give the full path (jupyter execute ~/path/to/file/notebook.ipynb).
Example 3. Using Group Templates:
$ runai-bgu submit jupyter \ (1)
  -n conv-2-64 (2)
  --ug train-over-quota-group  (3)
  -- "jupyter execute notebook.ipynb" (4)
1 Submit a jupyter workload
2 Specify the job name
3 Use the --ug specify the group template
4 The command to run, here jupyter execute notebook.ipynb.
The space ( ) between the two dashes (--) and the command is intentional. As are the quotes (") surrounding the command.
When running the command you can change directory to the location of your jupyter file (cd ~/path/to/file && jupyter execute notebook.ipynb), or give the full path (jupyter execute ~/path/to/file/notebook.ipynb).

Submitting Job

The CLI will display messages about the job creation and status.

Example 4. Synopsis
Start job for training
$ ssh bhn20 (1)
$ runai-bgu submit jupyter -n conv-2-64 --ut train-over-quota -- "jupyter execute notebook.ipynb" (2)
Waiting for the job to be created...

Job conv-2-64 submitted successfully.
You can check the status of the job by running:
        runai describe job conv-2-64 -p myproj
1 Configure SSH connection to bhn20 manual.adoc[runai-bgu]