arviz.InferenceData

class arviz.InferenceData(attrs=None, warn_on_custom_groups=False, **kwargs)

Container for inference data storage using xarray.

For a detailed introduction to InferenceData objects and their usage, see Introduction to xarray, InferenceData, and netCDF for ArviZ. This page provides help and documentation on InferenceData methods and their low level implementation.

Methods

InferenceData.__init__([attrs, ...])	Initialize InferenceData object from keyword xarray datasets.
InferenceData.add_groups([group_dict, ...])	Add new groups to InferenceData object.
InferenceData.assign([variables])	assign method is extended from xarray.Dataset methods.
InferenceData.assign_coords([coords])	assign_coords method is extended from xarray.Dataset methods.
InferenceData.chunk([chunks, name_prefix, ...])	chunk method is extended from xarray.Dataset methods.
InferenceData.close()	close method is extended from xarray.Dataset methods.
InferenceData.compute(**kwargs)	compute method is extended from xarray.Dataset methods.
InferenceData.copy()	Return a fresh copy of the InferenceData object.
InferenceData.cumsum([dim, skipna, keep_attrs])	cumsum method is extended from xarray.Dataset methods.
InferenceData.extend(other[, join, ...])	Extend InferenceData with groups from another InferenceData.
InferenceData.from_datatree(datatree)	Create an InferenceData object from a DataTree.
InferenceData.from_netcdf(filename, *[, ...])	Initialize object from a netcdf file.
InferenceData.from_zarr(store)	Initialize object from a zarr store or path.
InferenceData.get(k[,d])
InferenceData.get_index(key)	get_index method is extended from xarray.Dataset methods.
InferenceData.groups()	Return all groups present in InferenceData object.
InferenceData.isel([groups, filter_groups, ...])	Perform an xarray selection on all groups.
InferenceData.items()	Return a view over the groups and datasets present in the InferenceData object.
InferenceData.keys()
InferenceData.load(**kwargs)	load method is extended from xarray.Dataset methods.
InferenceData.map(fun[, groups, ...])	Apply a function to multiple groups.
InferenceData.max([dim, skipna, keep_attrs])	max method is extended from xarray.Dataset methods.
InferenceData.mean([dim, skipna, keep_attrs])	mean method is extended from xarray.Dataset methods.
InferenceData.median([dim, skipna, keep_attrs])	median method is extended from xarray.Dataset methods.
InferenceData.min([dim, skipna, keep_attrs])	min method is extended from xarray.Dataset methods.
InferenceData.persist(**kwargs)	persist method is extended from xarray.Dataset methods.
InferenceData.quantile(q[, dim, method, ...])	quantile method is extended from xarray.Dataset methods.
InferenceData.rename([name_dict, groups, ...])	Perform xarray renaming of variable and dimensions on all groups.
InferenceData.rename_dims([name_dict, ...])	Perform xarray renaming of dimensions on all groups.
InferenceData.rename_vars([name_dict, ...])	Perform xarray renaming of variable or coordinate names on all groups.
InferenceData.reset_coords([names, drop])	reset_coords method is extended from xarray.Dataset methods.
InferenceData.reset_index(dims_or_levels, *)	reset_index method is extended from xarray.Dataset methods.
InferenceData.sel([groups, filter_groups, ...])	Perform an xarray selection on all groups.
InferenceData.set_coords(names)	set_coords method is extended from xarray.Dataset methods.
InferenceData.set_index([indexes, append])	set_index method is extended from xarray.Dataset methods.
InferenceData.sortby(variables[, ascending])	sortby method is extended from xarray.Dataset methods.
InferenceData.stack([dimensions, groups, ...])	Perform an xarray stacking on all groups.
InferenceData.sum([dim, skipna, min_count, ...])	sum method is extended from xarray.Dataset methods.
InferenceData.to_dataframe([groups, ...])	Convert InferenceData to a pandas.DataFrame following xarray naming conventions.
InferenceData.to_datatree()	Convert InferenceData object to a DataTree.
InferenceData.to_dict([groups, filter_groups])	Convert InferenceData to a dictionary following xarray naming conventions.
InferenceData.to_json(filename[, groups, ...])	Write InferenceData to a json file.
InferenceData.to_netcdf(filename[, ...])	Write InferenceData to netcdf4 file.
InferenceData.to_zarr([store])	Convert InferenceData to a zarr.hierarchy.Group.
InferenceData.unify_chunks()	unify_chunks method is extended from xarray.Dataset methods.
InferenceData.unstack([dim, groups, ...])	Perform an xarray unstacking on all groups.
InferenceData.values()	Return a view over the Xarray Datasets present in the InferenceData object.

Attributes

attrs

Attributes of InferenceData object.