Skip to main content

A utility to create and launch code experiments on local or remote machines.

Project description

SbatchMan

SbatchMan

A utility to create and launch code experiments on SLURM, PBS, or local machines.

Installation

You can install SbatchMan using pip:

pip install .

Or for development:

pip install -e .

Usage

The tool is organized into three main commands: configure, launch, and status.

Configure an Experiment

First, create a configuration for a specific environment (SLURM, PBS, or local). Configurations are stored in sbatchman/configs/.

SLURM Example:

sbatchman configure slurm --name my-gpu-job \
--partition gpu_queue \
--cpus-per-task 4 \
--mem "16G" \
--gpus 1 \
--time "01:00:00" \
--env "CUDA_VISIBLE_DEVICES=0"

PBS Example:

sbatchman configure pbs --name my-pbs-job \
--queue standard \
--cpus 4 \
--mem "16gb" \
--walltime "01:00:00"

Local Example:

sbatchman configure local --name my-local-job \
--env "MY_VAR=hello"

Launch an Experiment

Use the configuration name to launch your code.

sbatchman launch --config-name my-gpu-job \
"python my_project/train.py --learning-rate 0.001 --epochs 50"

The command to execute must be passed as a single string.

Check Experiment Status

Launch the interactive TUI to monitor your jobs.

sbatchman status

This TUI shows queued, running, and finished jobs. You can select a job to view its live stdout and stderr logs.

Keybindings in TUI:

  • Up/Down/k/j: Navigate jobs
  • Enter: View logs for the selected job
  • b: Go back from log view to job list
  • q: Quit the application

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sbatchman-0.1.0.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sbatchman-0.1.0-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file sbatchman-0.1.0.tar.gz.

File metadata

  • Download URL: sbatchman-0.1.0.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sbatchman-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e5c6ed271ad5d78ef30d34097d0fb33534f91d8f48a1a6befe63ea95752f1f6b
MD5 235c333c081be5ef8a29d9d447c8b78a
BLAKE2b-256 08589b3958f4bd5db9568d7c1527658fe39695d45b74681ccf4a286742ba63cc

See more details on using hashes here.

Provenance

The following attestation bundles were made for sbatchman-0.1.0.tar.gz:

Publisher: pypi-publish.yml on LorenzoPichetti/SbatchMan

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sbatchman-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sbatchman-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sbatchman-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b5b2ec19704e08a06ae6bab814e9123abd4a666156a5216370efdf04937cd895
MD5 8032437f73fc6a732cf9c091d2f29185
BLAKE2b-256 044997dd5364141aef29692a5b0465c3223f98a1f5602e23b6e35e5d77409eb6

See more details on using hashes here.

Provenance

The following attestation bundles were made for sbatchman-0.1.0-py3-none-any.whl:

Publisher: pypi-publish.yml on LorenzoPichetti/SbatchMan

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page