omniopt2 2024.11.4.post1

Automatic hyperparameter optimizer based on Ax/Botorch

OmniOpt - Hyperparameter Optimizer for SLURM-based Systems

OmniOpt is a tool designed to assist researchers, engineers, and data scientists with hyperparameter optimization on SLURM-based clusters. It simplifies large-scale optimization tasks with built-in fault tolerance and flexibility. A graphical user interface (GUI) is available for command creation, accessible at OmniOpt GUI. For tutorials on configuration, exit codes, and debugging, visit OmniOpt Tutorials.

Main program

./omniopt --partition=alpha --experiment_name=example --mem_gb=1 --time=60 \
    --worker_timeout=60 --max_eval=500 --num_parallel_jobs=500 --gpus=1 \
    --follow --run_program=ZWNobyAiUkVTVUxUOiAlKHBhcmFtKSI= \
    --parameter param range 0 1000 float

This command initiates OmniOpt and installs dependencies if not already installed. The parameter --run_program uses a Base64-encoded string to specify commands.

Plot Results

Generates visualizations, such as scatter and hex scatter plots. --min and --max adjust the plotted result value range.

Or, with --min and --max:

./plot --run_dir runs/example/0
./plot --run_dir runs/example/0 --min 0 --max 100

Run Tests (Developer Use Only)

The test suite simulates various scenarios, including handling faulty jobs and ensuring program resilience.

./tests/main_tests

Install from pypi

pip3 install omniopt2

Install from repo

pip3 install -e git+https://github.com/NormanTUD/OmniOpt2.git#egg=OmniOpt2

Alternatively, it can be executed directly, as OmniOpt will install its dependencies automatically if required.

Error Codes

For common issues and exit codes, see the exit codes tutorial.