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

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 completety tested it properly.

pip3 install omniopt2

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

pip3 install -e git+https://github.com/NormanTUD/OmniOpt2.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 8995

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 8995
File Size Uploaded Provenance Actions
omniopt2-8995.tar.gz 187.9 kB Without provenance Details for omniopt2-8995.tar.gz

Built distribution (wheel)

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

Total release size: 607.4 kB

Release files / omniopt2-8995.tar.gz

Download URL omniopt2-8995.tar.gz
Size 187.9 kB
Tags Source
SHA-256 checksum
How to use checksums
55efa0596609709edbd0b7f54dc7ed113d5c2191821570f93dca2929f92fc49c
BLAKE2b-256 checksum
How to use checksums
99d912390062aa6d6685cc45e5d45e98d4677eccf9fd612654a7ed579ef8f31f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

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

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

Security for omniopt2 8995

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

8995 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