parameters (pmrf.parameters)

The parameters module for defining model parameters.

Classes

ParameterGroup(param_names[, distribution])

A metadata class that groups a set of named flat parameters and defines any relationships between them.

Functions

is_param(x)	Check if an object is an instance of a Parameter.
is_valid_param(x)	Check if an object is an instance of a Parameter and if its value is not None.
is_free_param(x)	Check if an object is a non-fixed Parameter.
is_fixed_param(x)	Check if an object is a fixed Parameter.
as_param(x, **kwargs)	Ensure an object is a Parameter or container over parameters.
Uniform(low, high[, value, n])	Create a Parameter with a uniform distribution.
PercentUniform(mean, perc, *args, **kwargs)	Create a Parameter with a uniform distribution defined by a percentage width.
RelativeUniform(mean, deviation_fraction, ...)	Create a Parameter with a uniform distribution defined by a fractional deviation.
CenteredUniform(mean, half_width, *args, ...)	Create a Parameter with a uniform distribution.
Normal(mean, std[, n, value])	Create a Parameter with a normal (Gaussian) distribution.
PercentNormal(mean, perc, **kwargs)	Create a Parameter with a normal (Gaussian) distribution and a percentage standard deviation.
RelativeNormal(mean, std_fraction, **kwargs)	Create a Parameter with a normal distribution defined by a relative standard deviation.
Fixed(value[, n])	Create a Parameter that is marked as fixed.
Free(value[, n])	Create a Parameter that is marked as not free (i.e., free to vary).
Stacked(parameters[, name])	Combine multiple scalar or identically-shaped Parameters into a single vectorized Parameter.