asterion.results#
The results module contains functions for inspecting, summarising, and tabulating inference data.
Module Contents#
- get_dims(data, group='posterior')[source]#
Get available dimension groups for a given inference data group.
- Parameters
data (arviz.InferenceData) – Inference data object.
group (str) – Inference data group.
- Returns
[description]
- Return type
- get_summary(data, group='posterior', var_names=None, **kwargs)[source]#
Get a summary of the inference data for a chosen group.
- Parameters
data (arviz.InferenceData) – Inference data object.
group (str) – [description]. Defaults to ‘posterior’.
var_names (list, optional) – [description]. Defaults to None (all variable names)
**kwargs – Keyword arguments to pass to
arviz.summary().
- Returns
Summary of inference data.
- Return type
See also
arviz.summary(): The function for which this wraps.
- get_table(data, *, dims, group='posterior', var_names=None, fmt='pandas', round_to='auto', **kwargs)[source]#
Get a table of results for parameters in data corresponding to a chosen model dimension. Two-dimensional tables
- Parameters
data (arviz.InferenceData) – Inference data object.
dims (tuple[str]) – The parameter dimensions for the table. E.g. pass () to return a table of 0-dimensional parameters in data, or pass (‘n’,) for 1-dimensional parameters along dimension ‘n’.
group (str) – Group in data to tabulate. Defaults to ‘posterior’.
var_names (list[str], optional) – Variable names in data to show in table. By default all variables along the chosen dim are shown. Defaults to None.
fmt (str) – Table format, one of [‘pandas’, ‘astropy’]. Defaults to ‘pandas’.
round_to (str, or int) – Precision of table data. Defaults to ‘auto’ which chooses the precision for each variable based on the error on the mean.
**kwargs – Keyword arguments to pass to
get_summary().
- Returns
[description]
- Return type
- get_var_names(data, group='posterior', dims='all')[source]#
Get var names for a given group and dimensions.
- Parameters
data (arviz.InferenceData) – Inference data object.
group (str) – Inference data group.
dims (str, or tuple[str]) – Dimensions by which to group variables. If ‘all’, returns variable names for all model dimensions. If a tuple of dimension names, returns variable names in that dimension group.
- Returns
Variable names for a given group and dimensions.
- Return type