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

Improve HSGP and ZeroInflated / Hurdle distributions docs #7189

Merged
merged 1 commit into from
Mar 13, 2024

Conversation

AlexAndorra
Copy link
Contributor

@AlexAndorra AlexAndorra commented Mar 11, 2024

Description

Just a small PR to improve and fix some typos in the doc pages of:

  • HSGP (base method and prior_linearized method)
  • ZeroInflated distributions (switched from "variates" to "draws", which is more common and much clearer when teaching)
  • Hurdle distributions (same change as previous point)

Ready for review and merge

Checklist

Type of change

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

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

@AlexAndorra AlexAndorra self-assigned this Mar 11, 2024
Copy link

codecov bot commented Mar 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.84%. Comparing base (244fb97) to head (2c279ba).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #7189      +/-   ##
==========================================
- Coverage   92.26%   91.84%   -0.43%     
==========================================
  Files         100      100              
  Lines       16880    16880              
==========================================
- Hits        15574    15503      -71     
- Misses       1306     1377      +71     
Files Coverage Δ
pymc/distributions/mixture.py 95.08% <ø> (ø)
pymc/gp/hsgp_approx.py 95.62% <ø> (ø)

... and 3 files with indirect coverage changes

@AlexAndorra
Copy link
Contributor Author

Failing test seems completely unrelated. Should I just rerun it?

Comment on lines +307 to +310
# The centered approximation can be more efficient when
# the GP is stronger than the noise
# beta = pm.Normal("beta", sigma=sqrt_psd, size=gp._m_star)
# f = pm.Deterministic("f", phi @ beta)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity: is this something empirical, or is there a general statement about it? :)

@AlexAndorra
Copy link
Contributor Author

AlexAndorra commented Mar 11, 2024 via email

Copy link
Member

@ricardoV94 ricardoV94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If someone disagrees with the centered thing let us know so we can revert.

@ricardoV94 ricardoV94 merged commit a06081e into main Mar 13, 2024
22 of 24 checks passed
@ricardoV94
Copy link
Member

@AlexAndorra small nitpick, would have been better to have two separate commits for the two unrelated changes (Mixture, HSGP)

@AlexAndorra AlexAndorra deleted the improve-docs branch March 14, 2024 12:14
@AlexAndorra
Copy link
Contributor Author

True. Noted for next time @ricardoV94

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

Successfully merging this pull request may close these issues.

3 participants