The get_data_linker function#

Aliases#

halerium.core.get_data_linker
halerium.core.data_linker.get_data_linker
get_data_linker(data=None, graph=None, n_data=None, inplace=False, warn_if_not_found=True)#

Create DataLinker with links to data.

Parameters:

  • data (None, dict, DataLinker) – The data to be linked. If given, must be a DataLinker instance or a dictionary with the variables to link data to as keys and the data arrays to be linked to the variables as values. If a DataLinker instance, this (if inplace) or a copy is returned after consistency checks and possible modifications. The default is None.

  • graph (optional) – If given, the keys in data (i.e. variables to link to) are checked for equivalent variables (i.e. with matching relative name and shape) in the graph. The default is None.

  • n_data (None, int) – The number of examples in the data. If None, will be inferred from data. The default is None.

  • inplace (bool) – Whether to perform possible modifications on a DataLinker inplace and return it or to modify and return a copy instead. Has no effect if data is not a DataLinker. The default is False.

  • warn_if_not_found (bool) – Whether to warn if data linker contains a link to a variable which (or equivalent) cannot be found in the graph.