CustomDiscreteParameter¶
- class baybe.parameters.custom.CustomDiscreteParameter[source]¶
Bases:
DiscreteParameter
Custom parameters.
For these parameters, the user can read in a precomputed representation for labels, e.g. from quantum chemistry.
Public methods
__init__
(name, data[, decorrelate])Method generated by attrs for class CustomDiscreteParameter.
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.
transform_rep_exp2comp
(data)Transform data from experimental to computational representation.
Public attributes and properties
Return the computational representation of the parameter.
Class variable encoding whether this parameter is numeric.
Returns the representing labels of the parameter.
A mapping that provides the encoding for all available parameter values.
Specifies the used decorrelation mode for the parameter encoding.
An optional encoding for the parameter.
The name of the parameter
- __init__(name: str, data: DataFrame, decorrelate: bool | float = True)¶
Method generated by attrs for class CustomDiscreteParameter.
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.
- transform_rep_exp2comp(data: Series)¶
Transform data from experimental to computational representation.
-
decorrelate:
Union
[bool
,float
]¶ Specifies the used decorrelation mode for the parameter encoding.
False
: The encoding is used as is.True
: The encoding is decorrelated using a default correlation threshold.float in (0, 1): The encoding is decorrelated using the specified threshold.
-
encoding:
CustomEncoding
¶ An optional encoding for the parameter.