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 completely 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.
1 maintainer
Metadata
1 maintainer
Release files for omniopt2 9132
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| omniopt2-9132.tar.gz | 189.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| omniopt2-9132-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 610.9 kB
Release files / omniopt2-9132.tar.gz
| Download URL | omniopt2-9132.tar.gz |
|---|---|
| Size | 189.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5087104a0d444259f4eb58705966ff12e7c9d7aaed17be7414401f4ad2d06e0f
|
|
BLAKE2b-256 checksum How to use checksums |
778ba22fac168b8c51394184d7124c0a6ee210158ff52eea37b5c7eee9d369c7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / omniopt2-9132-py3-none-any.whl
| Download URL | omniopt2-9132-py3-none-any.whl |
|---|---|
| Size | 421.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
22dc2c78b78a14298b7e5dcd14eb95a98f750e3cb7b00181d38e1d59a2e5cb09
|
|
BLAKE2b-256 checksum How to use checksums |
d5b54a116dfccc1619c70e6e94959847c668ba6d94b0eef17a8951b0afe6ea41
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
