Repository navigation
Clarify entropy conventions and repair quantile documentation links - #181
Merged
Merged
Conversation
Document that entropy and EntropyAccumulator compute sum(x * ln(x)) using natural logarithms, without normalizing inputs or negating the result. For normalized probabilities, this is the negative of Shannon entropy in nats. Describe nonnegative input requirements, zero contributions, and assertions for negative inputs. Use examples to distinguish the existing sum from entropy calculated after normalization. AI-Assisted-By: Codex (GPT-6 Astra Medium)
Qualified enum-member references omitted the leading dot used by generated Ddoc anchors, leaving links to eight distinct targets unresolved. Replace the 27 affected references with explicit links to the generated anchors while preserving their displayed names. Cover both ordinary and weighted quantile algorithm references without changing implementation behavior. AI-Assisted-By: Codex (GPT-6 Astra Medium)
Use the canonical .entropy anchor for the sign-convention link. The short entropy anchor first resolves to the accumulator property, which does not contain the referenced explanation. AI-Assisted-By: Codex (GPT-6 Astra Medium)
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarify that entropy and EntropyAccumulator compute sum(x * ln(x)) using natural logarithms, without normalization or negation. Document nonnegative input requirements, zero contributions, and the relationship to Shannon entropy in nats. Examples distinguish the existing calculation from entropy computed after normalizing inputs.
Repair 27 quantile documentation references pointing to eight unresolved enum-member anchors. Also direct the accumulator’s sign-convention link to the standalone entropy function rather than its similarly named property.
These changes affect documentation only; implementation behavior is unchanged.
Validation:
AI-Assisted-By: Codex (GPT-6 Astra Medium)