ContinuousParameter¶
- class baybe.parameters.base.ContinuousParameter[source]¶
Bases:
Parameter
Abstract class for continuous parameters.
Public methods
__init__
(name, *[, metadata])Method generated by attrs for class ContinuousParameter.
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.
Create a one-dimensional search space from the parameter.
Create a one-dimensional search space from the parameter.
Public attributes and properties
The columns spanning the computational representation.
The description of the parameter.
Boolean indicating if this is a continuous parameter.
Boolean indicating if this is a discrete parameter.
The unit of measurement for the parameter.
Class variable encoding whether this parameter is numeric.
The name of the parameter
Optional metadata containing description, unit, and other information.
- __init__(name: str, *, metadata=NOTHING)¶
Method generated by attrs for class ContinuousParameter.
For details on the parameters, see Public attributes and properties.
- 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.
- to_dict()¶
Create an object’s dictionary representation.
- Return type:
- 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 orPath
object.**kwargs (Any) – Additional keyword arguments to pass to
json.dumps()
.
- Raises:
FileExistsError – If
sink
points to an already existing file butoverwrite
isFalse
.- 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()[source]¶
Create a one-dimensional search space from the parameter.
- Return type:
SubspaceContinuous
- abstract property comp_rep_columns: tuple[str, ...]¶
The columns spanning the computational representation.
-
metadata:
MeasurableMetadata
¶ Optional metadata containing description, unit, and other information.