DiscreteParameter

class baybe.parameters.base.DiscreteParameter

Bases: Parameter, ABC

Abstract class for discrete parameters.

Public methods

__init__(name)	Method generated by attrs for class DiscreteParameter.
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

comp_df	Return the computational representation of the parameter.
values	The values the parameter can take.
encoding	An optional encoding for the parameter.
is_numeric	Class variable encoding whether this parameter is numeric.
name	The name of the parameter

__init__(name: str)

Method generated by attrs for class DiscreteParameter.

For details on the parameters, see Public attributes and properties.

classmethod from_dict(dictionary: dict)

Create an object from its dictionary representation.

Parameters:

dictionary (dict) – The dictionary representation.

Return type:

TypeVar(_T)

Returns:

The reconstructed object.

classmethod from_json(string: str)

Create an object from its JSON representation.

Parameters:

string (str) – The JSON representation of the object.

Return type:

TypeVar(_T)

Returns:

The reconstructed object.

is_in_range(item: Any)

Return whether an item is within the parameter range.

Parameters:

item (Any) – The item to be checked.

Return type:

bool

Returns:

True if the item is within the parameter range, False otherwise.

summary()

Return a custom summarization of the parameter.

Return type:

dict

to_dict()

Create an object’s dictionary representation.

Return type:

dict

to_json()

Create an object’s JSON representation.

Return type:

str

Returns:

The JSON representation as a string.

transform_rep_exp2comp(data: Series)

Transform data from experimental to computational representation.

Parameters:

data (Series) – Data to be transformed.

Return type:

DataFrame

Returns:

The transformed version of the data.

property comp_df: DataFrame

Return the computational representation of the parameter.

encoding: Optional[ParameterEncoding]

An optional encoding for the parameter.

is_numeric: ClassVar[bool]

Class variable encoding whether this parameter is numeric.

name: str

The name of the parameter

abstract property values: tuple

The values the parameter can take.