Jobs

Job is the simplest execution unit. You can run it in a given runtime environment on a given resource preset with given storage volumes attached. Jobs are the building blocks of your project and should be planned carefully for optimal use of the resources.

Before you start a job, you must decide:

  • The Docker image to use to run the job. Note that the job terminates if the Docker container fails unless a specific restart policy is used for the job.

  • The preset - a combination of CPU, GPU, and memory resources to use.

In complex projects, you have multiple jobs running with different preset resources that are best suitable for these specific jobs.

What are presets?

Neu.ro lets you run a job in an environment on a given preset with several parts of the storage attached. A preset here is a combination of CPU, GPU, and memory resources allocated.

You must decide and set the amount of CPU, GPU, or memory resources you want to use for a job. By default, the cpu-small preset is used. These limits ensure that you can get better resource utilization within a compute cluster.

For example, we are using the cpu-small preset in the following command as the job doesn't need a lot of processing capacity.

Sample command:

(base) C:\Projects>neuro run --preset cpu-small --name test ubuntu echo Hello, World!
√ Job ID: job-aba12927-08f0-402c-8ed0-0a014bbdf87b
√ Name: test
- Status: pending Creating
- Status: pending Scheduling
√ Http URL: https://test--jane-doe.jobs.neuro-compute.org.neu.ro
√ The job will die in a day. See --life-span option documentation for details.
√ Status: succeeded
√ =========== Job is running in terminal mode ===========
√ (If you don't see a command prompt, try pressing enter)
√ (Use Ctrl-P Ctrl-Q key sequence to detach from the job)
Hello, World!

Neu.ro comes with a set of presets that are suitable for running different kinds of workloads. Some of the jobs may also require GPU resources. You can view the list of available presets using the neuro config show command.

(base) C:\Projects>neuro config show
User Configuration:
User Name jane-doe
Current Cluster neuro-compute
API URL https://staging.neu.ro/api/v1
Docker Registry URL https://registry.neuro-compute.org.neu.ro
Resource Presets:
Name #CPU Memory Preemptible Preemptible Node GPU Jobs Avail
────────────────────────────────────────────────────────────────────────────────────────────────────────
cpu-small 1 4.0G × × 65
cpu-medium 3 11.0G × × 18
cpu-large 7 26.0G × × 8
gpu-k80-small 5 48.0G × × 1 x nvidia-tesla-k80 25
gpu-k80-small-p 5.0 48.0G √ √ 1 x nvidia-tesla-k80 10
gpu-v100-small 5 95.0G × × 1 x nvidia-tesla-v100 10
gpu-v100-small-p 5.0 95.0G √ √ 1 x nvidia-tesla-v100 10

The command lists the available presets and their configurations. For example, the cpu-small preset includes 1 CPU, 4GB of memory, and no GPU. Whereas, the gpu-k80-small includes 5 CPU, 48GB memory, and an nvidia-tesla-k80 GPU.

How do I run a job?

To run a job in CLI, you can use the neuro run command. This command accepts a lot of different arguments, most of which are explained in this and the following sections.

Each job has a unique ID. For your convenience, you can give a job a name. There can only be a single PENDING or RUNNING job with a given name.

Each job has access to its ephemeral storage (which is essentially a part of SSD on the physical machine this job runs on). This type of storage is fast but not persistent: as soon as you kill the job, the data is lost.

To make the data persistent, you can mount volumes of platform storage to the job. This type of storage is slightly slower and has some limitations. For example, running model training on data from the mounted folder is generally 10-20% slower. Also, random write operations (e.g. unzipping an archive) are very slow and highly unrecommended.

Sample commands:

  • Run a fast job without mounting storage:

(base) C:\Projects>neuro run --preset cpu-small --name job230 ubuntu echo Hello, World!
√ Job ID: job-3ef0d955-bd2e-491a-aaea-f17b418fd4e8
√ Name: job230
- Status: pending Creating
- Status: pending Scheduling
√ Http URL: https://job230--jane-doe.jobs.neuro-compute.org.neu.ro
√ The job will die in a day. See --life-span option documentation for details.
√ Status: succeeded
√ =========== Job is running in terminal mode ===========
√ (If you don't see a command prompt, try pressing enter)
√ (Use Ctrl-P Ctrl-Q key sequence to detach from the job)
Hello, World!
  • Running a long training job with mounting storage

(base) C:\Projects>neuro run --name job303 --volume storage:nero-assistant/ModelCode/:/code:rw --preset cpu-small neuromation/base python code/train.py -d /data
√ Job ID: job-5a4942de-06ac-489d-8ac8-399640904991
√ Name: job303
- Status: pending Creating
- Status: pending Scheduling
√ Http URL: https://job303--jane-doe.jobs.neuro-compute.org.neu.ro
√ The job will die in a day. See --life-span option documentation for details.
√ Status: succeeded
√ =========== Job is running in terminal mode ===========
√ (If you don't see a command prompt, try pressing enter)
√ (Use Ctrl-P Ctrl-Q key sequence to detach from the job)
Your training script here. Data directory: /data

How can I see the list of currently running jobs?

You can use the neuro ps command to list the jobs that are currently running. You can use various options to filter the list of jobs based on status, owner, or by name. To know information about a particular job, you can use the neuro job status command.

Sample Commands:

  1. See the list of all currently running jobs

(base) C:\Projects>neuro ps
ID NAME STATUS WHEN IMAGE OWNER CLUSTER DESCRIPTION
job-3erw4f2e-cc57-4e4b-af04-c795b76d9ca8 job363 running 6 seconds ago ubuntu:latest <you> neuro-public
job-d2c04f2e-cc57-4e4b-af04-c795b76d9ca8 job390 pending 26 seconds ago ubuntu:latest <you> neuro-public
  1. See the list of jobs in the pending status

(base) C:\Projects>neuro ps -s pending
ID NAME STATUS WHEN IMAGE OWNER CLUSTER DESCRIPTION
job-d2c04f2e-cc57-4e4b-af04-c795b76d9ca8 job390 running 3 minutes ago ubuntu:latest <you> neuro-public

Can I connect to a job when it is running?

When running a job, you may sometimes want to connect to it and execute a command. You can use the neuro job exec command to connect to a running job.

Sample command:

  • Running a simple list command in the container hosting the job

(base) C:\Projects>neuro job exec job363 ls
bin dev home lib32 libx32 mnt proc run srv tmp varboot etc lib lib64 media opt root sbin sys usr
Connection to ssh-auth.neuro-public.org.neu.ro closed.
  • Providing a bash terminal to the container hosting the job

(base) C:\Projects>neuro job exec job363 /bin/bash
root@job-36d59977-84d2-40e5-9475-e4af25a06b6c:/# echo "Hello, World!"
Hello, World!
root@job-36d59977-84d2-40e5-9475-e4af25a06b6c:/# exit
exit
Connection to ssh-auth.neuro-public.org.neu.ro closed.

A bash terminal lets you work on the container while the job is running.

What are job states?

A job is the smallest execution unit that is run until completion or until it is killed. A job goes through many states until it completes or fails. You can view a job's current state by using the neuro job status command.

Sample command:

(base) C:\Projects>neuro job status filebrowser-49249
Job job-d31c2ce9-f27b-4de0-9b60-b619ff6ff2af
Name filebrowser-49249
Tags kind:web-widget, target:filebrowser
Owner jane-doe
Cluster neuro-compute
Status running
Image filebrowser/filebrowser:v2-alpine
Command --noauth --root /var/storage
Resources Memory 4.0G
CPU 1.0
Extended SHM space True
Life span 1d
TTY False
Volumes /var/storage storage:
/var/storage/.neuro storage:.neuro/
Internal Hostname job-d31c2ce9-f27b-4de0-9b60-b619ff6ff2af.platform-jobs
Internal Hostname Named filebrowser-49249--jane-doe.platform-jobs
Http URL https://filebrowser-49249--jane-doe.jobs.neuro-compute.org.neu.ro
Http port 80
Http authentication True
Environment NEURO_STEAL_CONFIG /var/storage/.neuro/85f68be9-6230-40ca-9c07-80d43275ee94-cfg
NEURO_PASSED_CONFIG eyJ0b2tlbiI6ICJleUpoYkdjaU9pSklVekkxTmlJc0luUjVjQ0k2SWtwWFZDSjkuZXlK…
Created 2021-01-12T19:36:37.468683+00:00
Started 2021-01-12T19:36:52.733308+00:00

A job can have one of the following states:

  • Pending: When the job is created and the resources for the job are allocated.

  • Running: When a job is being executed.

  • Complete: When a job is complete.

  • Failed: When a job fails and exits with an error code.

How do I expose the HTTP server running in a job?

A lot of applications you run on the platform have some web interface, such as Jupyter Notebooks, TensorBoard, and others. When you run a job containing such an application, you may access this web interface in your browser. For that, you need to pass a port that should be exposed via the --port option (which is 80 by default).

To open the exposed interface in the browser, there are several options:

  • Pass --browse as a neuro run parameter. In this case, an OS default web browser will open up as soon as the job is running;

  • Run neuro job browse <NAME or ID> when the job is already running;

  • Click on the HTTP URL for this job at the Neu.ro dashboard.

All jobs you run are hidden behind SSO by default. This means that if you share a link to the job web interface with someone, they will have to log into the platform and have granted permission to access the job (see the section below). To expose a job to everyone you need to pass --no-http-auth to neuro run. We strongly recommend avoiding this option unless you are completely sure that you want to omit the SSO security check.

Example:

neuro run --name filebrowser-demo --preset cpu-small --http 8085 --no-http-auth --browse --volume storage::/srv:rw filebrowser/filebrowser --noauth --port 8085

This command runs a FileBrowser instance on 8085 port, exposes this port, removes SSO check, and opens the web interface in your default browser when the job is running.

How do I control the job duration?

You can control the duration of time for which jobs run using the life-span configuration parameter. You can update the life-span parameter in the [job] section of the global configuration file. The global configuration file is located in the standard neuro config path. The Neu.ro CLI uses ~/.neuro folder by default, and the path for global config file is ~/.neuro/user.toml.

The parameter limits the default job run time, and is in string format. For example, a value of 2d3h20min would limit the job run time to 2 days, 3 hours, and 20 minutes.

You can also set this parameter on each job run using the corresponding option: neuro run --life-span 2h …

Example:

# jobs section
[job]
life-span = "2d3h20min"

How do I terminate a job?

You can terminate any job using the neuro job kill command. You must know the job name or job id to terminate a job.

Sample command:

(base) C:\Projects>neuro job kill filebrowser-49249
job-d31c2ce9-f27b-4de0-9b60-b619ff6ff2af

Can I share a job with others?

Yes, neu.ro lets you share any running jobs with you teammates. You can get all details of currently running jobs using the neuro ps command. This command lists all the jobs that you own and that are shared with you.

Sample command to view all running jobs:

(base) C:\Projects>neuro ps
ID NAME STATUS WHEN IMAGE OWNER CLUSTER DESCRIPTION
job-7c384fe1-af22-4514-9b06-e9445df46143 job390 pending 11 seconds ago pytorch:latest <you> neuro-public
job-0b8dc223-8d18-498b-a511-a1d643262e95 job363 pending 5 seconds ago ubuntu:latest <you> neuro-public

Before sharing a job, you must know its ID. After identifying the job you want to share, you must use the neuro share job command to share the job.

Sample command to share a job:

(base) C:\Projects>neuro share job:job363 mrsmariyadavydova manage

This shares the job363 job with mrsmariyadavydova and provides them access to manage it. You can provide the teammate the access to read, write, or manage a job. Now, your teammate can use the neuro ps command to view this job in their list of accessible jobs.

Where can I find a job's logs?

You can view the complete log for a job using the neuro job logs [job name or id] command. This command displays logs for the specified job.

The log is also displayed if you don't pass the --detach option when the job is run. The --detach option ensures that the job is not attached to logs and doesn't wait for an exit code.

Sample Command:

(base) C:\Projects>neuro job logs filebrowser-49249
2021/01/12 19:36:52 Using config file: /.filebrowser.json
2021/01/12 19:36:52 Listening on [::]:80
2021/01/12 19:36:55 /: 404 10.60.0.10 <nil>
2021/01/12 21:11:23 Caught signal terminated: shutting down.
2021/01/12 21:11:23 accept tcp [::]:80: use of closed network connection

Can I manage jobs from the web UI?

Neuro provides an intuitive interface that lets you manage jobs. The Jobs page of the Neu.ro web interface lists all the jobs.

Jobs page

You can view the web interface of the job by clicking the 'three dots' icon near the job and then clicking HTTP URL.

Navigating to the HTTP URL option

To view the log and and other details about a job, click on the job ID.

Job Details section

You can view only the currently running jobs by enabling the Running only checkbox.

Enabling the 'Running only' checkbox

You can search for specific jobs by using the Search box. The search functionality works with job names, IDs, and tags.

Searching for a specific job

The UI also lets you kill or rerun a job by clicking KILL or RERUN in the drop-down menu accessible through the 'three dots' icon near the job.

KILL and RERUN options