rbnet.util.ConstrainedModuleMixin

class rbnet.util.ConstrainedModuleMixin

Bases: object

A mixin class for modules with constraints to work cooperatively. Calling enforce_constraints() will recursively try to call this method on child modules.

Typical usage would be to call enforce_constraints() on the top-level parent module before the forward pass and/or after an optimisation step.

See Prob for an example.

Public Methods:

enforce_constraints([recurse])	Enforce constraints for module parameters and child modules.
remap(param[, _top_level, prefix])

---

enforce_constraints(recurse=True)

Enforce constraints for module parameters and child modules.

If modules have constrained parameters, they should override this method to enforce these constraints. If they also have child modules and recurse=True, they should additionally call super().enforce_constraints() to recursively propagate the call.

remap(param, _top_level=True, prefix=None)