๐ฆ Preparations, Basics and Setup
- ๐๏ธ OmniOpt2 Architecture Overview — What is the Architecture of OmniOpt2?
- ๐ณ Basics and Docker — How to use OmniOpt locally, on HPC-Systems or in Docker
- ๐ Continue jobs — How to continue jobs after they have been run already
- ๐ Available Parameters (--help) — The --help of the main script of OmniOpt2
- ๐ฅ๏ธ Available partitions — List of partitions and Memory, GPUs and so on on the HPC-Systems of TU-Dresden
- ๐ results.csv — What is the results.csv and what do it's columns mean?
- ๐ Create run.sh-file & modify your program — This is needed to prepare your program for OmniOpt2
- ๐งโ๐ป VirtualEnv — What are Virtual Environments and how OmniOpt2 uses them
โ๏ธ Advanced Usage
- โ๏ธ Constraints — What are Constraints and how to use them?
- ๐งฉ Custom Generation Strategy — How to run custom generation strategies
- ๐ฟ Environment Variables — List of all environment variables that change how OmniOpt2 works
- ๐งพ Exit-Codes and Bash-scripting — How to script OmniOpt2
- ๐ config.{json,yaml,toml} — How to load parameters from OmniOpt2-config-files
- ๐ผ Orchestrator — How to orchestrate how failing jobs should restart or be treated in general
- โจ๏ธ Shell-Extensions (bash, zsh) — Extensions for tab-completion for ZSH and Bash-Shells
๐งช Developing
- ๐ Debugging — How to find and solve bugs
- ๐ Folder structure of OmniOpt2 runs — What files are created for each run?
- โ Run automated tests — How to run automated tests and what options are available
๐ค Models
- โป๏ธ Using external generators — How to use your own programs to generate new points and include them easily in OmniOpt2
- ๐งฌ Surrogate Models — What are Surrogate Models and when to use which one?
- ๐ฒ Random Forest — What are random forests and how do they work?
- ๐ณ Tree-structured Parzen Estimator (TPE) — What is TPE and how does it work?
๐ฏ Multiple Objectives
- ๐งญ What is Multi-Objective-Optimization? — How to use OmniOpt2 with Multi-Objective-Optimization (MOO)?
- ๐ What is optimization with combined criteria? — How to use OmniOpt2 with multiple results (OCC)
๐ Plotting and Sharing Results
- ๐ OmniOpt2-Share — What is OmniOpt2-Share and how to use it?
- ๐Plot your results — What kinds of plots are available and how to use them