spines.parameters¶
Parameters module for parameterized models.
-
class
spines.parameters.
Parameter
(*value_type, default=None, desc: str = None)[source]¶ Bases:
object
Parameter class
- Parameters
value_type (
type
orIterable
oftype
) – The type(s) of values allowed for this parameter.default (object, optional) – Default value for this parameter, if any.
desc (str, optional) – Description for this parameter, if any.
-
check
(value) → bool[source]¶ Checks the given value for validity
- Parameters
value – Parameter value to check validity of.
- Returns
Whether or not the value is valid for the parameter.
- Return type
bool
-
default
¶ Default value to use for this parameter.
- Type
object
-
desc
¶ Description of this parameter.
- Type
str
-
name
¶ Name of this parameter.
- Type
str
-
required
¶ Whether or not this parameter is required to be set.
- Type
bool
-
value_type
¶ The types of values allowed for this option.
- Type
tuple
-
class
spines.parameters.
HyperParameter
(*value_type, default=None, desc: str = None)[source]¶ Bases:
spines.parameters.base.Parameter
Hyper-parameter
-
class
spines.parameters.
Bounded
(*args, **kwargs)[source]¶ Bases:
spines.parameters.mixins.Minimum
,spines.parameters.mixins.Maximum
,spines.parameters.base.Parameter
Bounded parameter (min/max)
-
class
spines.parameters.
HyperBounded
(*args, **kwargs)[source]¶ Bases:
spines.parameters.mixins.Minimum
,spines.parameters.mixins.Maximum
,spines.parameters.base.HyperParameter
Bounded hyper-parameter (min/max)
-
class
spines.parameters.
ParameterStore
[source]¶ Bases:
collections.abc.MutableMapping
Helper class for managing collections of Parameters.
-
add
(parameter: Type[spines.parameters.base.Parameter]) → None[source]¶ Add a
Parameter
specification to this store
-
copy
(deep: bool = False) → Type[spines.parameters.store.ParameterStore][source]¶ Returns a copy of this parameter store object.
- Parameters
deep (bool, optional) – Whether or not to do deep-copying of this stores contents.
- Returns
Copied parameter store object.
- Return type
-
final
¶ Whethor or not this set of parameters is finalized.
- Type
bool
-
finalize
() → None[source]¶ Finalizes the parameters stored
- Raises
MissingParameterException – If a required parameter is not set.
-
parameters
¶ Copy of the current set of parameters.
- Type
dict
-
valid
¶ Whether or not this is a fully valid set of parameters.
- Type
bool
-
values
¶ Copy of the current set of parameter values.
- Type
dict
-
-
exception
spines.parameters.
InvalidParameterException
[source]¶ Bases:
spines.parameters.base.ParameterException
Thrown when an invalid parameter is given.
-
exception
spines.parameters.
MissingParameterException
[source]¶ Bases:
spines.parameters.base.ParameterException
Thrown when a required parameter is missing.