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

Refactors BaseCost.evaluate/S1 into BaseCost.compute #455

Conversation

BradyPlanden
Copy link
Member

Description

This PR refactors BaseCost.evaluate/S1 & BaseCost._evaluate/S1 into BaseCost.__call__ and BaseCost.compute. BaseCost.compute directly acts on the predictions, while BaseCost.__call__ calls BaseProblem.evaluate/S1 before BaseCost.compute. Fully separates __call__ and compute for FittingCosts, Likelihoods. This PR also has bugfixes to GaussianLogLikelihood calculation.

Issue reference

Fixes #435

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 Aug 9, 2024 that may be closed by this pull request
Copy link

codecov bot commented Aug 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.69%. Comparing base (9ce312e) to head (ebc0446).
Report is 466 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #455      +/-   ##
===========================================
- Coverage    98.71%   98.69%   -0.02%     
===========================================
  Files           47       47              
  Lines         3025     2985      -40     
===========================================
- Hits          2986     2946      -40     
  Misses          39       39              

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


🚨 Try these New Features:

…hods-to-accept-precomputed-signals

# Conflicts:
#	CHANGELOG.md
…hods-to-accept-precomputed-signals

# Conflicts:
#	CHANGELOG.md
#	tests/integration/test_spm_parameterisations.py
@BradyPlanden
Copy link
Member Author

BradyPlanden commented Aug 15, 2024

Project coverage fails because this PR removes a large amount of code, but the number of missed line hits remains the same. All good for review.

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.

I'm going to remove the inputs argument from compute() to avoid the possibility of users passing parameters which do not match those used to make the prediction. Other than that, only a couple of minor comments and we should be good to merge.

CHANGELOG.md Outdated Show resolved Hide resolved
tests/unit/test_cost.py Outdated Show resolved Hide resolved
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.

Thanks for these improvements!

@BradyPlanden BradyPlanden merged commit 8cada6f into develop Aug 20, 2024
29 of 31 checks passed
@BradyPlanden BradyPlanden deleted the 436-refactor-cost_evaluate-methods-to-accept-precomputed-signals branch August 20, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Refactor cost._evaluate methods to accept precomputed signals
2 participants