pyro-ppl / pyro-ppl/numpyro

Enhance Distribution Documentation with Mathematical Explanations and Implementation Details

Open
#2,187 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue
Dominant language
Python
Stars
2.8k
Forks
315
Avg merge
3d 9h
Merged PRs (30d)
27

Description

This issue tracks documentation updates that include mathematical explanations alongside implementation details for the distributions and methods listed below.

  • AsymmetricLaplace
  • AsymmetricLaplaceQuantile
  • Bernoulli (#2192)
  • BernoulliLogits (#2192)
  • BernoulliProbs (#2192)
  • Beta (#2185)
  • BetaBinomial (#2277)
  • BetaNegativeBinomial (#2109)
  • BetaProportion (#2185)
  • Binomial (#2192)
  • BinomialLogits (#2192)
  • BinomialProbs (#2192)
  • CAR
  • Categorical
  • CategoricalLogits (#2199)
  • CategoricalProbs (#2199)
  • Cauchy (#2188)
  • Chi2 (#2199)
  • CirculantNormal
  • Dagum
  • Delta
  • Dirichlet (#2227)
  • DirichletMultinomial (#2277)
  • DiscreteUniform (#2199)
  • Distribution
  • DoublyTruncatedPowerLaw
  • EulerMaruyama
  • ExpandedDistribution
  • Exponential (#2188)
  • FoldedDistribution
  • Gamma (#2109)
  • GammaPoisson (#2109)
  • GaussianCopula
  • GaussianCopulaBeta
  • GaussianRandomWalk (#2266)
  • GaussianStateSpace
  • Geometric (#2227)
  • GeometricLogits (#2227)
  • GeometricProbs (#2227)
  • Gompertz
  • Gumbel (#2202)
  • HalfCauchy (#2262)
  • HalfNormal (#2262)
  • ImproperUniform
  • Independent
  • IntervalCensoredDistribution
  • InverseGamma (#2269)
  • InverseWishart
  • InverseWishartCholesky
  • Kumaraswamy (#2269)
  • LKJ
  • LKJCholesky
  • Laplace (#2202)
  • LeftCensoredDistribution
  • LeftTruncatedDistribution
  • Levy
  • LogNormal (#2267)
  • LogUniform (#2267)
  • Logistic (#2202)
  • LowRankMultivariateNormal
  • LowerTruncatedPowerLaw
  • MaskedDistribution
  • MatrixNormal
  • Mixture
  • MixtureGeneral
  • MixtureSameFamily
  • Multinomial
  • MultinomialLogits (#2277)
  • MultinomialProbs (#2277)
  • MultivariateNormal
  • MultivariateStudentT
  • NegativeBinomial2 (#2109)
  • NegativeBinomialLogits (#2109)
  • NegativeBinomialProbs (#2109)
  • Normal (#2188)
  • OrderedLogistic
  • Pareto (#2265)
  • Poisson
  • ProjectedNormal
  • RelaxedBernoulli
  • RelaxedBernoulliLogits
  • RightCensoredDistribution
  • RightTruncatedDistribution
  • SineBivariateVonMises
  • SineSkewed
  • SoftLaplace
  • StudentT (#2268)
  • TransformedDistribution
  • TruncatedCauchy
  • TruncatedDistribution
  • TruncatedNormal
  • TruncatedPolyaGamma
  • TwoSidedTruncatedDistribution
  • Uniform (#2262)
  • Unit
  • VonMises (#2270)
  • Weibull (#2265)
  • Wishart
  • WishartCholesky
  • ZeroInflatedDistribution
  • ZeroInflatedNegativeBinomial2
  • ZeroInflatedPoisson
  • ZeroSumNormal

Some distributions may not require updates; such cases can be noted in the comments as already addressed or resolved.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the unchecked distribution names in the issue checklist and review the linked issues for distributions already documented. Inspect the existing distribution documentation and implementation details for a comparable completed item before choosing one. Done means adding the mathematical explanation and implementation details, or noting in the comments that no update is needed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.