The values a tuner may choose among for one hyperparameter

Built by tune_over() and stored in the hyperparameter it is assigned to, so that a search space is a distinct type rather than a vector that has to be told apart from a value by counting.

Usage

HyperparameterCandidates(candidates = list(), from_vector = FALSE)

Arguments

candidates

List: The values to search over, one per element.

from_vector

Logical: TRUE when the candidates were read out of a single bare vector. A vector is also how one value of a vector-valued hyperparameter is written, so that one combination cannot be inferred; this records it so the hyperparameter can reject it with a correction rather than silently take each element as a candidate.

Value

HyperparameterCandidates object.

Author

EDG

Examples

# Built by tune_over(), not directly.
d <- tune_over(3L, 4L, 5L)
d@candidates
#> [[1]]
#> [1] 3
#> 
#> [[2]]
#> [1] 4
#> 
#> [[3]]
#> [1] 5
#>