Skip to main content

Simple objective optimization orchestration for Slurm clusters

Project description

slurptuna – Run Optuna on Slurm (HPC hyperparameter optimization made simple)

Run Optuna hyperparameter optimization on Slurm clusters without writing sbatch scripts or managing distributed workers.

Running Optuna on a Slurm cluster (HPC) is not straightforward. slurptuna provides a simple way to run Optuna on Slurm with minimal setup.

In practice, running Optuna on Slurm clusters usually means:

  • writing and managing sbatch job arrays
  • coordinating distributed Optuna trials
  • aggregating results across workers

While Optuna supports distributed optimization, integrating it with Slurm typically requires custom orchestration.

slurptuna removes that overhead by handling job submission, parallel execution, and result aggregation automatically.

Install

pip install slurptuna

Or with uv:

uv add slurptuna

Usage

Here is a minimal example of running Optuna on Slurm using slurptuna:

(1) Write your loss function in a script

# my_model.py
from datetime import timedelta
from slurptuna import ExecutionMode, loss, optimize_run

@loss(
    name="my_model",
    description="Fit alpha/beta",
    parameter_space={"alpha": (0.0, 1.0), "beta": (0.0, 1.0)},
)
def my_model(params, seed):
    return abs(params["alpha"] - 0.3) + abs(params["beta"] - 0.7)

if __name__ == "__main__":
    result = optimize_run(
        my_model,
        mode=ExecutionMode.DISTRIBUTED,
        n_trials=20,
        n_seeds=400,
        chunk_size=20,
        worker_time_limit=timedelta(minutes=30),
    )
    print(result.best_params)
    # best params and best value are also written to runs/my_model_v0001/summary.json

Parameter space

Loss functions may accept either (params, seed) or (params, seed, context). Use context only when you need framework-provided metadata such as entry_id from optimize_entries.

Tuple shorthand is interpreted as (min, max):

parameter_space={"alpha": (0.0, 1.0)}

You can also use explicit specs when needed:

from slurptuna import search_param

parameter_space={
    "alpha": search_param(range=(0.0, 1.0)),
    "steps": search_param(range=(1, 10), dtype="int"),
    "mode": search_param(allowed=["fast", "slow"]),
}

(2) Submit your script as a long-running controller job on Slurm:

sbatch run_controller.sh my_model.py

run_controller.sh:

#!/bin/bash
#SBATCH --job-name=slurptuna-controller
#SBATCH --time=04:00:00
#SBATCH --cpus-per-task=1
#SBATCH --mem=4G

source .venv/bin/activate
python "$1"

The controller submits and monitors chunk/reduce array jobs automatically — you just wait for the result.

Docs

younesstrittmatter.github.io/slurptuna

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

slurptuna-0.0.4.tar.gz (69.1 kB view details)

Uploaded Source

Built Distribution

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

slurptuna-0.0.4-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file slurptuna-0.0.4.tar.gz.

File metadata

  • Download URL: slurptuna-0.0.4.tar.gz
  • Upload date:
  • Size: 69.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for slurptuna-0.0.4.tar.gz
Algorithm Hash digest
SHA256 82a3b96f022bc9fa78af5349fbc0f512c0bb3ea6378946964cdf85119d76a160
MD5 1a4b2840deb50e18c717c051fdbb74e2
BLAKE2b-256 849eb3884975386a1c918541c0f6fcf9340d2e5994c6e81e7fff059a7faaf47d

See more details on using hashes here.

Provenance

The following attestation bundles were made for slurptuna-0.0.4.tar.gz:

Publisher: publish.yml on younesStrittmatter/slurptuna

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

File details

Details for the file slurptuna-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: slurptuna-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for slurptuna-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9d94c94a754450df6f0790e1efb90664fc5976e0c99525749dd3c5b13bcb39b1
MD5 84ad35f50c1784a18287fc16820007ff
BLAKE2b-256 14dd499ed48adf1aca4505a502d97c6ffe2491f002e3e2634f7501f658144efc

See more details on using hashes here.

Provenance

The following attestation bundles were made for slurptuna-0.0.4-py3-none-any.whl:

Publisher: publish.yml on younesStrittmatter/slurptuna

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