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

Issue/134/interfaces #135

Merged
merged 5 commits into from
Jul 26, 2024
Merged

Issue/134/interfaces #135

merged 5 commits into from
Jul 26, 2024

Conversation

eacharles
Copy link
Collaborator

Problem & Solution Description (including issue #)

Code Quality

  • My code follows the code style of this project
  • I have written unit tests or justified all instances of #pragma: no cover; in the case of a bugfix, a new test that breaks as a result of the bug has been added
  • My code contains relevant comments and necessary documentation for future maintainers; the change is reflected in applicable demos/tutorials (with output cleared!) and added/updated docstrings use the NumPy docstring format
  • Any breaking changes, described above, are accompanied by backwards compatibility and deprecation warnings

@eacharles eacharles requested a review from ztq1996 July 25, 2024 17:47
@eacharles eacharles marked this pull request as ready for review July 25, 2024 17:47
@ztq1996
Copy link
Contributor

ztq1996 commented Jul 26, 2024

Looks good overall, just a small change and a question:

  1. "evaluate_single_pz" should be "estimate_single_pz"
  2. Question: Maybe this is obvious, but since there is no variable stored in the PZ_factory, what is the difference between this and just defining the functions without a class? i.e., build_estimate_stage() method will return a stage, run_estiamte_stage() will run the estimate method and return a qp ensemble, etc. Sorry if this is just not feasible

@eacharles
Copy link
Collaborator Author

As discussed the only reason I made a class was to have someone clean to cache prebuilt stages in case someone wanted to reuse them, e.g., in a service that was providing p(z) estimates...

Copy link

codecov bot commented Jul 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.18%. Comparing base (7d9f0f2) to head (3641325).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #135      +/-   ##
==========================================
+ Coverage   98.14%   98.18%   +0.04%     
==========================================
  Files          39       41       +2     
  Lines        2049     2095      +46     
==========================================
+ Hits         2011     2057      +46     
  Misses         38       38              

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

@eacharles eacharles merged commit 284a4bd into main Jul 26, 2024
6 checks passed
@eacharles eacharles deleted the issue/134/interfaces branch July 26, 2024 22:47
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