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

Minor doc clean up #428

Merged
merged 1 commit into from
Dec 22, 2022
Merged

Minor doc clean up #428

merged 1 commit into from
Dec 22, 2022

Conversation

junpenglao
Copy link
Member

@junpenglao junpenglao commented Dec 17, 2022

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.

example using oyrx is currently broken (jax-ml/oryx#25)
@codecov
Copy link

codecov bot commented Dec 17, 2022

Codecov Report

Merging #428 (6481f69) into main (cc5d3f5) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #428   +/-   ##
=======================================
  Coverage   89.99%   89.99%           
=======================================
  Files          47       47           
  Lines        2189     2189           
=======================================
  Hits         1970     1970           
  Misses        219      219           
Impacted Files Coverage Δ
blackjax/kernels.py 99.55% <ø> (ø)

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

@rlouf rlouf merged commit dbb1dc9 into blackjax-devs:main Dec 22, 2022
@junpenglao junpenglao deleted the doc_cleanup branch December 22, 2022 03:18
junpenglao added a commit that referenced this pull request Mar 12, 2024
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