Skip to main content

OmniOpt2 - Hyperparameter Optimizer for SLURM-based Systems

Current build status Open Issues Open Pull Requests License Bug Issues GitHub Repo stars Pull Requests Stars Forks Contributors Last Commit

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=ZWNobyAiUkVTVUxUOiAlKHBhcmFtKSI= \
    --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.

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 5156

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

Built distribution (wheel)

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

Total release size: 448.9 kB

Release files / omniopt2-5156.tar.gz

Download URL omniopt2-5156.tar.gz
Size 136.0 kB
Tags Source
SHA-256 checksum
How to use checksums
a5529b403ad94b813bc718958e67ef5604509b2f144eb76c904a8108c469a421
BLAKE2b-256 checksum
How to use checksums
6dead6557a02ac0b1e69d475fa0ed37ce4082a7810f85cd42228a702c4483896
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.21

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

Download URL omniopt2-5156-py3-none-any.whl
Size 313.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
67fe37e4762afe77ac016a7d6be6928605a05814cd528539f647cd1d35badfc7
BLAKE2b-256 checksum
How to use checksums
ee0b900e27ab252f677a750390c1f2e0e04b6ad52d6f8188f57d56ef75e41f26
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.21

Security for omniopt2 5156

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

5156 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