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

Refactor optimisation args #551

Merged
merged 5 commits into from
Nov 15, 2024
Merged

Refactor optimisation args #551

merged 5 commits into from
Nov 15, 2024

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented Nov 11, 2024

Description

  • Moves common Pints' optimisation keys from kwargs to optional args for improved autocomplete and IDE highlighting
  • Args max_iterations and population_size to default args across optimisers, with maxiter and popsize only available on SciPy based optimisers
  • BasePintsOptimiser.pints_optimiser renamed to BasePintsOptimiser.optimiser
  • Improves docstrings for optimiser classes

Issue reference

Fixes # (issue-number)

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.

…al args, aligns maxiter and popsize to standardised name
Copy link

codecov bot commented Nov 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.14%. Comparing base (c8b00e6) to head (4667641).
Report is 14 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #551      +/-   ##
===========================================
+ Coverage    99.08%   99.14%   +0.05%     
===========================================
  Files           52       55       +3     
  Lines         3605     3848     +243     
===========================================
+ Hits          3572     3815     +243     
  Misses          33       33              

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

@BradyPlanden BradyPlanden added the show This PR will be merged without review label Nov 11, 2024
@BradyPlanden
Copy link
Member Author

Marked as 'show', but would appreciate your input @NicolaCourtier.

@BradyPlanden BradyPlanden merged commit 3fe0c1d into develop Nov 15, 2024
31 checks passed
@BradyPlanden BradyPlanden deleted the refactor-optimiser-args branch November 15, 2024 09:16
BradyPlanden added a commit that referenced this pull request Nov 15, 2024
@BradyPlanden BradyPlanden mentioned this pull request Nov 15, 2024
15 tasks
BradyPlanden added a commit that referenced this pull request Nov 25, 2024
* refactor: moves common Pints' optimisation keys from kwargs to optional args, aligns maxiter and popsize to standardised name

* fix: benchmarks, coverage

fix: benchmarks

* fix: attribute selection in Optimisation class

* adds changelog entry
BradyPlanden added a commit that referenced this pull request Dec 4, 2024
* refactor: moves common Pints' optimisation keys from kwargs to optional args, aligns maxiter and popsize to standardised name

* fix: benchmarks, coverage

fix: benchmarks

* fix: attribute selection in Optimisation class

* adds changelog entry
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
Development

Successfully merging this pull request may close these issues.

1 participant