Package paramz :: Package core :: Module constrainable :: Class Constrainable

Class Constrainable

Instance Methods

__init__(self, name, default_constraint=None, *a, **kw)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

constrain_fixed(self, value=None, warning=True, trigger_parent=True)
Constrain this parameter to be fixed to the current value it carries.

source code

fix(self, value=None, warning=True, trigger_parent=True)
Constrain this parameter to be fixed to the current value it carries.

source code

unconstrain_fixed(self)
This parameter will no longer be fixed.

source code

unfix(self)
This parameter will no longer be fixed.

source code

_ensure_fixes(self)

source code

_set_fixed(self, param, index)

source code

_set_unfixed(self, param, index)

source code

_connect_fixes(self)

source code

_has_fixes(self)

source code

_get_original(self, param)

source code

constrain(self, transform, warning=True, trigger_parent=True)
:param transform: the :py:class:`paramz.transformations.Transformation` to constrain the this parameter to.

source code

unconstrain(self, *transforms)
:param transforms: The transformations to unconstrain from.

source code

constrain_positive(self, warning=True, trigger_parent=True)
:param warning: print a warning if re-constraining parameters.

source code

constrain_negative(self, warning=True, trigger_parent=True)
:param warning: print a warning if re-constraining parameters.

source code

constrain_bounded(self, lower, upper, warning=True, trigger_parent=True)
:param lower, upper: the limits to bound this parameter to :param warning: print a warning if re-constraining parameters.

source code

unconstrain_positive(self)
Remove positive constraint of this parameter.

source code

unconstrain_negative(self)
Remove negative constraint of this parameter.

source code

unconstrain_bounded(self, lower, upper)
:param lower, upper: the limits to unbound this parameter from

source code

Inherited from indexable.Indexable: __setstate__, add_index_operation, remove_index_operation

Inherited from indexable.Indexable (private): _add_io, _add_to_index_operations, _disconnect_parent, _offset_for, _parent_changed, _raveled_index, _raveled_index_for, _raveled_index_for_transformed, _remove_from_index_operations

Inherited from nameable.Nameable: hierarchy_name

Inherited from gradcheckable.Gradcheckable: checkgrad

Inherited from gradcheckable.Gradcheckable (private): _checkgrad

Inherited from pickleable.Pickleable: __deepcopy__, __getstate__, copy, pickle

Inherited from parentable.Parentable: has_parent

Inherited from parentable.Parentable (private): _notify_parent_change

Inherited from updateable.Updateable: toggle_update, trigger_update, update_model, update_toggle

Inherited from observable.Observable: add_observer, change_priority, notify_observers, remove_observer, set_updates

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

Inherited from parentable.Parentable: _parent_, _parent_index_

Properties

[hide private]

is_fixed

Inherited from nameable.Nameable: name

Inherited from parentable.Parentable: _highest_parent_

Inherited from object: __class__

Method Details

[hide private]

init(self, name, default_constraint=None, *a, **kw)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

constrain_fixed(self, value=None, warning=True, trigger_parent=True)

source code

Constrain this parameter to be fixed to the current value it carries.

This does not override the previous constraints, so unfixing will restore the constraint set before fixing.

:param warning: print a warning for overwriting constraints.

fix(self, value=None, warning=True, trigger_parent=True)

source code

Constrain this parameter to be fixed to the current value it carries.

This does not override the previous constraints, so unfixing will restore the constraint set before fixing.

:param warning: print a warning for overwriting constraints.

unconstrain_fixed(self)

source code

This parameter will no longer be fixed.

If there was a constraint on this parameter when fixing it, it will be constraint with that previous constraint.

unfix(self)

source code

This parameter will no longer be fixed.

If there was a constraint on this parameter when fixing it, it will be constraint with that previous constraint.

constrain(self, transform, warning=True, trigger_parent=True)

source code


:param transform: the :py:class:`paramz.transformations.Transformation`
                  to constrain the this parameter to.
:param warning: print a warning if re-constraining parameters.

Constrain the parameter to the given
:py:class:`paramz.transformations.Transformation`.