preliz icon indicating copy to clipboard operation
preliz copied to clipboard

Improve presentation of distributions on the PreliZ page

Open aleicazatti opened this issue 1 year ago • 17 comments

Tell us about it

The current presentation of distributions on the PreliZ API page is too verbose, which is suitable for technical details but not very user-friendly.

Thoughts on implementation

1. Create a distributions grid page:

  • Develop a new page with a grid of images (like ArviZ example gallery), each representing a distribution's probability density function (PDF).

  • Clicking on an image should lead to more detailed information, including the "story" or history of the distribution.

2. Detailed individual pages for each distribution:

  • Simplify the information by distilling content from sources like Wikipedia, making it more accessible.

  • Include concise, "Bayesian-focused" stories for each distribution.

  • Provide visual examples, parameter explanations, and common uses.

  • Implement "See also" sections to link related distributions.

  • Add tags for easier searching based on domain, parameters, symmetry, etc.

aleicazatti avatar May 28 '24 03:05 aleicazatti

We should also create specific issues for each distribution, that will help us distribute the work and we could use the specific issues to collect and discuss the specific information we want to add to each element in the grid.

For the See Also, we could use this as a guide https://upload.wikimedia.org/wikipedia/commons/a/af/ProbOnto2.5.jpg, after a quick look I think a good principle could be to add a "See also" if two distributions are first neighbours in this graph. We could consider other cases too, for instance it makes sense that NegativeBinomial and ZINB should have mutual "see also" links. And also we should consider simplifications, for instance merge Normal with StandardNormal, or StudentT 1, 2 and 3 together with NoncentralT1. Still it could be a good guide.

Other sources for stories or useful information can be https://distribution-explorer.github.io/discrete/bernoulli.html and https://www.acsu.buffalo.edu/~adamcunn/probability/betabinomial.html

aloctavodia avatar May 28 '24 12:05 aloctavodia

Progress tracker for individual distribution pages:

  • [x] AsymmetricLaplace
  • [x] Beta
  • [x] BetaScaled
  • [x] Cauchy
  • [x] Censored
  • [x] ChiSquared
  • [x] ExGaussian
  • [x] Exponential
  • [x] Gamma
  • [x] Gumbel
  • [x] HalfCauchy
  • [x] HalfNormal
  • [x] HalfStudentT
  • [x] InverseGamma
  • [x] Kumaraswamy
  • [x] Laplace
  • [x] LogNormal
  • [x] Logistic
  • [x] LogLogistic
  • [x] LogitNormal
  • [x] Moyal
  • [x] Normal
  • [x] Pareto
  • [x] Rice
  • [x] SkewNormal
  • [x] StudentT
  • [x] SkewStudentT
  • [x] Triangular
  • [x] Truncated
  • [x] TruncatedNormal
  • [x] Uniform
  • [x] VonMises
  • [x] Wald
  • [x] Weibull
  • [x] Bernoulli
  • [x] BetaBinomial
  • [x] Binomial
  • [x] Categorical
  • [x] DiscreteUniform
  • [x] DiscreteWeibull
  • [x] Geometric
  • [x] HyperGeometric
  • [x] NegativeBinomial
  • [x] Poisson
  • [x] ZeroInflatedBinomial
  • [x] ZeroInflatedNegativeBinomial
  • [x] ZeroInflatedPoisson
  • [x] Dirichlet
  • [x] MvNormal
  • [x] Mixture (add "(Mixture_gallery)=" link, see Censored)
  • [x] Hurdle (add "(Hurdle_gallery)=" link, see Censored)

aleicazatti avatar May 30 '24 00:05 aleicazatti

I'm working on the Student's T

aleicazatti avatar Jun 21 '24 14:06 aleicazatti

I will continue with the logistic distribution

aleicazatti avatar Jun 24 '24 21:06 aleicazatti

Working on Cauchy

aleicazatti avatar Jun 26 '24 19:06 aleicazatti

Working on lognormal

aleicazatti avatar Jul 01 '24 16:07 aleicazatti

Working on exponential

aleicazatti avatar Jul 03 '24 19:07 aleicazatti

Working on Poisson

aloctavodia avatar Jul 09 '24 14:07 aloctavodia

Working on continuous uniform

aleicazatti avatar Jul 10 '24 20:07 aleicazatti

working on AsymetricLaplace

aloctavodia avatar Jul 11 '24 18:07 aloctavodia

Working on ChiSquared

aleicazatti avatar Jul 17 '24 00:07 aleicazatti

working on Gamma

aleicazatti avatar Jul 24 '24 19:07 aleicazatti

working on ExGaussian

aleicazatti avatar Jul 31 '24 15:07 aleicazatti

Working on HalfCauchy

aleicazatti avatar Sep 23 '24 15:09 aleicazatti

Working on HalfNormal

aleicazatti avatar Sep 24 '24 14:09 aleicazatti

Working on HalfStudentT

aleicazatti avatar Sep 25 '24 15:09 aleicazatti

Working on InverseGamma

aleicazatti avatar Sep 26 '24 14:09 aleicazatti

Working on Kumaraswamy

aleicazatti avatar Sep 30 '24 15:09 aleicazatti

Working on Laplace

aleicazatti avatar Oct 01 '24 20:10 aleicazatti

Working on Log-Logistic

aleicazatti avatar Oct 03 '24 13:10 aleicazatti

Working on LogitNormal

aleicazatti avatar Oct 07 '24 18:10 aleicazatti

Working on Moyal

aleicazatti avatar Oct 09 '24 17:10 aleicazatti

Working on Pareto

aleicazatti avatar Oct 14 '24 20:10 aleicazatti

Working on Rice

aleicazatti avatar Oct 17 '24 16:10 aleicazatti

Working on SkewNormal

aleicazatti avatar Oct 21 '24 18:10 aleicazatti

Working on SkewStudentT

aleicazatti avatar Oct 23 '24 18:10 aleicazatti

Working on Triangular

aleicazatti avatar Oct 28 '24 17:10 aleicazatti

Working on TruncatedNormal

aleicazatti avatar Oct 29 '24 17:10 aleicazatti

Working on VonMises

aleicazatti avatar Oct 30 '24 18:10 aleicazatti