pymc
pymc copied to clipboard
Add Detailed Documentation for ZeroSumNormal Distribution
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
ZeroSumNormaltransform, 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
- [x] Checked that the pre-commit linting/style checks pass
- [x] Included tests that prove the fix is effective or that the new feature works
- [x] Added necessary documentation (docstrings and/or example notebooks)
- [ ] If you are a pro: each commit corresponds to a relevant logical change
Type of change
- [ ] New feature / enhancement
- [ ] Bug fix
- [x] Documentation
- [ ] Maintenance
- [ ] Other (please specify):
📚 Documentation preview 📚: https://pymc--7433.org.readthedocs.build/en/7433/
]
: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.
pre-commit.ci autofix
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
@@ 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: |
@ricardoV94 Can you please review this PR?
@aloctavodia @ricardoV94 Can you please review this PR?
@aloctavodia @ricardoV94 Can you please review this PR?
@siddharthbaleja7 no need to ping us repeatedly. Also can you provide a more accurate PR title?
@ricardoV94 Updated.
@ricardoV94 Updated.
@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.