NumericalContinuousParameter

class baybe.parameters.numerical.NumericalContinuousParameter

Bases: ContinuousParameter

Class for continuous numerical parameters.

Public methods

__init__(name[, bounds, metadata])	Method generated by attrs for class NumericalContinuousParameter.
from_dict(dictionary)	Create an object from its dictionary representation.
from_json(source, /)	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([sink, overwrite])	Create an object's JSON representation.
to_searchspace()	Create a one-dimensional search space from the parameter.
to_subspace()	Create a one-dimensional search space from the parameter.

Public attributes and properties

comp_rep_columns	The columns spanning the computational representation.
description	The description of the parameter.
is_continuous	Boolean indicating if this is a continuous parameter.
is_discrete	Boolean indicating if this is a discrete parameter.
is_numerical	Class variable encoding whether this parameter is numeric.
unit	The unit of measurement for the parameter.
bounds	The bounds of the parameter.
name	The name of the parameter
metadata	Optional metadata containing description, unit, and other information.

__init__(name: str, bounds=None, *, metadata=NOTHING)

Method generated by attrs for class NumericalContinuousParameter.

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, bound= SerialMixin)

Returns:

The reconstructed object.

classmethod from_json(source: str | Path | SupportsRead[str], /)

Create an object from its JSON representation.

Parameters:

source (str | Path | SupportsRead[str]) –

The JSON source. Can be:

• A string containing JSON content.

• A file path or Path object pointing to a JSON file.

• A file-like object with a read() method.

Raises:

ValueError – If source is not one of the allowed types.

Return type:

_T

Returns:

The reconstructed object.

is_in_range(item: float)

Return whether an item is within the parameter range.

Parameters:

item (float) – 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

Returns:

The dictionary representation of the object.

to_json(sink: str | Path | SupportsWrite[str] | None = None, /, *, overwrite: bool = False, **kwargs: Any)

Create an object’s JSON representation.

Parameters:

• sink (str | Path | SupportsWrite[str] | None) –

  The JSON sink. Can be:

  • None (only returns the JSON string).

  • A file path or Path object pointing to a location where to write the JSON content.

  • A file-like object with a write() method.

• overwrite (bool) – Boolean flag indicating if to overwrite the file if it already exists. Only relevant if sink is a file path or Path object.

• **kwargs (Any) – Additional keyword arguments to pass to json.dumps().

Raises:

FileExistsError – If sink points to an already existing file but overwrite is False.

Return type:

str

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:

SubspaceContinuous

bounds: Interval

The bounds of the parameter.

property comp_rep_columns: tuple[str]

The columns spanning the computational representation.

property description: str | None

The description of the parameter.

property is_continuous: bool

Boolean indicating if this is a continuous parameter.

property is_discrete: bool

Boolean indicating if this is a discrete parameter.

is_numerical: ClassVar[bool] = True

Class variable encoding whether this parameter is numeric.

metadata: MeasurableMetadata

Optional metadata containing description, unit, and other information.

name: str

The name of the parameter

property unit: str | None

The unit of measurement for the parameter.