GrassbergerMIEstimator

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

Bases: BaseGrassbergerMIEstimator, MutualInformationEstimator

Estimator for the Grassberger mutual information.

Grassberger mutual information estimator using the entropy combination formula.

Attributes:

*dataarray_like, shape (n_samples,)

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

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 mutual information through the entropy combination formula.

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