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

Add relative_entropy to operations documentation #506

Merged
merged 2 commits into from
Dec 29, 2023

Conversation

maxkapur
Copy link
Contributor

This PR adds a line to docs/src/operations.md to cover the relative_entropy(x, y) (KL divergence) function, as requested in this issue: #499


  • Unfortunately, I was unable to build the docs locally to double-check for syntax errors:
ERROR: LoadError: `makedocs` encountered errors (:cross_references, :example_block). Terminating build before rendering.
  • I notice that entropy(x) and relative_entropy(x) have opposite signs, despite the former being a special case of the latter. Any interest in a PR fixing this? Which one should flip? This would be a breaking change in either case.

docs/src/operations.md Outdated Show resolved Hide resolved
@ericphanson
Copy link
Collaborator

I notice that entropy(x) and relative_entropy(x) have opposite signs, despite the former being a special case of the latter. Any interest in a PR fixing this? Which one should flip? This would be a breaking change in either case

The signs are correct, that is how the entropy and relative entropy are defined.

Co-authored-by: Eric Hanson <5846501+ericphanson@users.noreply.github.com>
@ericphanson ericphanson merged commit f47b5a4 into jump-dev:master Dec 29, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants