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.

Sign up for GitHub

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

Jump to bottom

Differential entropy docstrings: simplify the Shannon-based ones? #231

Open
kahaaga opened this issue Dec 28, 2022 · 0 comments
Open

Differential entropy docstrings: simplify the Shannon-based ones? #231

kahaaga opened this issue Dec 28, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation low priority This isn't particuarly important right now.

Comments

@kahaaga
Copy link
Member

kahaaga commented Dec 28, 2022 •
edited

As discussed in #230, we could shorten the docstrings for the Shannon differential entropy estimators by just stating the formula once in the overall docs.

But there will also be differential entropy estimators that estimates Tsallis and Renyi entropy, which will display other formulas. Should we display formulas for none or all docstring? Or just some?

There are arguments for and against doing so. We should re-assess this once the number of estimators has grown a bit, and we cover more EntropyDefinitions
@kahaaga kahaaga added discussion-design Discussion or design matters low priority This isn't particuarly important right now. labels Dec 28, 2022
@Datseris Datseris added documentation Improvements or additions to documentation and removed discussion-design Discussion or design matters labels Dec 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation low priority This isn't particuarly important right now.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kahaaga @Datseris