NsbMIEstimator#
- class infomeasure.estimators.mutual_information.NsbMIEstimator(*data, cond=None, K: int = None, offset: int = 0, base: int | float | str = 'e', **kwargs)[source]
Bases:
BaseNsbMIEstimator,MutualInformationEstimatorEstimator for the Nsb mutual information.
Nsb 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.
- K
int,optional The support size. If not provided, uses the observed support size.
- offset
int,optional Number of positions to shift the data arrays relative to each other. Delay/lag/shift between the variables. Default is no shift.
- *dataarray_like,
See also
infomeasure.estimators.entropy.nsb.NsbEntropyEstimatorNsb entropy estimator.
Notes
This estimator uses the Nsb 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.