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

Fix transformations #474

Merged
merged 21 commits into from
Sep 10, 2024
Merged

Fix transformations #474

merged 21 commits into from
Sep 10, 2024

Conversation

NicolaCourtier
Copy link
Member

@NicolaCourtier NicolaCourtier commented Aug 23, 2024

Description

Move the cost evaluation error catches to BaseOptimiser, add log_update() and fix inconsistencies in the application of transformations.

Issue reference

Fixes #473

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.

Copy link

codecov bot commented Aug 23, 2024

Codecov Report

Attention: Patch coverage is 98.90110% with 1 line in your changes missing coverage. Please review.

Project coverage is 99.04%. Comparing base (76de36a) to head (a4384e5).
Report is 19 commits behind head on develop.

Files with missing lines Patch % Lines
pybop/optimisers/base_pints_optimiser.py 92.85% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #474   +/-   ##
========================================
  Coverage    99.04%   99.04%           
========================================
  Files           52       52           
  Lines         3545     3546    +1     
========================================
+ Hits          3511     3512    +1     
  Misses          34       34           

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

@NicolaCourtier NicolaCourtier marked this pull request as ready for review August 23, 2024 19:22
Copy link
Member

@BradyPlanden BradyPlanden left a comment

Choose a reason for hiding this comment

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

Thanks for the updates @NicolaCourtier! The transformation changes look good, I have a few comments on the change from applying transformations within the cost class to optimisation class.

pybop/costs/base_cost.py Show resolved Hide resolved
pybop/optimisers/base_optimiser.py Outdated Show resolved Hide resolved
pybop/optimisers/base_optimiser.py Show resolved Hide resolved
@NicolaCourtier NicolaCourtier added the release blocker Needs to be closed before a new release can be deployed label Sep 2, 2024
@NicolaCourtier
Copy link
Member Author

I would recommend keeping properties, such as transformations, attached to a single base class for modularity (to reduce the chance of errors and unexpected behaviour). In this case, I think BaseOptimiser is conceptually the correct place for transformations.

@BradyPlanden BradyPlanden merged commit 1c6073d into develop Sep 10, 2024
28 of 29 checks passed
@BradyPlanden BradyPlanden deleted the 473-fix-transformations branch September 10, 2024 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release blocker Needs to be closed before a new release can be deployed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Inconsistencies in transformations
3 participants