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

Adds FittingProblem arg for model rebuild on evaluation, DFN examples and data-generation scripts #663

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented Feb 10, 2025

Description

Completes the following:

  • Adds an optional arg to FittingProblem for building on evaluation or not. The default is False which is a breaking change, but I believe it represents the fact that most parameters won't need rebuilding. This combines the build interface into a single class, and avoids sharp-edges using model.build standalone.
  • Creates initial synthetic data generation examples
    • Aligns our examples to better represent true PyBOP usage
    • Allows us to filter the model.predict output for discontinuities that occur from multi-step experiments (this currently causes large issues with the interpolated IDAKLU)
  • Adds DFN identification examples

Issue reference

Fixes #662

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 Feb 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.23%. Comparing base (828a8e3) to head (5281260).
Report is 3 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #663      +/-   ##
===========================================
- Coverage    99.27%   99.23%   -0.05%     
===========================================
  Files           64       66       +2     
  Lines         4813     4817       +4     
===========================================
+ Hits          4778     4780       +2     
- Misses          35       37       +2     

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

@BradyPlanden BradyPlanden changed the title Combines initial_state into FittingProblem, adds DFN examples and data-generation scripts Adds FittingProblem arg for model rebuild on evaluation, DFN examples and data-generation scripts Feb 10, 2025
# Conflicts:
#	CHANGELOG.md
#	examples/scripts/comparison_examples/adamw.py
#	examples/scripts/comparison_examples/irpropmin.py
#	examples/scripts/comparison_examples/maximum_likelihood.py
#	examples/scripts/getting_started/ask-tell-interface.py
#	pybop/optimisers/base_optimiser.py
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 DFN identification examples
1 participant