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

Add check to CMAES and make XNES default optimiser #253

Merged
merged 4 commits into from
Mar 27, 2024

Conversation

NicolaCourtier
Copy link
Member

@NicolaCourtier NicolaCourtier commented Mar 22, 2024

Description

Only CMAES appears to be restricted to optimising multiple parameters at a time. This suggests that we should change the default optimiser away from CMAES.

Issue reference

Fixes #91.

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.
  • 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 docs

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.

@NicolaCourtier NicolaCourtier linked an issue Mar 22, 2024 that may be closed by this pull request
@NicolaCourtier
Copy link
Member Author

I'm open to discussion on which optimiser to set as default, but the restriction on CMAES to multiple parameter optimisation problems only seems to rule it out from being the most user-friendly option!

Copy link

codecov bot commented Mar 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.14%. Comparing base (133af44) to head (34d2e24).
Report is 3 commits behind head on develop.

❗ Current head 34d2e24 differs from pull request most recent head 2359be2. Consider uploading reports for the commit 2359be2 to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #253      +/-   ##
===========================================
- Coverage    95.33%   95.14%   -0.20%     
===========================================
  Files           36       36              
  Lines         1971     1996      +25     
===========================================
+ Hits          1879     1899      +20     
- Misses          92       97       +5     

☔ 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 for the addition @NicolaCourtier. I agree, CMAES is probably not the most robust default. In the future, we may want differing defaults dependant on the dimensionality of the problem.

I took a quick look at the benchmarks and XNES appears to be the fastest pints optimiser for the two parameter problem, so another checkmark moving forward.

I've added a small tweak to be more explicit in the ValueError, happy to merge either way.

pybop/optimisers/pints_optimisers.py Outdated Show resolved Hide resolved
tests/unit/test_optimisation.py Outdated Show resolved Hide resolved
NicolaCourtier and others added 2 commits March 25, 2024 16:25
Co-authored-by: Brady Planden <55357039+BradyPlanden@users.noreply.github.com>
@NicolaCourtier NicolaCourtier merged commit 7b500e4 into develop Mar 27, 2024
29 checks passed
@NicolaCourtier NicolaCourtier deleted the 91-CMAES-restriction branch March 27, 2024 20:01
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.

Add tests for single parameter fitting / optimisation
2 participants