[CU-a73n08, Docs] Glossary - Dispersion

[CloudChaoszero]

Description

• Add "Dispersion"-related definitions in PyMC glossary
• [Optional]: Creating template for adding terms into Glossary

CU-5t5y0p Glossary

[codecov]

Codecov Report

Merging #4984 (f6b5650) into main (65abc6f) will increase coverage by 17.18%.
The diff coverage is n/a.

❗ Current head f6b5650 differs from pull request most recent head cea56e7. Consider uploading reports for the commit cea56e7 to get more accurate results

@@             Coverage Diff             @@
##             main    #4984       +/-   ##
===========================================
+ Coverage   61.11%   78.29%   +17.18%     
===========================================
  Files         130      129        -1     
  Lines       24461    24396       -65     
===========================================
+ Hits        14950    19102     +4152     
+ Misses       9511     5294     -4217     

Impacted Files	Coverage Δ
pymc/backends/report.py	87.41% <0.00%> (-2.10%)	⬇️
pymc/parallel_sampling.py	86.33% <0.00%> (-1.00%)	⬇️
pymc/tests/test_step.py	48.63% <0.00%> (-0.96%)	⬇️
pymc/tests/test_idata_conversion.py	96.20% <0.00%> (-0.20%)	⬇️
pymc/__init__.py	96.00% <0.00%> (-0.08%)	⬇️
pymc/tests/test_model.py	99.11% <0.00%> (-0.04%)	⬇️
pymc/tests/test_sampling.py	97.29% <0.00%> (ø)
pymc/step_methods/__init__.py	100.00% <0.00%> (ø)
pymc/distributions/__init__.py	100.00% <0.00%> (ø)
pymc/bart/pgbart.py
... and 56 more

[martinacantaro]

The Underdispersion entry links to the Overdispersion wikipedia page.

I don't think it's necessary to write the definitions inside quotation marks.

For the dispersion definition, I would try to clarify what 'streched' and 'squeezed' mean, as it is a bit ambiguous

[OriolAbril]

Many of these definitions (especially also looking at the issue and other PRs) are quite complicated and many talks have been given and book chapters written about them, so I think it is very important to be generous with links and references.

I have added a suggestion to link to "dispersion" from the definition of overdispersion (same should be done for underdispersion). I think many definitions will need to refer to other terms.

It might also be a good idea to add some references or seealso links. We can discuss that during the meeting, but as this is mostly oriented at newcomers, we could recommend a section of 1-2 books to dive deeper into that term/area which would link the resources repo with this one much more

[martinacantaro]

Task linked: CU-5t5y0p Glossary

[CloudChaoszero]

Sounds great @martinacantaro. I also added Oriol's recommendation

[martinacantaro]

Looking good! Solved some conflicts, I'm fine with merging it now and creating some issues to resolve later if there's anything we want to improve upon @OriolAbril . I'd suggest moving links out of the definition titles in the future.

(Edited this issue so although this is categorized "request for changes" type of review, I'm not requesting any changes).

[martinacantaro]

Remove this section

[martinacantaro]

/pre-commit-run

[CloudChaoszero]

@martinacantaro are there any additional edits for this? I saw you made some great commits, appreciate it!