syne_tune.optimizer.schedulers.synchronous.dehb module
- class syne_tune.optimizer.schedulers.synchronous.dehb.TrialInformation(encoded_config, level, metric_val=None)[source]
Bases:
object
Information the scheduler maintains per trial.
-
encoded_config:
ndarray
-
level:
int
-
metric_val:
Optional
[float
] = None
-
encoded_config:
- class syne_tune.optimizer.schedulers.synchronous.dehb.ExtendedSlotInRung(bracket_id, slot_in_rung)[source]
Bases:
object
Extends
SlotInRung
mostly for convenience
- class syne_tune.optimizer.schedulers.synchronous.dehb.DifferentialEvolutionHyperbandScheduler(config_space, rungs_first_bracket, num_brackets_per_iteration=None, **kwargs)[source]
Bases:
SynchronousHyperbandCommon
Differential Evolution Hyperband, as proposed in
DEHB: Evolutionary Hyperband for Scalable, Robust and Efficient Hyperparameter OptimizationNoor Awad, Neeratyoy Mallik, Frank HutterIJCAI 30 (2021), pages 2147-2153We implement DEHB as a variant of synchronous Hyperband, which may differ slightly from the implementation of the authors. Main differences to synchronous Hyperband:
In DEHB, trials are not paused and potentially promoted (except in the very first bracket). Therefore, checkpointing is not used (except in the very first bracket, if
support_pause_resume
isTrue
)Only the initial configurations are drawn at random (or drawn from the searcher). Whenever possible, new configurations (in their internal encoding) are derived from earlier ones by way of differential evolution
- Parameters:
config_space (
Dict
[str
,Any
]) – Configuration space for trial evaluation functionrungs_first_bracket (
List
[Tuple
[int
,int
]]) – Determines rung level systems for each bracket, seeDifferentialEvolutionHyperbandBracketManager
num_brackets_per_iteration (
Optional
[int
]) – Number of brackets per iteration. The algorithm cycles through these brackets in one iteration. If not given, the maximum number is used (i.e.,len(rungs_first_bracket)
)metric (str) – Name of metric to optimize, key in result’s obtained via
on_trial_result()
searcher (str, optional) – Searcher for
get_config
decisions. Passed tosearcher_factory()
along withsearch_options
and extra information. Supported values:SUPPORTED_SEARCHERS_HYPERBAND
. Ifsearcher == "random_encoded"
(default), the encoded configs are sampled directly, each entry independently from U([0, 1]). This distribution has higher entropy than for “random” if there are discrete hyperparameters inconfig_space
. Note thatpoints_to_evaluate
is still used in this case.search_options (Dict[str, Any], optional) – Passed to
searcher_factory()
. Note: Ifsearch_options["allow_duplicates"] == True
, thensuggest()
may return a configuration more than oncemode (str, optional) – Mode to use for the metric given, can be “min” (default) or “max”
points_to_evaluate (
List[dict]
, optional) – List of configurations to be evaluated initially (in that order). Each config in the list can be partially specified, or even be an empty dict. For each hyperparameter not specified, the default value is determined using a midpoint heuristic. If None (default), this is mapped to[dict()]
, a single default config determined by the midpoint heuristic. If[]
(empty list), no initial configurations are specified.random_seed (int, optional) – Master random seed. Generators used in the scheduler or searcher are seeded using
RandomSeedGenerator
. If not given, the master random seed is drawn at random here.max_resource_attr (str, optional) – Key name in config for fixed attribute containing the maximum resource. If given, trials need not be stopped, which can run more efficiently.
max_resource_level (int, optional) – Largest rung level, corresponds to
max_t
inFIFOScheduler
. Must be positive int larger thangrace_period
. If this is not given, it is inferred like inFIFOScheduler
. In particular, it is not needed ifmax_resource_attr
is given.resource_attr (str, optional) – Name of resource attribute in results obtained via
on_trial_result()
. The type of resource must be int. Default to “epoch”mutation_factor (float, optional) – In \((0, 1]\). Factor \(F\) used in the rand/1 mutation operation of DE. Default to 0.5
crossover_probability (float, optional) – In \((0, 1)\). Probability \(p\) used in crossover operation (child entries are chosen with probability \(p\)). Defaults to 0.5
support_pause_resume (bool, optional) – If
True
,_suggest()
supports pause and resume in the first bracket (this is the default). If the objective supports checkpointing, this is made use of. Defaults toTrue
. Note: The resumed trial still gets assigned a newtrial_id
, but it starts from the earlier checkpoint.searcher_data (str, optional) –
Relevant only if a model-based searcher is used. Example: For NN tuning and
resource_attr == "epoch"
, we receive a result for each epoch, but not all epoch values are also rung levels. searcher_data determines which of these results are passed to the searcher. As a rule, the more data the searcher receives, the better its fit, but also the more expensive get_config may become. Choices:”rungs” (default): Only results at rung levels. Cheapest
”all”: All results. Most expensive
Note: For a Gaussian additive learning curve surrogate model, this has to be set to “all”.
- MAX_RETRIES = 50
- property rung_levels: List[int]
- Returns:
Rung levels (positive int; increasing), may or may not include
max_resource_level
- property num_brackets: int
- Returns:
Number of brackets (i.e., rung level systems). If the scheduler does not use brackets, it has to return 1
- on_trial_result(trial, result)[source]
Called on each intermediate result reported by a trial.
At this point, the trial scheduler can make a decision by returning one of
SchedulerDecision.CONTINUE
,SchedulerDecision.PAUSE
, orSchedulerDecision.STOP
. This will only be called when the trial is currently running.- Parameters:
trial (
Trial
) – Trial for which results are reportedresult (
Dict
[str
,Any
]) – Result dictionary
- Return type:
str
- Returns:
Decision what to do with the trial
- on_trial_error(trial)[source]
Given the
trial
is currently pending, we send a result at its milestone for metric value NaN. Such trials are ranked after all others and will most likely not be promoted.