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

Add factory module for extra misfit terms #17

Merged
merged 8 commits into from
Aug 16, 2023
Merged

Add factory module for extra misfit terms #17

merged 8 commits into from
Aug 16, 2023

Conversation

keurfonluu
Copy link
Owner

  • Added: a new submodule evodcinv.factory to group commonly used extra misfit terms (e.g., regularization) (see Output models  #15).
  • Changed: no longer normalize misfit. This change is to get a "physical" meaning out of RMSE misfit when there are no input uncertainties (e.g., RMSE can be interpreted as average misfit in km/s when inverting dispersion curves). This change should slightly affect previous simulations (i.e., with the same seed).

Reminders:

  • Run invoke format to make sure the code follows the style guide,
  • Add tests for new features or tests that would have caught the bug that you're fixing,
  • Write detailed docstrings for all functions, classes and/or methods,
  • If adding new functionality, unit test it and add it to the documentation.

@codecov
Copy link

codecov bot commented Aug 16, 2023

Codecov Report

Patch coverage: 51.72% and project coverage change: -0.33% ⚠️

Comparison is base (a290e72) 53.03% compared to head (e490fe2) 52.70%.
Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #17      +/-   ##
==========================================
- Coverage   53.03%   52.70%   -0.33%     
==========================================
  Files          17       19       +2     
  Lines         643      666      +23     
==========================================
+ Hits          341      351      +10     
- Misses        302      315      +13     
Files Changed Coverage Δ
evodcinv/_progress.py 100.00% <ø> (ø)
evodcinv/_result.py 20.10% <0.00%> (-0.11%) ⬇️
tests/test_model.py 100.00% <ø> (ø)
evodcinv/factory/_extra_terms.py 38.88% <38.88%> (ø)
evodcinv/_curve.py 56.33% <50.00%> (-0.19%) ⬇️
evodcinv/__init__.py 100.00% <100.00%> (ø)
evodcinv/_model.py 74.25% <100.00%> (-0.13%) ⬇️
evodcinv/factory/__init__.py 100.00% <100.00%> (ø)

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

@keurfonluu keurfonluu merged commit 6af0a26 into master Aug 16, 2023
7 of 9 checks passed
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.

1 participant