Skip to content

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

Open
@kahaaga

Description

@kahaaga

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationlow priorityThis isn't particuarly important right now.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions