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

generic mutual_information function #44

Open
Fe-r-oz opened this issue Dec 20, 2024 · 1 comment
Open

generic mutual_information function #44

Fe-r-oz opened this issue Dec 20, 2024 · 1 comment

Comments

@Fe-r-oz
Copy link

Fe-r-oz commented Dec 20, 2024

There is a need for a generic function mutual_information in QuantumInterface.jl to standardize its usage and ensure compatibility across related packages. This function is referenced in QuantumSavory/QuantumClifford.jl#338. As advised by @Krastanov, the goal is to 'pick a name that can be reused by other packages'.

@akirakyle
Copy link
Member

Might be a good excuse to start a metrics.jl file that defines and documents such generic functions representing "metrics on quantum objects" (for example entanglement_entropy would move there). I think trying to be explicit about any conventions that downstream packages should observe so that there's some notion of compatibility between different implementations is the most important information to put in the doc strings here. One obvious interface task here is specifying the units (e.g. bits versus nats).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants