ELIFE-ASU / PyInform

A Python Wrapper for the Inform Information Analysis Library
https://elife-asu.github.io/PyInform
MIT License
45 stars 9 forks source link

Relative Entropy #10

Closed dglmoore closed 7 years ago

dglmoore commented 7 years ago

Inform added relative entropy in the v0.0.5 release. The next release of PyInform should include a wrapper for relative entropy.

Proposed API

def relative_entropy(xs, ys, b=0, base=2.0, local=False):

Example Usage

from pyinform.relativeentropy import relative_entropy

xs = [0,0,1,1,1,1,0,0,0]
ys = [1,0,0,1,0,0,1,0,0]

relative_entropy(xs, ys, b=2, base=2.0) # == 0.038330
relative_entropy(ys, xs, b=2, base=2.0) # == 0.037010

relative_entropy(xs, ys, b=2, base=2.0, local=True)
# == [-0.263, 0.415]
relative_entropy(ys, xs, b=2, base=2.0, local=True)
# == [0.263, -0.415]