TaskParameter¶
- class baybe.parameters.categorical.TaskParameter[source]¶
Bases:
CategoricalParameter
Parameter class for task parameters.
Public methods
__init__
(name, values[, active_values])Method generated by attrs for class TaskParameter.
from_dict
(dictionary)Create an object from its dictionary representation.
from_json
(string)Create an object from its JSON representation.
is_in_range
(item)Return whether an item is within the parameter range.
summary
()Return a custom summarization of the parameter.
to_dict
()Create an object's dictionary representation.
to_json
()Create an object's JSON representation.
Create a one-dimensional search space from the parameter.
Create a one-dimensional search space from the parameter.
transform
(series, /)Transform parameter values from experimental to computational representation.
Public attributes and properties
Return the computational representation of the parameter.
The columns spanning the computational representation.
Boolean indicating if this is a continuous parameter.
Boolean indicating if this is a discrete parameter.
Class variable encoding whether this parameter is numeric.
The values of the parameter.
An optional list of values describing for which tasks recommendations should be given.
An optional encoding for the parameter.
The name of the parameter
- __init__(name: str, values, active_values=NOTHING)¶
Method generated by attrs for class TaskParameter.
For details on the parameters, see Public attributes and properties.
- to_json()¶
Create an object’s JSON representation.
- Return type:
- Returns:
The JSON representation as a string.
- to_searchspace()¶
Create a one-dimensional search space from the parameter.
- Return type:
SearchSpace
- to_subspace()¶
Create a one-dimensional search space from the parameter.
- Return type:
SubspaceDiscrete
- transform(series: Series, /)¶
Transform parameter values from experimental to computational representation.
-
active_values:
tuple
¶ An optional list of values describing for which tasks recommendations should be given. By default, all parameters are considered active.
-
encoding:
CategoricalEncoding
¶ An optional encoding for the parameter.