Clipped

Contents

Clipped#

class braintools.init.Clipped(base_dist, min_val=None, max_val=None)#

Clipped version of another distribution.

Clips the output of another distribution to specified minimum and maximum values.

Parameters:

  • base_dist (Initialization) – Base distribution to clip.

  • min_val (Array | ndarray | bool | number | bool | int | float | complex | Quantity | None) – Minimum value (default: no lower bound).

  • max_val (Array | ndarray | bool | number | bool | int | float | complex | Quantity | None) – Maximum value (default: no upper bound).

Examples

>>> import numpy as np
>>> import brainunit as u
>>> from braintools.init import Clipped, Normal
>>>
>>> base = Normal(0.5 * u.siemens, 0.3 * u.siemens)
>>> init = Clipped(base, min_val=0.0 * u.siemens, max_val=1.0 * u.siemens)
>>> rng = np.random.default_rng(0)
>>> weights = init(1000, rng=rng)
Contents