Skip to main content

OmniOpt2 - Hyperparameter Optimizer for SLURM-based Systems

Current build status

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

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 latest version.

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 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!

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 5955

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

Built distribution (wheel)

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

Total release size: 471.7 kB

Release files / omniopt2-5955.tar.gz

Download URL omniopt2-5955.tar.gz
Size 143.1 kB
Tags Source
SHA-256 checksum
How to use checksums
7138610e028ca4c9f7b0286c469e2c2be3d1e103eae0718f26bfcf86a4a8a494
BLAKE2b-256 checksum
How to use checksums
bd1460fa83441828d0057bc6552ef6d83232216341b9436cfeb354eae9048d31
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.22

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

Download URL omniopt2-5955-py3-none-any.whl
Size 328.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ae8118ba9957c7d1c1cd72fe931443ef73e99401634afd53f2eed729714d02eb
BLAKE2b-256 checksum
How to use checksums
373d10b6fe73a9b6cc734ccba2bbcf15a35872fb2319338e417b8fd8c1700cfe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.22

Security for omniopt2 5955

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

5955 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