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

Introduce some entropy related functions #416

Merged
merged 12 commits into from
Feb 20, 2025
Merged

Introduce some entropy related functions #416

merged 12 commits into from
Feb 20, 2025

Conversation

ytdHuang
Copy link
Member

@ytdHuang ytdHuang commented Feb 19, 2025

Checklist

Thank you for contributing to QuantumToolbox.jl! Please make sure you have finished the following tasks before opening the PR.

  • Please read Contributing to Quantum Toolbox in Julia.
  • Any code changes were done in a way that does not break public API.
  • Appropriate tests were added and tested locally by running: make test.
  • Any code changes should be julia formatted by running: make format.
  • All documents (in docs/ folder) related to code changes were updated and able to build locally by running: make docs.
  • (If necessary) the CHANGELOG.md should be updated (regarding to the code changes) and built by running: make changelog.

Request for a review after you have completed all the tasks. If you have not finished them all, you can also open a Draft Pull Request to let the others know this on-going work.

Description

In this PR, we introduce the following entropy related functions:

  • entropy_linear
  • entropy_mutual
  • entropy_conditional
  • entropy_relative

I also separate the source code file of metrics.jl into entropy.jl and metrics.jl.

Related issues or PRs

implement some functions listed in issue #414

Copy link

codecov bot commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.29%. Comparing base (7d58e46) to head (df75458).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #416      +/-   ##
==========================================
+ Coverage   94.20%   94.29%   +0.08%     
==========================================
  Files          46       47       +1     
  Lines        2918     2944      +26     
==========================================
+ Hits         2749     2776      +27     
+ Misses        169      168       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ytdHuang
Copy link
Member Author

I don't think the significant slowdown in benchmark tracking is related to this PR...

@albertomercurio
Copy link
Member

It is the pseudo-inverse benchmarks that apparently varies a lot.

@ytdHuang ytdHuang merged commit 46b98de into main Feb 20, 2025
1 check was pending
@ytdHuang ytdHuang deleted the dev/entropy branch February 20, 2025 05:27
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

Successfully merging this pull request may close these issues.

2 participants