API reference

User facing converters

arviz_base.convert_to_datatree(obj, **kwargs)	Convert a supported object to a DataTree object following ArviZ conventions.
arviz_base.extract(data[, group, combined, ...])	Extract a group or group subset from a DataTree.
arviz_base.from_dict(data, *[, name, ...])	Convert nested dictionary into a DataTree.

Library specific converters

arviz_base.from_cmdstanpy([posterior, ...])	Convert CmdStanPy data into an InferenceData object.
arviz_base.from_emcee([sampler, var_names, ...])	Convert emcee data into a DataTree.

More coming soon…

Iteration and subsetting

arviz_base.xarray_sel_iter(data[, ...])	Convert xarray data to an iterator over variable names and selections.
arviz_base.xarray_var_iter(data[, ...])	Convert xarray data to an iterator over vectors.

Example datasets

arviz_base.load_arviz_data([dataset, data_home])	Load a local or remote pre-made dataset.
arviz_base.list_datasets()	Get a string representation of all available datasets with descriptions.
arviz_base.get_data_home([data_home])	Return the path of the arviz data dir.
arviz_base.clear_data_home([data_home])	Delete all the content of the data home cache.

Configuration

arviz_base.rc_context([rc, fname])

Return a context manager for managing rc settings.

Conversion utilities

arviz_base.convert_to_dataset(obj, *[, group])	Convert a supported object to an xarray dataset.
arviz_base.dict_to_dataset(data, *[, attrs, ...])	Convert a dictionary of numpy arrays to an xarray.Dataset.
arviz_base.generate_dims_coords(shape, var_name)	Generate default dimensions and coordinates for a variable.
arviz_base.make_attrs([attrs, inference_library])	Make standard attributes to attach to xarray datasets.
arviz_base.ndarray_to_dataarray(ary, var_name, *)	Convert a numpy array to an xarray.DataArray.