OmniOpt2-Logo ScaDS.ai-Logo
CI Badge PyPI Version

Available Parameters (--help)

An overview table of all arguments that OmniOpt2 accepts via the Command line. Same data as in ./omniopt --help.

Parameter Description Default Value
Ungrouped 
--config_yaml
 YAML configuration file 
-
 
--config_toml
 TOML configuration file 
-
 
--config_json
 JSON configuration file 
-
Required arguments - These options have to be set 
--num_random_steps
 Number of random steps to start with 
20
 
--max_eval
 Maximum number of evaluations 
-
 
--run_program
 A program that should be run. Use, for example, $x for the parameter named x. 
-
 
--experiment_name
 Name of the experiment. 
-
 
--mem_gb
 Amount of RAM for each worker in GB (default: 1GB) 
1
Required arguments that allow a choice - Of these arguments, one has to be set to continue. 
--parameter
 Experiment parameters in the formats (options in round brackets are optional): <NAME> range <LOWER BOUND> <UPPER BOUND> (<INT, FLOAT>, log_scale: True/False, default: false>) -- OR -- <NAME> fixed <VALUE> -- OR -- <NAME> choice <Comma-separated list of values> 
None
 
--continue_previous_job
 Continue from a previous checkpoint, use run-dir as argument 
None
Optional - These options are optional 
--experiment_constraints
 Constraints for parameters. Example: x + y <= 2.0 
-
 
--run_dir
 Directory, in which runs should be saved. Default: runs 
runs
 
--seed
 Seed for random number generator 
-
 
--decimalrounding
 Number of decimal places for rounding 
4
 
--enforce_sequential_optimization
 Enforce sequential optimization (default: false) 
-
 
--verbose_tqdm
 Show verbose tqdm messages 
-
 
--model
 No description available. 
-
 
--gridsearch
 Enable gridsearch. 
-
 
--occ
 Use optimization with combined criteria (OCC) 
-
 
--show_sixel_scatter
 Show sixel graphics of scatter plots in the end 
-
 
--show_sixel_general
 Show sixel graphics of general plots in the end 
-
 
--show_sixel_trial_index_result
 Show sixel graphics of scatter plots in the end 
-
 
--follow
 Automatically follow log file of sbatch 
-
 
--send_anonymized_usage_stats
 Send anonymized usage stats 
-
 
--ui_url
 Site from which the OO-run was called 
None
 
--root_venv_dir
 No description available. 
-
 
--exclude
 A comma separated list of values of excluded nodes (taurusi8009,taurusi8010) 
None
 
--main_process_gb
 Amount of RAM for the main process in GB (default: 8GB) 
8
 
--pareto_front_confidence
 Confidence for pareto-front-plotting (between 0 and 1, default: 1) 
1
 
--max_nr_of_zero_results
 Max. nr of successive zero results by the generator before the search space is seen as exhausted 
10
 
--abbreviate_job_names
 Abbreviate pending job names (r = running, p = pending, u = unknown, c = cancelling) 
-
 
--orchestrator_file
 An orchestrator file 
None
 
--checkout_to_latest_tested_version
 Automatically checkout to latest version that was tested in the CI pipeline 
-
 
--live_share
 Automatically live-share the current optimization run automatically 
-
 
--disable_tqdm
 Disables the TQDM progress bar 
-
 
--workdir
 Work dir 
-
 
--occ_type
 No description available. 
-
 
--result_names
 Name of hyperparameters. Example --result_names result1=max result2=min result3. Default: RESULT=min. Default is min. 
-
 
--minkowski_p
 Minkowski order of distance (default: 2), needs to be larger than 0 
2
 
--signed_weighted_euclidean_weights
 A comma-seperated list of values for the signed weighted euclidean distance. Needs to be equal to the number of results. Else, default will be 1. 
--generation_strategy
 A string containing the generation_strategy 
None
 
--generate_all_jobs_at_once
 Generate all jobs at once rather than to create them and start them as soon as possible 
-
 
--revert_to_random_when_seemingly_exhausted
 Generate random steps instead of systematic steps when the search space is (seemingly) exhausted 
-
 
--load_data_from_existing_jobs
 List of job data to load from existing jobs 
-
 
--n_estimators_randomforest
 The number of trees in the forest for RANDOMFOREST (default: 100) 
100
 
--external_generator
 Programm call for an external generato4 
None
 
--username
 A username for live share 
None
 
--max_failed_jobs
 Maximum number of failed jobs before the search is cancelled. Is defaulted to the value of --max_eval 
None
SLURM - Parameters related to SLURM 
--num_parallel_jobs
 Number of parallel slurm jobs (default: 20) 
20
 
--worker_timeout
 Timeout for slurm jobs (i.e. for each single point to be optimized) 
30
 
--slurm_use_srun
 Using srun instead of sbatch 
-
 
--time
 Time for the main job 
--partition
 Partition to be run on 
--reservation
 Reservation 
None
 
--force_local_execution
 Forces local execution even when SLURM is available 
-
 
--slurm_signal_delay_s
 When the workers end, they get a signal so your program can react to it. Default is 0, but set it to any number of seconds you wish your program to be able to react to USR1. 
0
 
--nodes_per_job
 Number of nodes per job due to the new alpha restriction 
1
 
--cpus_per_task
 CPUs per task 
1
 
--account
 Account to be used 
None
 
--gpus
 Number of GPUs 
0
Installing - Parameters related to installing 
--run_mode
 Either local or docker 
local
Debug - These options are mainly useful for debugging 
--verbose
 Verbose logging 
-
 
--verbose_break_run_search_table
 Verbose logging for break_run_search 
-
 
--debug
 Enable debugging 
-
 
--no_sleep
 Disables sleeping for fast job generation (not to be used on HPC) 
-
 
--tests
 Run simple internal tests 
-
 
--show_worker_percentage_table_at_end
 Show a table of percentage of usage of max worker over time 
-
 
--auto_exclude_defective_hosts
 Run a Test if you can allocate a GPU on each node and if not, exclude it since the GPU driver seems to be broken somehow. 
-
 
--run_tests_that_fail_on_taurus
 Run tests on Taurus that usually fail. 
-
 
--raise_in_eval
 Raise a signal in eval (only useful for debugging and testing). 
-
 
--show_ram_every_n_seconds
 Raise a signal in eval (only useful for debugging and testing). 
-