neurodsp.sim.update.create_sampler¶
- neurodsp.sim.update.create_sampler(values, probs=None, n_samples=None)[source]¶
Create a generator to sample from a set of parameters.
- Parameters:
- valueslist or 1d array
Parameter values to create a generator for.
- probs1d array, optional
Probabilities to sample from values. If provided, should be the same lengths as values.
- n_samplesint, optional
The number of parameter iterations to set as max. If None, creates an infinite generator.
- Yields:
- generator
Generator to sample parameter values from.
Examples
Create a generator to sample parameter values from, for a specified number of samples:
>>> sampler = create_sampler([-2, -1, 0], n_samples=5)
Create a generator to sampler parameter values from, with specified probability:
>>> sampler = create_sampler([9, 10, 11], probs=[0.25, 0.5, 0.25])
