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

Adds cuckoo optimiser #319

Merged
merged 15 commits into from
Jul 5, 2024
Merged

Adds cuckoo optimiser #319

merged 15 commits into from
Jul 5, 2024

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented May 9, 2024

Description

This PR adds a cuckoo search implementation and corresponding tests.

Issue reference

Fixes #307

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

codecov bot commented May 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.78%. Comparing base (cea297f) to head (86a297a).
Report is 760 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #319      +/-   ##
===========================================
+ Coverage    97.76%   97.78%   +0.02%     
===========================================
  Files           42       43       +1     
  Lines         2458     2574     +116     
===========================================
+ Hits          2403     2517     +114     
- Misses          55       57       +2     

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

@BradyPlanden BradyPlanden changed the base branch from develop to gauss-log-like-fixes June 7, 2024 09:16
pybop/optimisers/_cuckoo.py Outdated Show resolved Hide resolved
pybop/optimisers/_cuckoo.py Outdated Show resolved Hide resolved
pybop/optimisers/_cuckoo.py Outdated Show resolved Hide resolved
pybop/optimisers/_cuckoo.py Outdated Show resolved Hide resolved
pybop/optimisers/_cuckoo.py Outdated Show resolved Hide resolved
pybop/optimisers/pints_optimisers.py Outdated Show resolved Hide resolved
pybop/optimisers/pints_optimisers.py Outdated Show resolved Hide resolved
pybop/optimisers/pints_optimisers.py Outdated Show resolved Hide resolved
Base automatically changed from gauss-log-like-fixes to develop July 5, 2024 12:14
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 to me, don't forget to update the Changelog!

@BradyPlanden BradyPlanden merged commit 59e2ce1 into develop Jul 5, 2024
2 of 3 checks passed
@BradyPlanden BradyPlanden deleted the 307-add-cuckoo-optimiser branch July 5, 2024 13:09
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 cuckoo optimiser
2 participants