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.

Sign up for GitHub

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

Jump to bottom

Improve presentation of distributions on the PreliZ page #448

Open
aleicazatti opened this issue May 28, 2024 · 29 comments
Open

Improve presentation of distributions on the PreliZ page #448

aleicazatti opened this issue May 28, 2024 · 29 comments
Assignees
@aleicazatti
Labels
documentation Improvements or additions to documentation

Comments

@aleicazatti
Copy link
Collaborator

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.
@aloctavodia
Copy link
Contributor

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

@aleicazatti aleicazatti mentioned this issue May 30, 2024
Closed
@aleicazatti
Copy link
Collaborator Author

aleicazatti commented May 30, 2024 •
edited
Loading

Progress tracker for individual distribution pages:

  • AsymmetricLaplace
  • Beta
  • BetaScaled
  • Cauchy
  • Censored
  • ChiSquared
  • ExGaussian
  • Exponential
  • Gamma
  • Gumbel
  • HalfCauchy
  • HalfNormal
  • HalfStudentT
  • Hurdle
  • InverseGamma
  • Kumaraswamy
  • Laplace
  • LogNormal
  • Logistic
  • LogLogistic
  • LogitNormal
  • Moyal
  • Normal
  • Pareto
  • Rice
  • SkewNormal
  • StudentT
  • SkewStudentT
  • Triangular
  • Truncated
  • TruncatedNormal
  • Uniform
  • VonMises
  • Wald
  • Weibull
  • Bernoulli
  • BetaBinomial
  • Binomial
  • Categorical
  • DiscreteUniform
  • DiscreteWeibull
  • Geometric
  • HyperGeometric
  • NegativeBinomial
  • Poisson
  • ZeroInflatedBinomial
  • ZeroInflatedNegativeBinomial
  • ZeroInflatedPoisson
  • Dirichlet
  • MvNormal

@aleicazatti
Copy link
Collaborator Author

I'm working on the Student's T

@aleicazatti
Copy link
Collaborator Author

I will continue with the logistic distribution

@aleicazatti
Copy link
Collaborator Author

Working on Cauchy

@aleicazatti
Copy link
Collaborator Author

Working on lognormal

@aleicazatti
Copy link
Collaborator Author

Working on exponential

@aloctavodia
Copy link
Contributor

Working on Poisson

@aleicazatti
Copy link
Collaborator Author

Working on continuous uniform

@aloctavodia aloctavodia pinned this issue Jul 11, 2024
@aloctavodia
Copy link
Contributor

working on AsymetricLaplace

@aleicazatti
Copy link
Collaborator Author

Working on ChiSquared

@aleicazatti
Copy link
Collaborator Author

working on Gamma

@aleicazatti
Copy link
Collaborator Author

working on ExGaussian

@aleicazatti
Copy link
Collaborator Author

Working on HalfCauchy

@aleicazatti
Copy link
Collaborator Author

Working on HalfNormal

@aleicazatti
Copy link
Collaborator Author

Working on HalfStudentT

@aleicazatti
Copy link
Collaborator Author

Working on InverseGamma

@aleicazatti
Copy link
Collaborator Author

Working on Kumaraswamy

@aleicazatti
Copy link
Collaborator Author

Working on Laplace

@aloctavodia aloctavodia added the documentation Improvements or additions to documentation label Oct 2, 2024
@aleicazatti
Copy link
Collaborator Author

Working on Log-Logistic

@aleicazatti
Copy link
Collaborator Author

Working on LogitNormal

@aleicazatti
Copy link
Collaborator Author

Working on Moyal

@aleicazatti
Copy link
Collaborator Author

Working on Pareto

@aleicazatti
Copy link
Collaborator Author

Working on Rice

@aleicazatti
Copy link
Collaborator Author

Working on SkewNormal

@aleicazatti
Copy link
Collaborator Author

aleicazatti commented Oct 23, 2024 •
edited
Loading

Working on SkewStudentT

@aleicazatti
Copy link
Collaborator Author

Working on Triangular

@aleicazatti
Copy link
Collaborator Author

Working on TruncatedNormal

@aleicazatti
Copy link
Collaborator Author

Working on VonMises

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aleicazatti aleicazatti

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@aloctavodia @aleicazatti