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

Updates README, adds additional notebooks, bugfixes to model.simulateS1 #293

Merged

Conversation

BradyPlanden
Copy link
Member

Description

This PR updates the README to the current state of the project with example links and supported methods. It also adds the following notebooks:

  • Multi-model parameter identification comparison
  • PyBOP optimiser comparison
  • Gradient descent learning rate calibration

Finally, it fixes an bug within the model.simulateS1 method which returned the wrong object type when the forward model failed.

Issue reference

Fixes #288

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.

@BradyPlanden BradyPlanden linked an issue Apr 14, 2024 that may be closed by this pull request
Copy link

codecov bot commented Apr 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.49%. Comparing base (f0246fd) to head (0273723).
Report is 28 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #293   +/-   ##
========================================
  Coverage    95.49%   95.49%           
========================================
  Files           38       38           
  Lines         2040     2040           
========================================
  Hits          1948     1948           
  Misses          92       92           

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

Copy link
Member

@NicolaCourtier NicolaCourtier 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!

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@BradyPlanden BradyPlanden merged commit b5da435 into develop Apr 22, 2024
28 checks passed
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 IntelLiGent EU Project as funding contributor
2 participants