StudentT

class StudentT(df, mu=0.0, scale=1.0, name=None, latex_label=None, unit=None, boundary=None)

Bases: Prior

__init__(df, mu=0.0, scale=1.0, name=None, latex_label=None, unit=None, boundary=None)

Student’s t-distribution prior with number of degrees of freedom df, mean mu and scale

https://en.wikipedia.org/wiki/Student%27s_t-distribution#Generalized_Student’s_t-distribution

Parameters:

df: float

Number of degrees of freedom for distribution

mu: float

Mean of the Student’s t-prior

scale:

Width of the Student’s t-prior

name: str

See superclass

latex_label: str

See superclass

unit: str

See superclass

boundary: str

See superclass

__call__()

Overrides the __call__ special method. Calls the sample method.

Returns:

float: The return value of the sample method.

Methods

__init__(df[, mu, scale, name, latex_label, ...])	Student's t-distribution prior with number of degrees of freedom df, mean mu and scale
cdf(val, *[, xp])	Generic method to calculate CDF, can be overwritten in subclass
from_json(dct)
from_repr(string)	Generate the prior from its __repr__
get_instantiation_dict()
is_in_prior_range(val)	Returns True if val is in the prior boundaries, zero otherwise
ln_prob(*args[, xp])	Returns the log prior probability of val.
prob(*args[, xp])	Return the prior probability of val.
rescale(*args[, xp])	'Rescale' a sample from the unit line element to the appropriate Student's t-prior.
sample([size, random_state])	Draw a sample from the prior
to_json()

Attributes

boundary
is_fixed	Returns True if the prior is fixed and should not be used in the sampler.
latex_label	Latex label that can be used for plots.
latex_label_with_unit	If a unit is specified, returns a string of the latex label and unit
maximum
minimum
unit
width

cdf(val, *, xp=None)

Generic method to calculate CDF, can be overwritten in subclass

classmethod from_repr(string)

Generate the prior from its __repr__

property is_fixed

Returns True if the prior is fixed and should not be used in the sampler. Does this by checking if this instance is an instance of DeltaFunction.

Returns:

bool: Whether it’s fixed or not!

is_in_prior_range(val)

Returns True if val is in the prior boundaries, zero otherwise

Parameters:

val: Union[float, int, array_like]

Returns:

np.nan

property latex_label

Latex label that can be used for plots.

Draws from a set of default labels if no label is given

Returns:

str: A latex representation for this prior

property latex_label_with_unit

If a unit is specified, returns a string of the latex label and unit

ln_prob(*args, xp=None, **kwargs)

Returns the log prior probability of val.

Parameters:

val: Union[float, int, array_like]

Returns:

Union[float, array_like]: Prior probability of val

prob(*args, xp=None, **kwargs)

Return the prior probability of val.

Parameters:

val: Union[float, int, array_like]

Returns:

Union[float, array_like]: Prior probability of val

rescale(*args, xp=None, **kwargs)

‘Rescale’ a sample from the unit line element to the appropriate Student’s t-prior.

This maps to the inverse CDF. This has been analytically solved for this case.

Notes

This explicitly casts to the requested backend, but the computation will be done by scipy.

sample(size=None, *, random_state=None)

Draw a sample from the prior

Parameters:

size: int or tuple of ints, optional

See numpy.random.uniform docs

Returns:

float: A random number between 0 and 1, rescaled to match the distribution of this Prior