GrassbergerCMIEstimator

class infomeasure.estimators.mutual_information.GrassbergerCMIEstimator(*data, cond=None, offset: int = 0, base: int | float | str = 'e', **kwargs)

Bases: BaseGrassbergerMIEstimator, ConditionalMutualInformationEstimator

Estimator for the conditional Grassberger mutual information.

Grassberger conditional mutual information estimator using the entropy combination formula.

Attributes:

*dataarray_like, shape (n_samples,)

The data used to estimate the conditional mutual information. You can pass an arbitrary number of data arrays as positional arguments.

condarray_like

The conditional data used to estimate the conditional mutual information.

offsetint, optional

Number of positions to shift the data arrays relative to each other. Delay/lag/shift between the variables. Default is no shift.

See also

infomeasure.estimators.entropy.grassberger.GrassbergerEntropyEstimator

Grassberger entropy estimator.

Notes

This estimator uses the Grassberger entropy estimator to compute conditional mutual information through the entropy combination formula.

Note that the entropy combination formula is used (_generic_cmi_from_entropy) not a dedicated implementation as other MI might have.