firecrown.parameters.SamplerParameter

class firecrown.parameters.SamplerParameter(*, default_value=None, name=None, prefix=None)

Bases: object

Class to represent a sampler defined parameter.

Parameters:

• default_value (None | float) –

• name (None | str) –

• prefix (None | str) –

Public Methods:

__init__(*[, default_value, name, prefix])	Creates a new SamplerParameter instance.
get_default_value()	Get the default value of this parameter.
set_fullname(prefix, name)	Set the prefix of this parameter.
__hash__()	Return the hash of the full name of this parameter.
__eq__(other)	Return whether this parameter is equal to another.

---

__eq__(other)

Return whether this parameter is equal to another.

Two SamplerParameter objects are equal if they have the same full name.

Parameters:

other (object) –

Return type:

bool

__hash__()

Return the hash of the full name of this parameter.

Return type:

int

property fullname: str

Get the full name of this parameter.

get_default_value()

Get the default value of this parameter.

Return type:

None | float

property name: str

Get the name of this parameter.

property prefix: str | None

Get the prefix of this parameter.

set_fullname(prefix, name)

Set the prefix of this parameter.

Parameters:

• prefix (str | None) – new prefix

• name (str) –