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.

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

Add Detailed Documentation for ZeroSumNormal Distribution #7433

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

siddharthbaleja7
Copy link

@siddharthbaleja7 siddharthbaleja7 commented Jul 28, 2024

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

Checklist

Type of change

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

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

Copy link

welcome bot commented Jul 28, 2024

Thank You Banner]
💖 Thanks for opening this pull request! 💖 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.

@siddharthbaleja7
Copy link
Author

pre-commit.ci autofix

Copy link

codecov bot commented Jul 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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%) ⬆️

@siddharthbaleja7
Copy link
Author

@ricardoV94 Can you please review this PR?

@siddharthbaleja7
Copy link
Author

siddharthbaleja7 commented Jul 30, 2024

@aloctavodia @ricardoV94 Can you please review this PR?

@siddharthbaleja7
Copy link
Author

@aloctavodia @ricardoV94 Can you please review this PR?

@ricardoV94
Copy link
Member

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

@siddharthbaleja7 siddharthbaleja7 changed the title Add ZeroSumNormal distribution Add Detailed Documentation for ZeroSumNormal Distribution Jul 31, 2024
@siddharthbaleja7
Copy link
Author

@ricardoV94 Updated.

1 similar comment
@siddharthbaleja7
Copy link
Author

@ricardoV94 Updated.

@aloctavodia
Copy link
Member

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add more information to ZeroSumNormal docs
3 participants