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

Additions to #473 #488

Merged
merged 2 commits into from
Sep 10, 2024
Merged

Conversation

BradyPlanden
Copy link
Member

Description

This PR:

  • Removes the try-except for BaseCost.__call__ for improved error messages.
  • Adds apply_transform as an optional arg to BaseCost.__call__ for symmetry with the parameters class, as well as improved debugging / interaction.
  • Moves Optimiser.cost_call logic into BaseCost.__call_ to remove duplicate logic/code
  • Updates PintsOptimiser.f

Issue reference

Fixes #473

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 Sep 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (473-fix-transformations@83c3621). Learn more about missing BASE report.

Additional details and impacted files
@@                    Coverage Diff                     @@
##             473-fix-transformations     #488   +/-   ##
==========================================================
  Coverage                           ?   99.04%           
==========================================================
  Files                              ?       52           
  Lines                              ?     3564           
  Branches                           ?        0           
==========================================================
  Hits                               ?     3530           
  Misses                             ?       34           
  Partials                           ?        0           

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

Copy link
Contributor

@martinjrobins martinjrobins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great :) only one (rather picky) suggestion:

pybop/costs/base_cost.py Outdated Show resolved Hide resolved
@martinjrobins
Copy link
Contributor

I’ll wait for the tests 😊

@martinjrobins martinjrobins merged commit 0273bee into 473-fix-transformations Sep 10, 2024
31 checks passed
@martinjrobins martinjrobins deleted the 473b-fix-transformations branch September 10, 2024 07:53
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.

2 participants