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

Unified entry point for models and parameter sets #4490

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

santacodes
Copy link
Member

@santacodes santacodes commented Oct 4, 2024

Description

Modified the existing parameter_sets API and unified entry points to accommodate model entry points. This is an extension of the existing model entry points in the pybamm-cookie project. Relevant discussion.

Fixes # (issue)

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

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 tests pass: $ python run-tests.py --all (or $ nox -s tests)
  • The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Copy link

codecov bot commented Oct 4, 2024

Codecov Report

Attention: Patch coverage is 92.98246% with 4 lines in your changes missing coverage. Please review.

Project coverage is 98.69%. Comparing base (6ad2495) to head (cc496d7).

Files with missing lines Patch % Lines
src/pybamm/dispatch/entry_points.py 92.59% 4 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4490      +/-   ##
===========================================
- Coverage    98.71%   98.69%   -0.02%     
===========================================
  Files          304      305       +1     
  Lines        23509    23530      +21     
===========================================
+ Hits         23207    23224      +17     
- Misses         302      306       +4     

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

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@arjxn-py arjxn-py left a comment

Choose a reason for hiding this comment

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

Good start @santacodes, looks like this is still a WIP? Still I have commented just a tip hoping it'd make sense.

There are some conflicts that you may want to resolve and also feel free to add [WIP] prefix to your PR title while you're on it.

@santacodes santacodes changed the title Unified entry point for models and parameter sets [WIP] Unified entry point for models and parameter sets Oct 11, 2024
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@santacodes santacodes changed the title [WIP] Unified entry point for models and parameter sets Unified entry point for models and parameter sets Nov 10, 2024
@kratman
Copy link
Contributor

kratman commented Jan 8, 2025

@santacodes Are you still working on this?

@santacodes
Copy link
Member Author

@santacodes Are you still working on this?

Yes I am, it has yet to be reviewed, I will update this branch and request a review again.

@santacodes santacodes force-pushed the modelentrypoints branch 3 times, most recently from f06b1a1 to b662073 Compare March 7, 2025 06:36
@santacodes santacodes closed this Mar 7, 2025
@santacodes santacodes reopened this Mar 7, 2025
@santacodes
Copy link
Member Author

Resolving merge conflicts on my branch was causing a lot of problems and it was staging a lot of files that weren't modified by me during the merge for some reason, anyway it was a small change so I manually wrote a patch file and applied the patch after resetting this branch so the history is gone. This PR still needs a review to get it merged, and this PR is directly related to - pybamm-team/pybamm.org#258 so it might be good if we have a base entry points API before the GSoC timeline.

@santacodes
Copy link
Member Author

Bumping this @valentinsulzer @agriyakhetarpal @arjxn-py as I cannot request a re-review

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.

5 participants