doc(gh-2187): enhance documentation for Chi2, DiscreteUniform, and Categorical distributions#2199
Merged
Qazalbash merged 4 commits intoMay 25, 2026
Conversation
…, and Categorical distributions
Collaborator
|
Thanks @Metbcy |
Qazalbash
requested changes
May 24, 2026
Contributor
Author
|
Thanks @Qazalbash, addressed both:
Also merged master. 40f98fc |
Qazalbash
approved these changes
May 24, 2026
Qazalbash
added a commit
that referenced
this pull request
May 28, 2026
* doc(gh-2187): enhance documentation for Gumbel, Laplace, and Logistic distributions Adds math-flavored docstrings to three more continuous distributions on the #2187 checklist, following the template from #2188, #2192, and #2199: - Gumbel: class, __init__, sample, log_prob, mean, variance, cdf, icdf. - Laplace: class, __init__, sample, log_prob, mean, variance, cdf, icdf, entropy. - Logistic: class, __init__, sample, log_prob, mean, variance, cdf, icdf, entropy. Docstrings only, no logic changes. ruff check and ruff format --check are clean. * fix: small fixes --------- Co-authored-by: Meesum Qazalbash <meesumqazalbash@gmail.com>
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
2 participants
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.
Adds math-flavored docstrings to four more distributions on the #2187 checklist, following the template from #2188 and #2192.
Chi2(class +__init__) — also notes theGamma(k/2, 1/2)equivalence so readers know why the other methods aren't redocumented here.DiscreteUniform— class,__init__,sample,log_prob,cdf,icdf,mean,variance,enumerate_support,entropy.CategoricalProbs— same surface;mean/variancedocumented asNaNsince the categories are unordered.CategoricalLogits— same, with thelogsumexpstability note onlog_probandentropy.Docstrings only, no logic changes.
ruff checkandruff format --checkare clean on both files.