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.

Sign up for GitHub

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

Jump to bottom

Include PyBaMM solution in OptimizationResult #573

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

Include PyBaMM solution in OptimizationResult #573

wants to merge 2 commits into from

Conversation

pipliggins
Copy link

Description

Saves the latest pybamm solution object into a Problem class, to add into an OptimisationResult.

Issue reference

Fixes #548

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.

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.

@codecov Codecov
Copy link

codecov bot commented Dec 2, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.15%. Comparing base (c8b00e6) to head (6adcabd).
Report is 25 commits behind head on develop.

Additional details and impacted files 
@@             Coverage Diff             @@
##           develop     #573      +/-   ##
===========================================
+ Coverage    99.08%   99.15%   +0.07%     
===========================================
  Files           52       56       +4     
  Lines         3605     3913     +308     
===========================================
+ Hits          3572     3880     +308     
  Misses          33       33

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

@BradyPlanden
Copy link
Member

This is looking great - thanks @pipliggins! To ensure the pybamm solution matches the optimal parameter values, I would consider updating the code to run the forward model with the "x_best" values. The final optimisation position "should" be close to the found optimal, but there are cases where this doesn't occur (e.g. poorly tuned gradient-based methods, or population based optimisers that are exploring the search space in batches).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Include PyBaMM solution in OptimisationResult
2 participants
@pipliggins @BradyPlanden