Skip to content

Commit 9f85508

Browse files
committed
Update README.md
Typo + rephrasing.
1 parent 922404f commit 9f85508

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
[![Build Status](https://travis-ci.org/SMART-Lab/smartdispatch.png)](https://travis-ci.org/SMART-Lab/smartdispatch)
2-
[![Coverage Status](https://coveralls.io/repos/SMART-Lab/smartdispatch/badge.png)](https://coveralls.io/r/SMART-Lab/smartdispatch)
32
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/SMART-Lab/smartdispatch/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/SMART-Lab/smartdispatch/?branch=master)
3+
[![Coverage Status](https://coveralls.io/repos/SMART-Lab/smartdispatch/badge.png)](https://coveralls.io/r/SMART-Lab/smartdispatch)
44
# Smart Dispatch
55
An easy to use job launcher for supercomputers with PBS compatible job manager.
66

77

88
## Features
99
- Launch multiple jobs with a single line.
10-
- Automactically generate combinations of arguments. *(see examples)*
11-
- Automatic ressource management. Determine for you the optimal fit for your commands on nodes.
10+
- Automatically generate combinations of arguments. *(see examples)*
11+
- Automatic resources management. Determine for you the optimal fit for your commands on nodes.
1212
- Resume batch of commands.
1313
- Easily manage logs.
1414
- Advanced mode for complete control.
@@ -20,29 +20,32 @@ An easy to use job launcher for supercomputers with PBS compatible job manager.
2020

2121
## Usage
2222
See `smart_dispatch.py --help`
23-
Output and error logs in are saved in : `./SMART_DISPATCH_LOGS/{batch_id}/logs/`.
23+
24+
Output and error logs in are saved in : *`./SMART_DISPATCH_LOGS/{batch_id}/logs/`*.
2425

2526

2627
## Examples
27-
###Launch Job
28+
### Launch job
2829
`smart_dispatch.py -q qtest@mp2 launch python my_script.py 2 80 tanh 0.1`
2930

30-
This will launch `python my_script.py 2 80 tanh 0.1` on the queue qtest@mp2.
31+
Will launch *`python my_script.py 2 80 tanh 0.1`* on the queue qtest@mp2.
3132

32-
###Launch Jobs Batch
33-
Automactically generate commands from combinations of arguments.
33+
### Launch batch of jobs
34+
Automatically generate commands from combinations of arguments.
3435

3536
`smart_dispatch.py -q qtest@mp2 launch python my_script.py [1 2] 80 [tanh sigmoid] 0.1`
3637

37-
This will generate 4 different commands and launch them on the queue qtest@mp2:
38+
Will generate 4 different commands and launch them on the queue qtest@mp2:
3839
```
3940
python my_script.py 1 80 sigmoid 0.1
4041
python my_script.py 1 80 tanh 0.1
4142
python my_script.py 2 80 sigmoid 0.1
4243
python my_script.py 2 80 tanh 0.1
4344
```
4445

45-
###Resuming Job
46-
Given the `batch_id` (i.e. folder's name in `SMART_DISPATCH_LOGS/{batch_id}/`) one can relaunch jobs that did not finished executing(maybe because of exeeded walltime).
47-
46+
### Resuming job/batch
4847
`smart_dispatch.py -q qtest@mp2 resume {batch_id}`
48+
49+
Jobs that did not terminate properly, for example, it exceeded the walltime, can be resumed using the {batch_id} given to you upon launch. Of course, all this assuming your script is resumable.
50+
51+
*Note: Jobs are always in a batch, even if it's a batch of one.*

0 commit comments

Comments
 (0)