Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lululxvi/sumsjob
A simple Linux command-line utility which submits a job to one of the multiple GPU servers
https://github.com/lululxvi/sumsjob
command-line gpu resource-manager server slurm submitter workload-management workstation
Last synced: 4 days ago
JSON representation
A simple Linux command-line utility which submits a job to one of the multiple GPU servers
- Host: GitHub
- URL: https://github.com/lululxvi/sumsjob
- Owner: lululxvi
- License: gpl-3.0
- Created: 2019-02-06T16:45:44.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-16T22:25:37.000Z (3 months ago)
- Last Synced: 2024-08-16T23:29:17.127Z (3 months ago)
- Topics: command-line, gpu, resource-manager, server, slurm, submitter, workload-management, workstation
- Language: Python
- Homepage:
- Size: 554 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ΣΣJob
[](https://badge.fury.io/py/SumsJob)
[](https://pepy.tech/project/sumsjob)
[](https://github.com/lululxvi/sumsjob/blob/master/LICENSE)
ΣΣJob or SumsJob (**S**imple **U**tility for **M**ultiple-**S**ervers **Job** **Sub**mission) is a simple Linux command-line utility which submits a job to one of the multiple servers each with limited GPUs. ΣΣJob provides similar key functions for multiple servers as [Slurm Workload Manager](https://slurm.schedmd.com) for supercomputers and computer clusters. It provides the following key functions:
- report the state of GPUs on all servers,
- submit a job to servers for execution in noninteractive mode, i.e., the job will be running in the background of the server,
- submit a job to servers for execution in interactive mode, just as the job is running in your local machine,
- display all running jobs,
- cancel running jobs.
## Motivation
Assume you have a few GPU servers: `server1`, `server2`, ... When you need to run a code from your computer, you will
1. Select one server and log in
$ ssh LAN (You may need to first log in a local area network)
$ ssh server1
1. Check GPU status. If no free GPU, go to step 1
`$ nvidia-smi` or `$ gpustat`
1. Copy the code from your computer to the server
$ scp -r codes server1:~/project/codes
1. Run the code in the server
$ cd ~/project/codes
$ CUDA_VISIBLE_DEVICES=0 python main.py
1. Transfer back the results
$ scp server1:~/project/codes/results.dat .
These steps are boring. ΣΣJob makes all these steps automatic.
## Features
- Simple to use
- Two modes: noninteractive mode, and interactive mode
- Noninteractive mode: the job will be running in the background of the server
+ You can turn off your local machine
- Interactive mode: just as the job is running in your local machine
+ Display the output of the program in the terminal of your local machine in real time
+ Kill the job by Ctrl-C
## Commands
- [sinfo](#-sinfo): Report the state of GPUs on all servers.
- [srun](#-srun-jobfile-jobname): Submit a job to GPU servers for execution.
- [sacct](#-sacct): Display all running jobs ordered by the start time.
- [scancel](#-scancel-jobname): Cancel a running job.
### `$ sinfo`
Report the state of GPUs on all servers. For example,
```
$ sinfo
chitu Fri Dec 31 20:05:24 2021 470.74
[0] NVIDIA GeForce RTX 3080 | 27'C, 0 % | 2190 / 10018 MB | shuaim:python3/3589(2190M)
[1] NVIDIA GeForce RTX 3080 | 53'C, 7 % | 2159 / 10014 MB | lu:python/241697(2159M)
dilu Fri Dec 31 20:05:26 2021 470.74
[0] NVIDIA GeForce RTX 3080 Ti | 65'C, 73 % | 1672 / 12045 MB | chenxiwu:python/352456(1672M)
[1] NVIDIA GeForce RTX 3080 Ti | 54'C, 83 % | 1610 / 12053 MB | chenxiwu:python/352111(1610M)
Available GPU: chitu [0]
```
### `$ srun jobfile [jobname]`
Submit a job to GPU servers for execution. Automatically do the following steps:
1. Find a GPU with low utilization and sufficient memory (the criterion is in the configuration file).
- If currently no GPU available, it will wait for some time (`-p PERIOD_RETRY`) and then try again, until reaching the maximum retries (`-n NUM_RETRY`).
- You can also specify the server and GPU by `-s SERVER` and `--gpuid GPUID`.
1. Copy the code to the server.
1. Run the job on it in noninteractive mode (default) or interactive mode (with `-i`).
1. Save the output in a log file.
1. For interactive mode, when the code finishes, transfer back the result files and the log file.
- `jobfile` : File to be run
- `jobname` : Job name, and also the folder name of the job. If not provided, a random number will be used.
Options:
- `-h`, `--help` : Show this help message and exit
- `-i`, `--interact` : Run the job in interactive mode
- `-s SERVER`, `--server SERVER` : Server host name
- `--gpuid GPUID` : GPU ID to be used; -1 to use CPU only
- `-n NUM_RETRY`, `--num_retry NUM_RETRY` : Number of times to retry the submission (Default: 1000)
- `-p PERIOD_RETRY`, `--period_retry PERIOD_RETRY` : Waiting time (seconds) between two retries after each retry failure (Default: 600)
### `$ sacct`
Display all running jobs ordered by the start time. For example,
```
$ sacct
Server JobName Start
-------- ---------------- ----------------------
chitu job1 12/31/2021 07:41:08 PM
chitu job2 12/31/2021 08:14:54 PM
dilu job3 12/31/2021 08:15:23 PM
```
### `$ scancel jobname`
Cancel a running job.
- `jobname` : Job name.
## Installation
ΣΣJob requires Python 3.7 or later. Install with `pip`:
```
$ pip install sumsjob
```
You also need to do the following:
- Make sure you can `ssh` to each server, ideally without typing the password by SSH keys.
- Install [gpustat](https://github.com/wookayin/gpustat) in each server.
- Create a configuration file at `~/.sumsjob/config.py`. Use [config.py](https://github.com/lululxvi/sumsjob/blob/master/sumsjob/config.py) as a template, and modify the values to your configurations.
- Make sure `~/.local/bin` is in your `$PATH`.
Then run `sinfo` to check if everything works.
## License
[GNU GPLv3](LICENSE)