cluv
This is a quick overview. For more information, check out the introduction.
Installation
Add the package to your project with uv add or pip install:
Install as a command-line tool in an isolated environment:
If you want the bleeding edge version from GitHub, use:
Usage
To view all available commands, use the --help flag:
Here are some common workflows:
Setup cluv in an existing project
cd ~/my-project # Cluv requires your project to be located somewhere under your home directory (`$HOME`).
cluv init
Establish SSH connections to all clusters
Sync your project on all clusters
Need to set up dataset replication with cluv sync? See the
"Syncing datasets" guide.
Launch a Hydra sweep on a remote cluster
See the Hydra launcher page for setup and usage.
Sync your project on a specific cluster
Clean up old run results from the clusters
See the "Cleaning runs" guide for details on how this decides what's safe to delete.
Submit a job to a specific cluster
See the "Configuring job submission" guide for details on how to use the config to submit jobs.
Run a command in the synced project a specific cluster
Check the status of your clusters and jobs
How the commands are used together
graph LR
init(<b>cluv init</b> <br> Init project)
sync(<b>cluv sync</b> <br> Sync project on clusters)
login(<b>cluv login</b> <br> Connect to clusters)
submit(<b>cluv submit</b> <br> Submit jobs to clusters)
status(<b>cluv status</b> <br> See clusters and jobs status)
disable(<b>cluv disable</b> <br> Disable access to clusters)
enable(<b>cluv enable</b> <br> Enable access to clusters)
clean(<b>cluv clean</b> <br> Clean old logs on clusters)
run(<b>cluv run</b> <br> Run commands on clusters)
init ===> login
init ==> disable
init ==> enable
login ===> sync
login ===> submit
login ===> status
login ===> clean
login ===> run
click init "commands/#cluv-init"
click login "commands/#cluv-login"
click sync "commands/#cluv-sync"
click submit "commands/#cluv-submit"
click status "commands/#cluv-status"
click disable "commands/#cluv-disable"
click enable "commands/#cluv-enable"
click clean "commands/#cluv-clean"
click run "commands/#cluv-run"