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

Mark ES_MDA as recommended algorithm #9771

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

berland
Copy link
Contributor

@berland berland commented Jan 16, 2025

Issue
Resolves #9739'

Approach
Modify description(), and use a newline character to get formatting right. This newline might look bad elsewhere if this string is in other places than the GUI

recommended

  • PR title captures the intent of the changes, and is fitting for release notes.
  • Added appropriate release note label
  • Commit history is consistent and clean, in line with the contribution guidelines.
  • Make sure unit tests pass locally after every commit (git rebase -i main --exec 'pytest tests/ert/unit_tests -n logical -m "not integration_test"')

When applicable

  • When there are user facing changes: Updated documentation
  • New behavior or changes to existing untested code: Ensured that unit tests are added (See Ground Rules).
  • Large PR: Prepare changes in small commits for more convenient review
  • Bug fix: Add regression test for the bug
  • Bug fix: Create Backport PR to latest release

Copy link

codspeed-hq bot commented Jan 16, 2025

CodSpeed Performance Report

Merging #9771 will degrade performances by 10.57%

Comparing berland:rec_esmda (f29bb04) with main (945e198)

Summary

❌ 1 regressions
✅ 23 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark main berland:rec_esmda Change
test_direct_dark_performance_with_storage[gen_x: 20, sum_x: 20 reals: 10-gen_data-get_record_observations] 1.3 ms 1.5 ms -10.57%

@eivindjahren eivindjahren requested a review from sondreso January 16, 2025 09:56
@eivindjahren eivindjahren added the release-notes:user-impact Automatically categorise as breaking for people using CLI/GUI label Jan 16, 2025
@berland berland self-assigned this Jan 16, 2025
@andreas-el
Copy link
Contributor

This definitely solves the issue at hand.
Question is, should we emphasise this in the title?

Multiple Data Assimilation - [Recommended]

or something similar?

Copy link
Collaborator

@sondreso sondreso left a comment

Choose a reason for hiding this comment

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

I would prefer having the recommended marking in the title, but I think the deprecation is fine to have in the description.

@berland
Copy link
Contributor Author

berland commented Jan 17, 2025

rec

Copy link
Collaborator

@sondreso sondreso left a comment

Choose a reason for hiding this comment

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

Nice ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-notes:user-impact Automatically categorise as breaking for people using CLI/GUI
Projects
Status: Reviewed
Development

Successfully merging this pull request may close these issues.

Mark ES-MDA as recommended
4 participants