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

s/logprob/logdensity #427

Merged
merged 1 commit into from
Dec 22, 2022
Merged

s/logprob/logdensity #427

merged 1 commit into from
Dec 22, 2022

Conversation

junpenglao
Copy link
Member

@junpenglao junpenglao commented Dec 17, 2022

Renaming logprob to logdensity for more consistent terminology.

How: search for logprob(?!ability) and replace with logdensity, excluding everything in docs/**, examples/, tests/** as they are mostly logprob.

Thank you for opening a PR!

A few important guidelines and requirements before we can merge your PR:

  • If I add a new sampler, there is an issue discussing it already;
  • We should be able to understand what the PR does from its title only;
  • There is a high-level description of the changes;
  • There are links to all the relevant issues, discussions and PRs;
  • The branch is rebased on the latest main commit;
  • Commit messages follow these guidelines;
  • The code respects the current naming conventions;
  • Docstrings follow the numpy style guide
  • pre-commit is installed and configured on your machine, and you ran it before opening the PR;
  • There are tests covering the changes;
  • The doc is up-to-date;
  • If I add a new sampler* I added/updated related examples

Consider opening a Draft PR if your work is still in progress but you would like some feedback from other contributors.

@junpenglao junpenglao requested a review from rlouf December 17, 2022 13:51
@codecov
Copy link

codecov bot commented Dec 17, 2022

Codecov Report

Merging #427 (db49b6b) into main (dbb1dc9) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

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

@@            Coverage Diff             @@
##             main     #427      +/-   ##
==========================================
- Coverage   89.99%   89.98%   -0.01%     
==========================================
  Files          47       47              
  Lines        2189     2187       -2     
==========================================
- Hits         1970     1968       -2     
  Misses        219      219              
Impacted Files Coverage Δ
blackjax/sgmcmc/diffusions.py 100.00% <ø> (ø)
blackjax/kernels.py 99.55% <100.00%> (ø)
blackjax/mcmc/diffusions.py 100.00% <100.00%> (ø)
blackjax/mcmc/ghmc.py 100.00% <100.00%> (ø)
blackjax/mcmc/hmc.py 100.00% <100.00%> (ø)
blackjax/mcmc/irmh.py 100.00% <100.00%> (ø)
blackjax/mcmc/mala.py 100.00% <100.00%> (ø)
blackjax/mcmc/marginal_latent_gaussian.py 100.00% <100.00%> (ø)
blackjax/mcmc/nuts.py 100.00% <100.00%> (ø)
blackjax/mcmc/periodic_orbital.py 100.00% <100.00%> (ø)
... and 8 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@rlouf rlouf force-pushed the hmc_refactor branch 2 times, most recently from bbb1f5c to 7f13806 Compare December 20, 2022 16:35
@rlouf
Copy link
Member

rlouf commented Dec 20, 2022

There were a few replacements left to be made in the documentation. I also rebased the commits. We need to make sure that the documentation builds correctly before merging this.

Not sure how we go about merging with #279 #396 #421 open.

@rlouf
Copy link
Member

rlouf commented Dec 20, 2022

It looks like the documentation was built ok. Can you do one last check before we merge this?

@junpenglao
Copy link
Member Author

Went through all the examples - This is good to go.

The library currently uses `logprob` to designate the target model's
joint log-density. We adopt the mathematical terminology instead and
replace `logprob` with `logdensity`.
@rlouf rlouf enabled auto-merge (rebase) December 22, 2022 05:15
Copy link
Member

@rlouf rlouf left a comment

Choose a reason for hiding this comment

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

Great work! Will merge automatically when the tests pass.

@rlouf rlouf merged commit bab42d8 into blackjax-devs:main Dec 22, 2022
@junpenglao junpenglao deleted the hmc_refactor branch December 22, 2022 06:00
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.

2 participants