Skip to main content

OmniOpt2 - Hyperparameter Optimizer for SLURM-based Systems

OmniOpt2 is a tool designed to assist researchers, engineers, and data scientists with hyperparameter optimization on SLURM-based clusters, even though it works without it as well. 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 OmniOpt2 GUI. For tutorials on configuration, exit codes, and debugging, visit OmniOpt2 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=$(echo 'echo "RESULT: %(param)"' | base64 -w0) \
    --parameter param range 0 1000 float

This command initiates OmniOpt2 and installs dependencies if not already installed. The parameter --run_program uses a Base64-encoded string to specify commands. It is recommended to use the GUI, though.

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:

omniopt_plot --run_dir runs/example/0
omniopt_plot --run_dir runs/example/0 --min 0 --max 100

Use Optuna directly

Every Optuna sampler (TPE, CMA-ES, GP, Random, Grid, NSGA-II, NSGA-III, MOTPE, ...) is reachable as a special case of OmniOpt through the omniopt_optuna entry point:

omniopt_optuna --max-eval=20 --parameter 'x range -10 10 int' \
    --run-program 'echo "RESULT: $x"'
omniopt_optuna --model=OPTUNA_NSGAII --max-eval=30 \
    --result-names RESULT1=min RESULT2=max \
    --parameter 'x range 0 5 float'

Under the hood this is just ./omniopt --model=OPTUNA_TPE ...; the entry point adds sensible defaults for every --optuna_* flag and forwards the rest verbatim. See the Optuna integration tutorial for the full surface (pruners, persistent storage, multi-objective, remote control via omniopt_optuna study ...).

Using live-share

Use --live_share (also enablable via GUI) to automatically share the job. You will get a URL where your job data is hosted publically for 30 days, meaning everyone can access your results, and you can see all kinds of visualizations and export them.

Run Tests (Developer Use Only)

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

./tests/main

See the automated tests tutorial page for more details.

Install from pypi

This may not use the bleeding-edge version, but if you get the version from here it means, the test suite has completely tested it properly.

pip3 install omniopt2

Install from repo (bleeding edge, may contain untested changes)

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

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

Error Codes

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

Autocompletions

Autocomplete files for zsh and bash are in .shells. Run

bash .shells/install

to install them.

Contributions

I'd be glad to see your contributions!

Issues

If you experience any problems, please write issues at my Github Issues page.

Old OmniOpt

The old OmniOpt version, based on HyperOpt, is not supported anymore. It is still available, though, at https://github.com/NormanTUD/LegacyOmniOpt.

Metadata

Release files for omniopt2 9831

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for omniopt2 9831
File Size Uploaded Provenance Actions
omniopt2-9831.tar.gz 238.5 kB Without provenance Details for omniopt2-9831.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for omniopt2 9831
File Interpreter ABI Platform Actions
omniopt2-9831-py3-none-any.whl Python 3 none any Details for omniopt2-9831-py3-none-any.whl

Total release size: 768.8 kB

Release files / omniopt2-9831.tar.gz

Download URL omniopt2-9831.tar.gz
Size 238.5 kB
Tags Source
SHA-256 checksum
How to use checksums
71df564334a431cc486483fa3a5222b385859a3fe61591ad933f2ec7663a3f4a
BLAKE2b-256 checksum
How to use checksums
41a5757652549b0b3f2d03ffff6285b9abc39c91e337abc4ad68733bc1bc1d6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / omniopt2-9831-py3-none-any.whl

Download URL omniopt2-9831-py3-none-any.whl
Size 530.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e4ea838a13563d8da39ad43cd0f04bdba35e3ddd7d6dccb54405ed7a24a73f99
BLAKE2b-256 checksum
How to use checksums
27885b9c2f70a04d6e582644bc49964b48ba950e02deab1c0604d0b8680e6b08
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for omniopt2 9831

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

9831 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page