Skip to content

Commit 718a322

Browse files
committed
Update docs
1 parent 36d95f0 commit 718a322

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# &Sigma;&Sigma;<sub>Job</sub>
22

3+
[![PyPI version](https://badge.fury.io/py/SumsJob.svg)](https://badge.fury.io/py/SumsJob)
4+
[![License](https://img.shields.io/github/license/lululxvi/sumsjob)](https://github.com/lululxvi/sumsjob/blob/master/LICENSE)
5+
36
&Sigma;&Sigma;<sub>Job</sub> or Sums<sub>Job</sub> (**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 resources. It will first look for servers with available resources, such as GPUs, and then run the job in that server interactively just as the job is running in your local machine.
47

5-
**Tutorial**: [Slides](tutorials/sumsjob.pdf)
8+
**Tutorial**: [Slides](https://github.com/lululxvi/sumsjob/blob/master/tutorials/sumsjob.pdf)
69

710
## Features
811

@@ -41,7 +44,7 @@ Then, you can install Sums<sub>Job</sub> with `pip`:
4144
$ pip install sumsjob
4245
```
4346

44-
You need to have a configuration file at `~/.sumsjob/config.py`. Use [config.py](sumsjob/config.py) as a template, and modify the values to your configurations.
47+
You need to have 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.
4548

4649
- Make sure you can `ssh` to each server.
4750
- Run `gpuresource` to check if everything works. Make sure `~/.local/bin` is in your `$PATH`.

0 commit comments

Comments
 (0)