Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Leonenko-Prozano-Savani differential estimator for Shannon, Renyi and Tsallis entropies #310

Merged
merged 8 commits into from
Aug 28, 2023

Conversation

kahaaga
Copy link
Member

@kahaaga kahaaga commented Aug 26, 2023

The title is descriptive enough. I'm cleaning up some todos in CausalityTools, and this estimator is one of those that got left behind when we did the first major refactoring of ComplexityMeasures.jl. Here it is, in all its multiple-entropies estimatory glory.

The docs are here.

Changes:

  • Added new LeonenkoProzantoSavani differential estimator, with implementations for Shannon, Renyi and Tsallis entropies.
  • Added analytical tests for all three types of entropy, testing that we're within 10% of the target entropy for a multivariate normal distribution.
  • Added documentation examples for the estimation of Shannon, Renyi and Tsallis differential entropies (also using multivariate normal with known entropies).

@codecov
Copy link

codecov bot commented Aug 26, 2023

Codecov Report

Merging #310 (b0ef203) into main (35e9522) will increase coverage by 0.26%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #310      +/-   ##
==========================================
+ Coverage   87.49%   87.76%   +0.26%     
==========================================
  Files          75       76       +1     
  Lines        1879     1920      +41     
==========================================
+ Hits         1644     1685      +41     
  Misses        235      235              
Files Changed Coverage Δ
src/core/information_measures.jl 0.00% <ø> (ø)
..._estimators/nearest_neighbors/nearest_neighbors.jl 100.00% <ø> (ø)
...mators/nearest_neighbors/LeonenkoProzantoSavani.jl 100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@Datseris Datseris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

feel free to merge after you adress the two comments

@kahaaga kahaaga merged commit 547b8fa into main Aug 28, 2023
4 checks passed
@kahaaga kahaaga deleted the leonenko_prosanto_savani branch August 28, 2023 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants