pymc icon indicating copy to clipboard operation
pymc copied to clipboard

Add Detailed Documentation for ZeroSumNormal Distribution

Open siddharthbaleja7 opened this issue 1 year ago • 10 comments

Description

This PR enhances the documentation for the ZeroSumNormal transform. The updates include:

  • Reformatted docstrings and comments to comply with PEP 8 line length guidelines.
  • Added more detailed information about the ZeroSumNormal transform, integrating explanations from pyro-ppl/numpyro#1751 as suggested by @aseyboldt.
  • Provided additional examples and clarification on how the transform works and its use cases.

Related Issue

  • [x] Closes #7425

Checklist

Type of change

  • [ ] New feature / enhancement
  • [ ] Bug fix
  • [x] Documentation
  • [ ] Maintenance
  • [ ] Other (please specify):

📚 Documentation preview 📚: https://pymc--7433.org.readthedocs.build/en/7433/

siddharthbaleja7 avatar Jul 28 '24 21:07 siddharthbaleja7

Thank You Banner] :sparkling_heart: Thanks for opening this pull request! :sparkling_heart: The PyMC community really appreciates your time and effort to contribute to the project. Please make sure you have read our Contributing Guidelines and filled in our pull request template to the best of your ability.

welcome[bot] avatar Jul 28 '24 21:07 welcome[bot]

pre-commit.ci autofix

siddharthbaleja7 avatar Jul 29 '24 11:07 siddharthbaleja7

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.18%. Comparing base (8eaa9be) to head (d05980a).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #7433   +/-   ##
=======================================
  Coverage   92.18%   92.18%           
=======================================
  Files         103      103           
  Lines       17263    17268    +5     
=======================================
+ Hits        15914    15919    +5     
  Misses       1349     1349           
Files Coverage Δ
pymc/distributions/transforms.py 98.52% <100.00%> (+0.05%) :arrow_up:

codecov[bot] avatar Jul 29 '24 11:07 codecov[bot]

@ricardoV94 Can you please review this PR?

siddharthbaleja7 avatar Jul 29 '24 11:07 siddharthbaleja7

@aloctavodia @ricardoV94 Can you please review this PR?

siddharthbaleja7 avatar Jul 30 '24 14:07 siddharthbaleja7

@aloctavodia @ricardoV94 Can you please review this PR?

siddharthbaleja7 avatar Jul 31 '24 16:07 siddharthbaleja7

@siddharthbaleja7 no need to ping us repeatedly. Also can you provide a more accurate PR title?

ricardoV94 avatar Jul 31 '24 17:07 ricardoV94

@ricardoV94 Updated.

siddharthbaleja7 avatar Jul 31 '24 19:07 siddharthbaleja7

@ricardoV94 Updated.

siddharthbaleja7 avatar Aug 01 '24 11:08 siddharthbaleja7

@siddharthbaleja7 no need to ping us, we get email updates every time someone comments or changes something. The title and description are about improving the documentation of the ZeroSumNormal Distribution, but the changes are wider than that. Please clarify or remove unrelated changes.

aloctavodia avatar Aug 01 '24 17:08 aloctavodia