arviz.InferenceData.rename#

InferenceData.rename(name_dict=None, groups=None, filter_groups=None, inplace=False)[source]#

Perform xarray renaming of variable and dimensions on all groups.

Loops groups to perform Dataset.rename(name_dict) for every key in name_dict if key is a dimension/data_vars of the dataset. The renaming is performed on all relevant groups (like posterior, prior, sample stats) while non relevant groups like observed data are omitted. See xarray.Dataset.rename()

Parameters:

name_dictdict: Dictionary whose keys are current variable or dimension names and whose values are the desired names.
groupsstr or list of str, optional: Groups where the selection is to be applied. Can either be group names or metagroup names.
filter_groups{None, “like”, “regex”}, optional: If None (default), interpret groups as the real group or metagroup names. If “like”, interpret groups as substrings of the real group or metagroup names. If “regex”, interpret groups as regular expressions on the real group or metagroup names. A la pandas.filter.
inplacebool, optional: If True, modify the InferenceData object inplace, otherwise, return the modified copy.

Returns:

InferenceData: A new InferenceData object by default. When inplace==True perform renaming in-place and return None