Add creating_a_problem example #487
Conversation
Added an example for how to create a problem. The example builds up on the creating_a_model example.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #487 +/- ##
========================================
Coverage 99.04% 99.04%
========================================
Files 52 52
Lines 3545 3545
========================================
Hits 3511 3511
Misses 34 34 ☔ View full report in Codecov by Sentry. |
|
Excellent, thanks for this @f-g-r-i-m-m! I'll take a further look over the next day or so. |
There was a problem hiding this comment.
Thanks for this addition @f-g-r-i-m-m, it's coming along well. A few suggestions and comments to address from my side.
| "metadata": {}, | ||
| "source": [ | ||
| "### Testing the problem\n", | ||
| "To verify our problem, we solve assign a sum of squared error cost function to it and solve it. \n", |
There was a problem hiding this comment.
I would first show how to use the problem.evaluate() and problem.evaluateS1 methods.
| "metadata": {}, | ||
| "source": [ | ||
| "### Setting up the problem\n", | ||
| "With all parts setup, we can now make a problem. Therefore, we use pybop.FittingProblem() to define a simple fitting problem and the model, parameters and dataset defined before as inputs." |
There was a problem hiding this comment.
Can you also expand this to include the pybop.DesignProblem? I think we can reduce the cost / optimisation side of this and focus on the two problem classes more.
| "source": [ | ||
| "## Creating a Problem\n", | ||
| "\n", | ||
| "In this notebook, we create and solve a single particle model (SPM). This is achieved using a predefined parameter set introduced in Marquis et al. [[1]](https://doi.org/10.1149/1945-7111/abbce4) \n", |
There was a problem hiding this comment.
Needs an update to introduce the problem class and it's functionality.
changed the timeframe of the simulation Co-authored-by: Brady Planden <[email protected]>
Co-authored-by: Brady Planden <[email protected]>
Co-authored-by: Brady Planden <[email protected]>
Description
added the creating_a_problem example. This example builds up on the creating_a_model example.
Type of change
Key checklist:
$ 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)$ nox -s tests$ nox -s doctestYou can run integration tests, unit tests, and doctests together at once, using
$ nox -s quick.Further checks:
Thank you for contributing to our project! Your efforts help us to deliver great software.