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

Document how particles should be represented in SMC #582

Merged

Conversation

ciguaran
Copy link
Contributor

@ciguaran ciguaran commented Nov 1, 2023

Documents how particles should be represented in SMC, providing some examples. Hopefully covers what was answered in this dicussion #464

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

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

Copy link

codecov bot commented Nov 1, 2023

Codecov Report

Merging #582 (fb73280) into main (f5a2a12) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #582   +/-   ##
=======================================
  Coverage   99.14%   99.14%           
=======================================
  Files          49       49           
  Lines        2117     2117           
=======================================
  Hits         2099     2099           
  Misses         18       18           
Files Coverage Δ
blackjax/smc/base.py 100.00% <ø> (ø)

junpenglao
junpenglao previously approved these changes Nov 2, 2023
blackjax/smc/base.py Outdated Show resolved Hide resolved
Co-authored-by: Junpeng Lao <[email protected]>
@junpenglao junpenglao merged commit d056670 into blackjax-devs:main Nov 2, 2023
7 checks passed
junpenglao added a commit that referenced this pull request Mar 12, 2024
* Document how particles should be represented in SMC

* Update blackjax/smc/base.py

Co-authored-by: Junpeng Lao <[email protected]>

---------

Co-authored-by: Junpeng Lao <[email protected]>
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