Hyperparameter tuning¶
Optuna-based tuning and the gin helpers that turn hyperparameter bindings into a search space. See Hyperparameter tuning.
icu_benchmarks.tuning.hyperparameters
¶
Functions:
| Name | Description |
|---|---|
choose_and_bind_hyperparameters_scikit_optimize |
Choose hyperparameters to tune and bind them to gin. |
choose_and_bind_hyperparameters_optuna |
Choose hyperparameters to tune and bind them to gin. Uses Optuna for hyperparameter optimization. |
make_sampler |
Instantiates the sampler class; the GP sampler explores n_initial_points random trials first. |
suggest_hyperparameter |
Samples one hyperparameter from its gin bound. |
find_checkpoint |
Find the latest checkpoint in the log directory. |
choose_and_bind_hyperparameters_scikit_optimize
¶
choose_and_bind_hyperparameters_scikit_optimize(do_tune: bool, data_dir: Path, log_dir: Path, seed: int, run_mode: RunMode = classification, checkpoint: str = None, scopes: list[str] = [], n_initial_points: int = 3, n_calls: int = 20, folds_to_tune_on: int = None, checkpoint_file: str = 'hyperparameter_tuning_logs.json', generate_cache: bool = False, load_cache: bool = False, debug: bool = False, verbose: bool = False, wandb: bool = False)
Choose hyperparameters to tune and bind them to gin.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
wandb
|
bool
|
Whether we use wandb or not. |
False
|
load_cache
|
bool
|
Load cached data if available. |
False
|
generate_cache
|
bool
|
Generate cache data. |
False
|
do_tune
|
bool
|
Whether to tune hyperparameters or not. |
required |
data_dir
|
Path
|
Path to the data directory. |
required |
log_dir
|
Path
|
Path to the log directory. |
required |
seed
|
int
|
Random seed. |
required |
run_mode
|
RunMode
|
The run mode of the experiment. |
classification
|
checkpoint
|
str
|
Name of the checkpoint run to load previously explored hyperparameters from. |
None
|
scopes
|
list[str]
|
List of gin scopes to search for hyperparameters to tune. |
[]
|
n_initial_points
|
int
|
Number of initial points to explore. |
3
|
n_calls
|
int
|
Number of iterations to optimize the hyperparameters. |
20
|
folds_to_tune_on
|
int
|
Number of folds to tune on. |
None
|
checkpoint_file
|
str
|
Name of the checkpoint file. |
'hyperparameter_tuning_logs.json'
|
debug
|
bool
|
Whether to load less data. |
False
|
verbose
|
bool
|
Set to true to increase log output. |
False
|
Raises:
| Type | Description |
|---|---|
ValueError
|
If checkpoint is not None and the checkpoint does not exist. |
Source code in icu_benchmarks/tuning/hyperparameters.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 | |
choose_and_bind_hyperparameters_optuna
¶
choose_and_bind_hyperparameters_optuna(do_tune: bool, data_dir: Path, log_dir: Path, seed: int, run_mode: RunMode = classification, checkpoint: str = None, scopes: list[str] = [], n_initial_points: int = 3, n_calls: int = 20, sampler=GPSampler, folds_to_tune_on: int = None, checkpoint_file: str = 'hyperparameter_tuning_logs.db', generate_cache: bool = False, load_cache: bool = False, debug: bool = False, verbose: bool = False, wandb: bool = False, plot: bool = True)
Choose hyperparameters to tune and bind them to gin. Uses Optuna for hyperparameter optimization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plot
|
bool
|
Whether to plot hyperparameter importances. |
True
|
sampler
|
The sampler to use for hyperparameter optimization. |
GPSampler
|
|
wandb
|
bool
|
Whether we use wandb or not. |
False
|
load_cache
|
bool
|
Load cached data if available. |
False
|
generate_cache
|
bool
|
Generate cache data. |
False
|
do_tune
|
bool
|
Whether to tune hyperparameters or not. |
required |
data_dir
|
Path
|
Path to the data directory. |
required |
log_dir
|
Path
|
Path to the log directory. |
required |
seed
|
int
|
Random seed. |
required |
run_mode
|
RunMode
|
The run mode of the experiment. |
classification
|
checkpoint
|
str
|
Name of the checkpoint run to load previously explored hyperparameters from. |
None
|
scopes
|
list[str]
|
List of gin scopes to search for hyperparameters to tune. |
[]
|
n_initial_points
|
int
|
Number of initial points to explore. |
3
|
n_calls
|
int
|
Number of iterations to optimize the hyperparameters. |
20
|
folds_to_tune_on
|
int
|
Number of folds to tune on. |
None
|
checkpoint_file
|
str
|
Name of the checkpoint file. |
'hyperparameter_tuning_logs.db'
|
debug
|
bool
|
Whether to load less data. |
False
|
verbose
|
bool
|
Set to true to increase log output. |
False
|
Raises:
| Type | Description |
|---|---|
ValueError
|
If tuning is disabled and the checkpoint does not exist. With tuning, a new study is started instead. |
Source code in icu_benchmarks/tuning/hyperparameters.py
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 | |
make_sampler
¶
Instantiates the sampler class; the GP sampler explores n_initial_points random trials first.
Source code in icu_benchmarks/tuning/hyperparameters.py
suggest_hyperparameter
¶
suggest_hyperparameter(trial: Trial, name: str, value)
Samples one hyperparameter from its gin bound.
Tuples of numbers are ranges: (low, high), optionally followed by a prior ("log" or "log-uniform") and a log base, which is ignored because the base does not change a log-uniform distribution. Anything else is a list of choices.
Source code in icu_benchmarks/tuning/hyperparameters.py
find_checkpoint
¶
Find the latest checkpoint in the log directory.
Source code in icu_benchmarks/tuning/hyperparameters.py
icu_benchmarks.tuning.gin_utils
¶
Functions:
| Name | Description |
|---|---|
get_gin_hyperparameters |
Get hyperparameters to tune from gin config. |
bind_gin_params |
Binds hyperparameter dict to gin config and logs them. |
get_gin_hyperparameters
¶
Get hyperparameters to tune from gin config.
Hyperparameters that are already present in the gin config are ignored. Hyperparameters that are not a list or tuple are bound directly to the class. Hyperparameters that are a list or tuple are returned to be tuned.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
class_to_tune
|
str
|
Name of the class to tune hyperparameters for. |
REQUIRED
|
**hyperparams
|
dict
|
Dictionary of hyperparameters to potentially tune. |
{}
|
Returns:
| Type | Description |
|---|---|
dict
|
Dictionary of hyperparameters to tune. |
Source code in icu_benchmarks/tuning/gin_utils.py
bind_gin_params
¶
Binds hyperparameter dict to gin config and logs them.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
hyperparams
|
dict[str, any]
|
Dictionary of hyperparameters. |
required |