HPO configuration-space API
The public wrapper HPO methods normally construct these
ConfigSpace objects. get_config_space selects a method-specific space from
the wrapper; get_base_config defines shared training parameters. Individual
builders support inspecting or composing method spaces.
Search ranges are narrower than some constructor ranges. Defaults must fit the selected space, and scheduling parameters depend on the full epoch budget. These helpers define search spaces; they do not run trials or restore weights.
Construct method-specific hyperparameter spaces for automated configuration.
Shared schedule, optimiser and regularisation choices are combined with method-specific parameters. Wrappers use these spaces for scalar or multi-objective searches over performance and verifiability.
build_cc_ibp_config_space(epochs, eps, include_base_config=True, defaults=dict())
Construct the CC-IBP hyperparameter space with optional default-value overrides.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
epochs
|
int
|
Total epoch budget used to construct the configuration space. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
include_base_config
|
bool
|
Whether to include shared schedule and optimiser hyperparameters. |
True
|
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
dict()
|
Source code in CTRAIN/model_wrappers/configs.py
299 300 301 302 303 304 305 306 307 308 309 | |
build_crown_ibp_config_space(epochs, eps, include_base_config=True, defaults=dict())
Construct the CROWN-IBP hyperparameter space with optional default-value overrides.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
epochs
|
int
|
Total epoch budget used to construct the configuration space. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
include_base_config
|
bool
|
Whether to include shared schedule and optimiser hyperparameters. |
True
|
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
dict()
|
Source code in CTRAIN/model_wrappers/configs.py
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 | |
build_exp_ibp_config_space(epochs, eps, include_base_config=True, defaults=dict())
Construct the Exp-IBP hyperparameter space with optional default-value overrides.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
epochs
|
int
|
Total epoch budget used to construct the configuration space. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
include_base_config
|
bool
|
Whether to include shared schedule and optimiser hyperparameters. |
True
|
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
dict()
|
Source code in CTRAIN/model_wrappers/configs.py
312 313 314 315 316 317 318 319 320 321 322 | |
build_expressive_ibp_config_space(epochs, eps, include_base_config=True, defaults=dict(), *, method)
Construct shared attack controls and the method-specific expressive-loss mixture weight.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
epochs
|
int
|
Total epoch budget used to construct the configuration space. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
include_base_config
|
bool
|
Whether to include shared schedule and optimiser hyperparameters. |
True
|
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
dict()
|
method
|
str
|
Training-method name used to namespace the expressive-loss parameters. |
required |
Source code in CTRAIN/model_wrappers/configs.py
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 | |
build_ibp_r_config_space(epochs, eps, include_base_config=True, defaults=None)
Construct the IBP-R hyperparameter space with optional default-value overrides.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
epochs
|
int
|
Total epoch budget used to construct the configuration space. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
include_base_config
|
bool
|
Whether to include shared schedule and optimiser hyperparameters. |
True
|
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
None
|
Source code in CTRAIN/model_wrappers/configs.py
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 | |
build_mtl_ibp_config_space(epochs, eps, include_base_config=True, defaults=dict(), method='mtl_ibp')
Construct the MTL-IBP hyperparameter space with optional default-value overrides.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
epochs
|
int
|
Total epoch budget used to construct the configuration space. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
include_base_config
|
bool
|
Whether to include shared schedule and optimiser hyperparameters. |
True
|
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
dict()
|
method
|
str
|
Training-method name used to namespace the expressive-loss parameters. |
'mtl_ibp'
|
Source code in CTRAIN/model_wrappers/configs.py
285 286 287 288 289 290 291 292 293 294 295 296 | |
build_sabr_config_space(epochs, eps, include_base_config=True, defaults=dict())
Construct the SABR hyperparameter space with optional default-value overrides.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
epochs
|
int
|
Total epoch budget used to construct the configuration space. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
include_base_config
|
bool
|
Whether to include shared schedule and optimiser hyperparameters. |
True
|
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
dict()
|
Source code in CTRAIN/model_wrappers/configs.py
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 | |
build_set_based_config_space(epochs, eps, defaults=None)
Construct the set-based training hyperparameter space with optional default-value overrides.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
epochs
|
int
|
Total epoch budget used to construct the configuration space. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
None
|
Source code in CTRAIN/model_wrappers/configs.py
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 | |
build_shi_config_space(epochs, eps, include_base_config=True, defaults=dict())
Construct the Shi-IBP hyperparameter space with optional default-value overrides.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
epochs
|
int
|
Total epoch budget used to construct the configuration space. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
include_base_config
|
bool
|
Whether to include shared schedule and optimiser hyperparameters. |
True
|
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
dict()
|
Source code in CTRAIN/model_wrappers/configs.py
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 | |
build_staps_config_space(epochs, eps, include_base_config=True, defaults=dict())
Construct the STAPS hyperparameter space with optional default-value overrides.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
epochs
|
int
|
Total epoch budget used to construct the configuration space. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
include_base_config
|
bool
|
Whether to include shared schedule and optimiser hyperparameters. |
True
|
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
dict()
|
Source code in CTRAIN/model_wrappers/configs.py
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 | |
build_taps_config_space(epochs, eps, include_base_config=True, defaults=dict())
Construct the TAPS hyperparameter space with optional default-value overrides.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
epochs
|
int
|
Total epoch budget used to construct the configuration space. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
include_base_config
|
bool
|
Whether to include shared schedule and optimiser hyperparameters. |
True
|
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
dict()
|
Source code in CTRAIN/model_wrappers/configs.py
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 | |
get_base_config(epochs, eps, defaults=dict(), train_eps_factor_bounds=(1, 2), optimizer_choices=('adam', 'adamw', 'radam'))
Construct shared schedule, optimiser and regularisation hyperparameters.
Warm-up and ramp-up ranges adapt to the available epoch budget. The eps argument is retained for compatibility with method-specific builders.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
epochs
|
int
|
Total epoch budget used to construct the configuration space. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
dict()
|
train_eps_factor_bounds
|
tuple
|
Allowed range for scaling the training perturbation radius. |
(1, 2)
|
optimizer_choices
|
Sequence[str]
|
Optimiser names offered in the shared search space. |
('adam', 'adamw', 'radam')
|
Source code in CTRAIN/model_wrappers/configs.py
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 | |
get_combined_config_space(epoch, eps, defaults=dict(), included_methods=['shi', 'crown_ibp', 'sabr', 'mtl_ibp', 'taps', 'staps'])
Construct a conditional search space that also selects the training method.
The included_methods selector activates the corresponding method-specific parameters alongside shared schedule, optimiser and regularisation choices.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
epoch
|
int
|
Current epoch index or completed epoch count used by the calling training loop. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
dict()
|
included_methods
|
list
|
Training-method names available to the conditional search. |
['shi', 'crown_ibp', 'sabr', 'mtl_ibp', 'taps', 'staps']
|
Source code in CTRAIN/model_wrappers/configs.py
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 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 | |
get_config_space(model_wrapper, epochs, eps, defaults=dict())
Construct the configuration space for the wrapper's selected training method.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model_wrapper
|
CTRAINWrapper
|
Wrapper whose training method selects the configuration space. |
required |
epochs
|
int
|
Total epoch budget used to construct the configuration space. |
required |
eps
|
float or Tensor
|
Target perturbation radius in raw input units, before loader normalisation. |
required |
defaults
|
dict
|
Overrides for the default values of the search-space hyperparameters. |
dict()
|
Source code in CTRAIN/model_wrappers/configs.py
14 15 16 17 18 19 20 21 22 23 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 | |