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

Replace pybop.MAP with pybop.LogPosterior #483

Merged
merged 17 commits into from
Sep 9, 2024

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented Sep 4, 2024

Description

  • Replaces pybop.MAP with pybop.LogPosterior,
  • adds MAP notebook,
  • updates tests and bugfixes,
  • adds repr to parameters,
  • refactors logpdfS1 for JointPrior

Issue reference

Fixes #459

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

  • Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
  • Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

  • New Feature: A non-breaking change that adds new functionality.
  • Optimization: A code change that improves performance.
  • Examples: A change to existing or additional examples.
  • Bug Fix: A non-breaking change that addresses an issue.
  • Documentation: Updates to documentation or new documentation for new features.
  • Refactoring: Non-functional changes that improve the codebase.
  • Style: Non-functional changes related to code style (formatting, naming, etc).
  • Testing: Additional tests to improve coverage or confirm functionality.
  • Other: (Insert description of change)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All unit tests pass: $ nox -s tests
  • The documentation builds: $ nox -s doctest

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is well-commented, especially in complex or unclear areas.
  • Added tests that prove my fix is effective or that my feature works.
  • Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

Thank you for contributing to our project! Your efforts help us to deliver great software.

… initial notebook, updts tests and bugfixes, adds __repr__ to parameters, refactors logpdfS1 for JointPrior
@BradyPlanden BradyPlanden linked an issue Sep 6, 2024 that may be closed by this pull request
Copy link

codecov bot commented Sep 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.03%. Comparing base (6b83edc) to head (9018f75).
Report is 51 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #483      +/-   ##
===========================================
+ Coverage    99.01%   99.03%   +0.02%     
===========================================
  Files           52       52              
  Lines         3555     3527      -28     
===========================================
- Hits          3520     3493      -27     
+ Misses          35       34       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

# Conflicts:
#	examples/notebooks/comparing_cost_functions.ipynb
#	examples/notebooks/cost-compute-methods.ipynb
#	examples/notebooks/multi_model_identification.ipynb
@BradyPlanden BradyPlanden marked this pull request as ready for review September 9, 2024 09:18
Copy link
Contributor

@martinjrobins martinjrobins left a comment

Choose a reason for hiding this comment

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

looks great @BradyPlanden, a few suggestions below:

pybop/costs/_likelihoods.py Show resolved Hide resolved
pybop/costs/_likelihoods.py Outdated Show resolved Hide resolved
pybop/costs/_likelihoods.py Show resolved Hide resolved
pybop/costs/_likelihoods.py Outdated Show resolved Hide resolved
pybop/plotting/plot2d.py Outdated Show resolved Hide resolved
@martinjrobins
Copy link
Contributor

I would merge, but are we merging or squash merging?

@BradyPlanden
Copy link
Member Author

I'm happy with either. I've been merging as is, with squashes close to a release for cherry picking, or if the branch commits are quite noisy.

@martinjrobins martinjrobins merged commit 1822ddb into develop Sep 9, 2024
31 checks passed
@martinjrobins martinjrobins deleted the 459-replace-MAP-class branch September 9, 2024 18:06
BradyPlanden added a commit that referenced this pull request Sep 10, 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.

Rename and merge LogPosterior and MAP class Add prior args for MAP cost function
2 participants