tKg< dZddlmZddlZddlZddlmZddlm Z m Z ddl m Z dd gZ e d d dd d d d ddZddZe dddeddddd d dZdZdZdZdZdZy)!z5 Created on Fri Apr 2 09:06:05 2021 @author: matth ) annotationsN)special)_axis_nan_policy_factory_broadcast_arrays)array_namespaceentropydifferential_entropyc|SNxs X/home/alanp/www/video.onchill/myenv/lib/python3.12/site-packages/scipy/stats/_entropy.pyracd|vr|ddSdS)Nqkrr )kwgss rrrs!dltDz5   rc|fSr r rs rrrsA4rT) n_samples n_outputsresult_to_tuplepaired too_smallcR||dkr td| t|n t||}|j|}tjd5d|z|j ||dz }ddd|t j|}n`|j|}t||fd| \}}t|d}d|z|j |fi|z }t j||}|j || }||tj|z}|S#1swYxYw) a Calculate the Shannon entropy/relative entropy of given distribution(s). If only probabilities `pk` are given, the Shannon entropy is calculated as ``H = -sum(pk * log(pk))``. If `qk` is not None, then compute the relative entropy ``D = sum(pk * log(pk / qk))``. This quantity is also known as the Kullback-Leibler divergence. This routine will normalize `pk` and `qk` if they don't sum to 1. Parameters ---------- pk : array_like Defines the (discrete) distribution. Along each axis-slice of ``pk``, element ``i`` is the (possibly unnormalized) probability of event ``i``. qk : array_like, optional Sequence against which the relative entropy is computed. Should be in the same format as `pk`. base : float, optional The logarithmic base to use, defaults to ``e`` (natural logarithm). axis : int, optional The axis along which the entropy is calculated. Default is 0. Returns ------- S : {float, array_like} The calculated entropy. Notes ----- Informally, the Shannon entropy quantifies the expected uncertainty inherent in the possible outcomes of a discrete random variable. For example, if messages consisting of sequences of symbols from a set are to be encoded and transmitted over a noiseless channel, then the Shannon entropy ``H(pk)`` gives a tight lower bound for the average number of units of information needed per symbol if the symbols occur with frequencies governed by the discrete distribution `pk` [1]_. The choice of base determines the choice of units; e.g., ``e`` for nats, ``2`` for bits, etc. The relative entropy, ``D(pk|qk)``, quantifies the increase in the average number of units of information needed per symbol if the encoding is optimized for the probability distribution `qk` instead of the true distribution `pk`. Informally, the relative entropy quantifies the expected excess in surprise experienced if one believes the true distribution is `qk` when it is actually `pk`. A related quantity, the cross entropy ``CE(pk, qk)``, satisfies the equation ``CE(pk, qk) = H(pk) + D(pk|qk)`` and can also be calculated with the formula ``CE = -sum(pk * log(qk))``. It gives the average number of units of information needed per symbol if an encoding is optimized for the probability distribution `qk` when the true distribution is `pk`. It is not computed directly by `entropy`, but it can be computed using two calls to the function (see Examples). See [2]_ for more information. References ---------- .. [1] Shannon, C.E. (1948), A Mathematical Theory of Communication. Bell System Technical Journal, 27: 379-423. https://doi.org/10.1002/j.1538-7305.1948.tb01338.x .. [2] Thomas M. Cover and Joy A. Thomas. 2006. Elements of Information Theory (Wiley Series in Telecommunications and Signal Processing). Wiley-Interscience, USA. Examples -------- The outcome of a fair coin is the most uncertain: >>> import numpy as np >>> from scipy.stats import entropy >>> base = 2 # work in units of bits >>> pk = np.array([1/2, 1/2]) # fair coin >>> H = entropy(pk, base=base) >>> H 1.0 >>> H == -np.sum(pk * np.log(pk)) / np.log(base) True The outcome of a biased coin is less uncertain: >>> qk = np.array([9/10, 1/10]) # biased coin >>> entropy(qk, base=base) 0.46899559358928117 The relative entropy between the fair coin and biased coin is calculated as: >>> D = entropy(pk, qk, base=base) >>> D 0.7369655941662062 >>> D == np.sum(pk * np.log(pk/qk)) / np.log(base) True The cross entropy can be calculated as the sum of the entropy and relative entropy`: >>> CE = entropy(pk, base=base) + entropy(pk, qk, base=base) >>> CE 1.736965594166206 >>> CE == -np.sum(pk * np.log(qk)) / np.log(base) True Nr+`base` must be a positive number or `None`.ignore)invalidg?Taxiskeepdims)r$xpr$) ValueErrorrasarraynperrstatesumrentrrdictrel_entrmathlog)pkrbaser$r&vec sum_kwargsSs rr r sv DAIFGG "  B0GB BB X & VbffRdTf: : ' zll2 ZZ^"B8$2>Btd3 VfbffR.:. .r2& sA  TXXd^ H ' &s DD&c|d}|j|}|jdtjtj|dz}dd|zcxkr|ksyyy)Nr window_length?rTF)shapegetr0floorsqrt)sampleskwargsr$valuesnr8s r"_differential_entropy_is_too_smallrBsb QZF TAJJ#zz$))A,*<=?M M! %A % & rc|Sr r rs rrrrrc|fSr r rs rrrsr)rrrauto)r8r3r$methodcxtj|}tj||d}|jd}|+t j t j |dz}dd|zcxkr|ksntd|d|d||dkr tdtj|d }tttttd }|j}||vrd t|}t||d k(r|d krd}n |dkrd}nd}||||} || tj|z} | S)aVGiven a sample of a distribution, estimate the differential entropy. Several estimation methods are available using the `method` parameter. By default, a method is selected based the size of the sample. Parameters ---------- values : sequence Sample from a continuous distribution. window_length : int, optional Window length for computing Vasicek estimate. Must be an integer between 1 and half of the sample size. If ``None`` (the default), it uses the heuristic value .. math:: \left \lfloor \sqrt{n} + 0.5 \right \rfloor where :math:`n` is the sample size. This heuristic was originally proposed in [2]_ and has become common in the literature. base : float, optional The logarithmic base to use, defaults to ``e`` (natural logarithm). axis : int, optional The axis along which the differential entropy is calculated. Default is 0. method : {'vasicek', 'van es', 'ebrahimi', 'correa', 'auto'}, optional The method used to estimate the differential entropy from the sample. Default is ``'auto'``. See Notes for more information. Returns ------- entropy : float The calculated differential entropy. Notes ----- This function will converge to the true differential entropy in the limit .. math:: n \to \infty, \quad m \to \infty, \quad \frac{m}{n} \to 0 The optimal choice of ``window_length`` for a given sample size depends on the (unknown) distribution. Typically, the smoother the density of the distribution, the larger the optimal value of ``window_length`` [1]_. The following options are available for the `method` parameter. * ``'vasicek'`` uses the estimator presented in [1]_. This is one of the first and most influential estimators of differential entropy. * ``'van es'`` uses the bias-corrected estimator presented in [3]_, which is not only consistent but, under some conditions, asymptotically normal. * ``'ebrahimi'`` uses an estimator presented in [4]_, which was shown in simulation to have smaller bias and mean squared error than the Vasicek estimator. * ``'correa'`` uses the estimator presented in [5]_ based on local linear regression. In a simulation study, it had consistently smaller mean square error than the Vasiceck estimator, but it is more expensive to compute. * ``'auto'`` selects the method automatically (default). Currently, this selects ``'van es'`` for very small samples (<10), ``'ebrahimi'`` for moderate sample sizes (11-1000), and ``'vasicek'`` for larger samples, but this behavior is subject to change in future versions. All estimators are implemented as described in [6]_. References ---------- .. [1] Vasicek, O. (1976). A test for normality based on sample entropy. Journal of the Royal Statistical Society: Series B (Methodological), 38(1), 54-59. .. [2] Crzcgorzewski, P., & Wirczorkowski, R. (1999). Entropy-based goodness-of-fit test for exponentiality. Communications in Statistics-Theory and Methods, 28(5), 1183-1202. .. [3] Van Es, B. (1992). Estimating functionals related to a density by a class of statistics based on spacings. Scandinavian Journal of Statistics, 61-72. .. [4] Ebrahimi, N., Pflughoeft, K., & Soofi, E. S. (1994). Two measures of sample entropy. Statistics & Probability Letters, 20(3), 225-234. .. [5] Correa, J. C. (1995). A new estimator of entropy. Communications in Statistics-Theory and Methods, 24(10), 2439-2449. .. [6] Noughabi, H. A. (2015). Entropy Estimation Using Numerical Methods. Annals of Data Science, 2(2), 231-241. https://link.springer.com/article/10.1007/s40745-015-0045-9 Examples -------- >>> import numpy as np >>> from scipy.stats import differential_entropy, norm Entropy of a standard normal distribution: >>> rng = np.random.default_rng() >>> values = rng.standard_normal(100) >>> differential_entropy(values) 1.3407817436640392 Compare with the true entropy: >>> float(norm.entropy()) 1.4189385332046727 For several sample sizes between 5 and 1000, compare the accuracy of the ``'vasicek'``, ``'van es'``, and ``'ebrahimi'`` methods. Specifically, compare the root mean squared error (over 1000 trials) between the estimate and the true differential entropy of the distribution. >>> from scipy import stats >>> import matplotlib.pyplot as plt >>> >>> >>> def rmse(res, expected): ... '''Root mean squared error''' ... return np.sqrt(np.mean((res - expected)**2)) >>> >>> >>> a, b = np.log10(5), np.log10(1000) >>> ns = np.round(np.logspace(a, b, 10)).astype(int) >>> reps = 1000 # number of repetitions for each sample size >>> expected = stats.expon.entropy() >>> >>> method_errors = {'vasicek': [], 'van es': [], 'ebrahimi': []} >>> for method in method_errors: ... for n in ns: ... rvs = stats.expon.rvs(size=(reps, n), random_state=rng) ... res = stats.differential_entropy(rvs, method=method, axis=-1) ... error = rmse(res, expected) ... method_errors[method].append(error) >>> >>> for method, errors in method_errors.items(): ... plt.loglog(ns, errors, label=method) >>> >>> plt.legend() >>> plt.xlabel('sample size') >>> plt.ylabel('RMSE (1000 trials)') >>> plt.title('Entropy Estimator Error (Exponential Distribution)') rr9rzWindow length (z7) must be positive and less than half the sample size (z).rr r')vasicekvan escorreaebrahimirEz`method` must be one of rE rIirKrH)r*r)moveaxisr:r0r<r=r(sort_vasicek_entropy_van_es_entropy_correa_entropy_ebrahimi_entropylowersetr1) r@r8r3r$rFrA sorted_datamethodsmessageress rr r sOhZZ F [[r *F RA 499Q<##56 M! %A %m_-**+B 0   DAIFGG''&r*K*((,' )G \\^F W,S\N;!!  7F $YFF '&/+} 5C  rvvd| Jrctj|j}||d<tj|ddgf|}tj|ddgf|}tj|||fdS)z9Pad the data for computing the rolling window difference.r.rr')r*arrayr: broadcast_to concatenate)Xmr:XlXrs r_pad_along_last_axisralsj HHQWW EE"I 38e ,B 39u -B >>2q"+B //rc|jd}t||}|dd|zdf|ddd|zfz }tj|d|zz |z}tj|dS)z:Compute the Vasicek estimator as described in [6] Eq. 1.3.r.rNr')r:rar*r1mean)r]r^rA differenceslogss rrOrOvsp  AQ"ACQK.1S)BF)^#44K 66!QqS'K' (D 774b !!rc|jd}|d|df|dd| fz }d||z z tjtj|dz|z |zdz}tj||dz}|tjd|z ztj|ztj|dzz S)z1Compute the van Es estimator as described in [6].r.Nrr')r:r*r,r1arange)r]r^rA differenceterm1ks rrPrPs  A37aSqbSk)J qsGbffRVVQqS!Gj$89C CE !QqSA 266!A#;  *RVVAaC[ 88rc|jd}t||}|dd|zdf|ddd|zfz }tjd|dzj t }tj |dz}d|||kdz |z z|||k<d|||||z dzk\z |z z||||z dzk\<tj||z||zz }tj|dS)z3Compute the Ebrahimi estimator as described in [6].r.rNrcrr') r:rar*rhastypefloat ones_liker1rd)r]r^rAreicirfs rrRrRs  AQ"ACQK.1S)BF)^#44K !QqS  'A a BaQi!mQ&&BqAvJa!A1QJ-/22BqAEAI~ 66!k/R!V, -D 774b !!rc|jd}t||}tjd|dz}tj| |dzdddf}||z}||zdz }tj|d|fdd}|d|f|z }tj ||zd} |tj |d zdz} tjtj | | z d S) z1Compute the Correa estimator as described in [6].rrN.rcTr#r'r)r:rar*rhrdr,r1) r]r^rArpdjjj0Xibarrinumdens rrQrQs  AQ"A !QqSA A2qs AtG $B BA QB GGAc2gJR$ 7E37e#J &&BR (C BFF:q=r * *C GGBFF3s7O" - --r)NNr) r2np.typing.ArrayLikerznp.typing.ArrayLike | Noner3 float | Noner$intreturnnp.number | np.ndarray)r) r@ryr8z int | Noner3rzr$r{rFstrr|r})__doc__ __future__rr0numpyr*scipyr_axis_nan_policyrrscipy._lib._array_apir__all__r rBr rarOrPrRrQr rrrs # I1 , -.2!%E *E E E ( E E P1n0!% y yy  y  y  yy yx0"9"".r