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

Transformation fixes #495

Merged

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented Sep 12, 2024

Description

  • Fixes GaussianLogLikelihood's interaction with the transformation class.
  • Fixes missing apply_transform arg in cost call for SciPy optimisers. Adds addition costs to transformation integration tests and general refactor.
  • Fixes incorrect application of transformed bounds with default or resulting NaN transformation bounds

Issue reference

Fixes #492

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.

@BradyPlanden BradyPlanden linked an issue Sep 12, 2024 that may be closed by this pull request
Copy link

codecov bot commented Sep 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.04%. Comparing base (a3293ed) to head (6569eaa).
Report is 143 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #495   +/-   ##
========================================
  Coverage    99.04%   99.04%           
========================================
  Files           52       52           
  Lines         3556     3559    +3     
========================================
+ Hits          3522     3525    +3     
  Misses          34       34           

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

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.

Thanks @BradyPlanden, looks great. I think there is a danger in the lenght of the fail gradient becoming out of sync with the number of parameters in the base cost class, so would suggest a setter on the parameters attribute, what do you think? Can be a separate issue as well if you don't want to deal with it now

pybop/costs/_likelihoods.py Outdated Show resolved Hide resolved
@BradyPlanden
Copy link
Member Author

BradyPlanden commented Sep 12, 2024

Thanks for the review @martinjrobins, I agree that a setter in the BaseCost would improve stability the fail_gradient() object. It's probably best as a follow on PR though as I think it will require more changes than should be included here. Updated below.

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.

Yea, I think this is better. Should parameters be renamed to `_parameters' to indicate that it shouldn't be set directly?

@martinjrobins martinjrobins merged commit 2062c2f into develop Sep 14, 2024
31 checks passed
@martinjrobins martinjrobins deleted the 492-bug-fix-transformations-for-gaussianloglikelihood branch September 14, 2024 14:43
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.

[Bug]: Fix transformations for GaussianLogLikelihood
2 participants