Keep

class bayesflow.adapters.transforms.Keep(keys: Sequence[str])

Bases: Transform

Name the data parameters that should be kept for futher calculation.

Parameters:

keyssequence of str

The names of kept data variables as strings.

Examples

Two moons simulator generates data for priors alpha, r and theta as well as observation data x. We are interested only in theta and x, to keep only theta and x we should use the following;

>>> adapter = (
    bf.adapters.Adapter()
        # drop data from unneeded priors alpha, and r
        # only keep theta and x
        .keep(("theta", "x"))
    )

The following example shows the usage in a more general case:

>>> a = [1, 2, 3, 4]
>>> b = [[1, 2], [3, 4]]
>>> c = [[5, 6, 7, 8]]
>>> dat = dict(a=a, b=b, c=c)

Here we want to only keep elements b and c

>>> keeper = bf.adapters.transforms.Keep(("b", "c"))
>>> keeper.forward(dat)
{'b': [[1, 2], [3, 4]], 'c': [[5, 6, 7, 8]]}

classmethod from_config(config: dict, custom_objects=None) → Keep

get_config() → dict

forward(data: dict[str, any], **kwargs) → dict[str, any]

inverse(data: dict[str, any], **kwargs) → dict[str, any]

extra_repr() → str

__call__(data: dict[str, ndarray], *, inverse: bool = False, **kwargs) → dict[str, ndarray]

Call self as a function.