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 OptimisationResult class, adds finite cost check for identified parameters #527

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented Oct 1, 2024

Description

  • Refactors the BaseOptimisers result method,
  • Adds finite cost check on optimisation results
  • Creates a breaking change for optim.run() as the returned object is now the class object

Issue reference

Fixes #526

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.

…n() object return, adds isfinite() check on optimisation results
@BradyPlanden BradyPlanden linked an issue Oct 1, 2024 that may be closed by this pull request
Copy link

codecov bot commented Oct 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.08%. Comparing base (101f9ce) to head (c8b00e6).
Report is 75 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #527      +/-   ##
===========================================
+ Coverage    99.05%   99.08%   +0.02%     
===========================================
  Files           52       52              
  Lines         3604     3605       +1     
===========================================
+ Hits          3570     3572       +2     
+ Misses          34       33       -1     

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

@BradyPlanden BradyPlanden force-pushed the 526-add-optimisation-check-for-non-finite-cost-parameter-value branch from bac2447 to a966997 Compare October 4, 2024 09:10
@BradyPlanden BradyPlanden added ask This PR needs a review for merging show This PR will be merged without review and removed ask This PR needs a review for merging labels Oct 11, 2024
@BradyPlanden BradyPlanden merged commit 7d57304 into develop Oct 11, 2024
31 checks passed
@BradyPlanden BradyPlanden deleted the 526-add-optimisation-check-for-non-finite-cost-parameter-value branch October 11, 2024 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
show This PR will be merged without review
Projects
None yet
1 participant