Chopsticks v2 🥢

🔥 2.x version released, code refactored and new features added!

Who need this

• If you use a single computing node, and often run complex computing jobs, limited by hardware bottlenecks (RAM size, GPU memory size, number of CPU cores, etc.)
• When you are ready to leave, and the tasks you have submitted has not yet finished running, but you still wanna append some new tasks so that it has done more work when you come back.

Get Started

Requirements

• Python >= 3.6

Install

git clone https://github.com/InkosiZhong/Chopsticks.git
cd Chopsticks
sh setup.sh

setup.sh needs root permissions to install at /usr/local/bin

Or you can manually setup dist into the path

Uninstall

sh uninstall.sh # check for 1.x and 2.x versions

uninstall.sh needs root permissions to uninstall from /usr/local/bin

Usage

Chopsticks supports 7 commands: redirect, submit, cancel, restart, ls, clean, quit, you can use them with cs

cs reidirect

usage: cs redirect [--dst DST]

redirect: redirect the output

optional arguments:
  --dst DST   redirect destination
# Examples
cs redirect # redirect to current terminal
cs redirect --dst out # redirect the output into a file
cs redirect --dst /dev/pts/5 # redirect to a terminal

cs submit

usage: cs submit cmd [cmd ...]

submit: submit a new task

positional arguments:
  cmd         command you want to submit
# Examples
# if you have a add.py that input 2 args, such as
python test.py 0 1
# now you can submit them only by adding csubmit
cs submit python test.py 0 1
# Chopsticks will give you an unique id for this task
> [submit] id=0

cs cancel

usage: cs cancel [--id ID]

cancel: cancel a task by ID

optional arguments:
  --id ID     task ID you want to cancel
# Examples
cs submit python test.py 0 1
> [submit] id=0
cs submit python test.py 0 1
> [submit] id=1
cs cancal --id 1
> [cancel] id=1

cs restart

usage: cs restart --id ID

restart: restart a task by ID

optional arguments:
  --id ID     task ID you want to restart
# Example
cs submit python test.py 0 1
> [submit] id=0
cs cancel 0
> [cancel] id=0
cs restart 0
> [restart] id=0->1

cs ls

usage: cs ls [-l] [-p] [-n LATEST_N] [--done] [--not-done]

ls: list all tasks

optional arguments:
  -l, --long            show long info
  -p, --pid             show PID
  -n LATEST_N, --latest-n LATEST_N
                        show the latest n records
  --done                show the records that are already finished|crashed|cancelled
  --not-done            show the records that are still running|waiting
# Example
cs ls
>
  id  state      submit    command
----  ---------  --------  ------------------
   0  finished   22:35:02  python test.py 0 1
   1  cancelled  22:35:03  python test.py 0 1

cs ls -n 1 # the latest one
>
  id  state      submit    command
----  ---------  --------  ------------------
   1  cancelled  22:35:03  python test.py 0 1
   
cs ls -n 1 -l --done # the latest one that is done
>
  id  state      submit    start     end       duration        command
----  ---------  --------  --------  --------  --------------- ------------------
   1  cancelled  22:35:03  22:35:03  22:35:03  0 days 00:00:00 python test.py 0 1

cs clean

# Example
cs clean
> [clean] 2 tasks
cs ls
>
  id  state      submit    command
----  ---------  --------  ------------------

cs quit

usage: cs quit [-f]

cquit: quit the guard process

optional arguments:
  -f, --force  quit anyway, ignoring the running|waiting tasks

Known Issues and Solution

1. Output of the running task can not be redirect

Since I use the most intuitive method to implement the redirection part, once the task starts executing, it cannot be modified. In addition, all outputs are in the same file or terminal now. In the future Chopsticks may be support for redirecting to a different file for each task.

2. Doesn't support interactive tasks

Chopsticks exists to handle large-scale computing tasks, interactive tasks are not considered, please submit manually in the terminal.

3. Runtime environment

Chopsticks temporarily does not support different tasks to run in different environments, it mainly depends on the running environment of the guard process. If you want to modify the running environment (such as conda environment), please execute following commands

(base) cs quit
(base) conda activate env
(env) cs redirect # or any other commands
> [trigger] start a guard process
> [guard] guard process ready
> [redirect] set as /tmp/out.txt