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

Set minimising for each cost and make a property of BaseOptimiser only #588

Merged
merged 12 commits into from
Dec 18, 2024

Conversation

NicolaCourtier
Copy link
Member

@NicolaCourtier NicolaCourtier commented Dec 9, 2024

Description

To prevent against future hard-to-find errors in maximising (rather than) minimising cost functions, set the minimising option for each cost and make it a property of BaseOptimiser only. Save the (transformed) search parameters in the log alongside the model parameters.

Issue reference

Fixes #561

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 Dec 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.22%. Comparing base (c8b00e6) to head (9f08982).
Report is 42 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #588      +/-   ##
===========================================
+ Coverage    99.08%   99.22%   +0.14%     
===========================================
  Files           52       58       +6     
  Lines         3605     4267     +662     
===========================================
+ Hits          3572     4234     +662     
  Misses          33       33              

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

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 @NicolaCourtier - this is looking good, a few suggestions. I think it's an improvement over what we have at the moment :)

pybop/optimisers/base_optimiser.py Outdated Show resolved Hide resolved
pybop/optimisers/base_optimiser.py Show resolved Hide resolved
pybop/optimisers/base_optimiser.py Outdated Show resolved Hide resolved
pybop/optimisers/base_optimiser.py Outdated Show resolved Hide resolved
pybop/costs/base_cost.py Outdated Show resolved Hide resolved
@NicolaCourtier NicolaCourtier changed the title Apply the minimising option in BaseOptimiser Set minimising for each cost and make a property of BaseOptimiser only Dec 17, 2024
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.

Looks good, thanks @NicolaCourtier! Two small suggestions.

pybop/costs/base_cost.py Outdated Show resolved Hide resolved
pybop/costs/base_cost.py Outdated Show resolved Hide resolved
@NicolaCourtier NicolaCourtier merged commit ebc15e2 into develop Dec 18, 2024
31 checks passed
@NicolaCourtier NicolaCourtier deleted the 561b-minimising-refactor branch December 18, 2024 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants