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 optimization algorithms section in the documentation for the theory chapter #9698

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

roliveira
Copy link
Collaborator

@roliveira roliveira commented Jan 9, 2025

This section includes the description and main differences between conmin_mfd and optpp_q_newton, both available through Dakota. The section was also cross-referenced in the backend section.

Credit goes to @olwijn for initially developing the document.

Issue
Resolves #9697

Approach
Added optimization_algorithms.rst section, updated the index.rst to include below the Theory chapter, and cross-referenced it from within the optimization_backend.rst section.

  • 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

@roliveira roliveira force-pushed the 9697-adding-section-on-constrainted-optimization-algorithms branch from 3c40fa0 to 93326ea Compare January 9, 2025 14:39
Copy link

codspeed-hq bot commented Jan 9, 2025

CodSpeed Performance Report

Merging #9698 will not alter performance

Comparing roliveira:9697-adding-section-on-constrainted-optimization-algorithms (2bbae26) with main (94439f5)

Summary

✅ 24 untouched benchmarks

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.74%. Comparing base (3b745a6) to head (93326ea).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9698      +/-   ##
==========================================
+ Coverage   91.71%   91.74%   +0.02%     
==========================================
  Files         426      426              
  Lines       26538    26538              
==========================================
+ Hits        24340    24346       +6     
+ Misses       2198     2192       -6     
Flag Coverage Δ
cli-tests 39.65% <ø> (ø)
everest-models-test 34.15% <ø> (-0.01%) ⬇️
gui-tests 74.32% <ø> (ø)
integration-test 37.99% <ø> (+<0.01%) ⬆️
performance-tests 51.58% <ø> (-0.01%) ⬇️
test 39.52% <ø> (+<0.01%) ⬆️
unit-tests 74.24% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@roliveira roliveira self-assigned this Jan 10, 2025
@roliveira roliveira added the release-notes:documentation PR with only changes to documentation label Jan 10, 2025
Copy link
Collaborator Author

@roliveira roliveira left a comment

Choose a reason for hiding this comment

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

Thanks for picking this up, I have now added the suggestions above.

This section includes the description and main differences between conmin_mfd and optpp_q_newton, both available through Dakota.
The section was also cross-referenced in the backend section.
@roliveira roliveira force-pushed the 9697-adding-section-on-constrainted-optimization-algorithms branch from 5fbd7c4 to 2bbae26 Compare January 13, 2025 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-notes:documentation PR with only changes to documentation
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

Adding section on Constrainted Optimization Algorithms
3 participants