Skip to content

Adds Minkowski and SumofPower Cost#383

Merged
BradyPlanden merged 30 commits into
developfrom
minkowski-cost
Jul 15, 2024
Merged

Adds Minkowski and SumofPower Cost#383
BradyPlanden merged 30 commits into
developfrom
minkowski-cost

Conversation

@BradyPlanden

Copy link
Copy Markdown
Member

Description

This PR adds an implementation of Minkowski Loss, with tests and example usage.

Issue reference

Fixes #382

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.

@codecov

codecov Bot commented Jul 1, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.02%. Comparing base (bd3d59b) to head (f06dd4a).
Report is 651 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #383      +/-   ##
===========================================
+ Coverage    97.88%   98.02%   +0.14%     
===========================================
  Files           43       43              
  Lines         2598     2632      +34     
===========================================
+ Hits          2543     2580      +37     
+ Misses          55       52       -3     

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

Comment thread examples/scripts/spm_AdamW.py Outdated
Comment thread examples/scripts/spm_CMAES.py Outdated
Comment thread pybop/costs/fitting_costs.py Outdated
Comment thread pybop/costs/fitting_costs.py Outdated
Comment thread pybop/costs/_likelihoods.py Outdated
Comment thread pybop/costs/fitting_costs.py Outdated
Comment thread pybop/costs/fitting_costs.py Outdated

@NicolaCourtier NicolaCourtier left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hi @BradyPlanden, a few comments for you to go through, but overall it's looking good. I'll just upload some minor edits to the text of the example notebook.

Comment thread CHANGELOG.md Outdated
Comment thread pybop/costs/_likelihoods.py Outdated
Comment thread pybop/costs/base_cost.py Outdated
Comment thread pybop/costs/base_cost.py Outdated
Comment thread pybop/costs/base_cost.py Outdated
Comment thread pybop/costs/base_cost.py Outdated
Comment thread pybop/costs/base_cost.py Outdated
Comment thread pybop/costs/base_cost.py
Comment thread pybop/costs/fitting_costs.py
Comment thread pybop/parameters/parameter.py Outdated

@NicolaCourtier NicolaCourtier left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Great, thanks @BradyPlanden !

@BradyPlanden BradyPlanden merged commit ca170c8 into develop Jul 15, 2024
@BradyPlanden BradyPlanden deleted the minkowski-cost branch July 15, 2024 14:35
@BradyPlanden BradyPlanden changed the title Adds Minkowski Cost Adds Minkowski and SumofPower Cost Jul 15, 2024
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 Minkowski Loss

2 participants