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

Renames model.rebuild variables, updates import structure, adds type-hints to BaseModel #315

Merged
merged 11 commits into from
Jun 6, 2024

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented May 7, 2024

Description

  1. Renames model.matched_parameters -> model.rebuild_parameters and model.non_matched_parameters -> model.standard_parameters for better user comprehension. The previous model.rebuild_parameters is likewise renamed to model.geometric_parameters
  2. Updates the import structure to avoid circular references when adding type-hints and reduces class imports.
  3. Adds type-hints to BaseModel where possible
  4. Moves the _handle_special_cases() method into ECM to remove circular reference
  5. Adds setitem and getitem to pybop.ParameterSet

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.

Copy link

codecov bot commented May 7, 2024

Codecov Report

Attention: Patch coverage is 98.58156% with 2 lines in your changes missing coverage. Please review.

Project coverage is 97.07%. Comparing base (ce1cb54) to head (1020428).
Report is 605 commits behind head on develop.

Files with missing lines Patch % Lines
pybop/_dataset.py 75.00% 1 Missing ⚠️
pybop/parameters/parameter_set.py 88.88% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #315      +/-   ##
===========================================
- Coverage    97.20%   97.07%   -0.13%     
===========================================
  Files           45       41       -4     
  Lines         2612     2328     -284     
===========================================
- Hits          2539     2260     -279     
+ Misses          73       68       -5     

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

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 @BradyPlanden, great to see all the type hints! I think we can now update parameters from Dict to Parameters type.

@BradyPlanden BradyPlanden merged commit f32c383 into develop Jun 6, 2024
29 checks passed
@BradyPlanden BradyPlanden deleted the model-rebuild-parameters-refactor branch June 6, 2024 08:49
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.

2 participants