Skip to content

Docs: explain AggregationLevel / problem types - #693

Merged
janosg merged 7 commits into
optimagic-dev:mainfrom
Pragati5-DEBUG:docs/aggregation-level-explanation
Aug 3, 2026
Merged

Docs: explain AggregationLevel / problem types#693
janosg merged 7 commits into
optimagic-dev:mainfrom
Pragati5-DEBUG:docs/aggregation-level-explanation

Conversation

@Pragati5-DEBUG

Copy link
Copy Markdown
Contributor

Summary

  • Adds an Explanation page for scalar, least-squares, and likelihood problem types (AggregationLevel)
  • Clarifies what each @om.mark.* decorator expects as a return value, and maximize vs minimize for likelihood
  • Links the new page from the “How to write objective functions” guide

Closes #595

Test plan

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov

codecov Bot commented Aug 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

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

Comment thread docs/source/explanation/aggregation_level.md Outdated
Comment thread docs/source/explanation/aggregation_level.md Outdated
Comment thread docs/source/explanation/aggregation_level.md Outdated
Pragati5-DEBUG and others added 2 commits August 2, 2026 22:09
Clarify that all marked problems can use scalar optimizers, and link
error-handling and estimagic docs.
@Pragati5-DEBUG
Pragati5-DEBUG requested a review from janosg August 2, 2026 16:42
Comment thread docs/source/explanation/aggregation_level.md Outdated
@Pragati5-DEBUG
Pragati5-DEBUG requested a review from janosg August 2, 2026 17:59
Comment thread docs/source/explanation/aggregation_level.md Outdated

@janosg janosg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for the PR. I made one tiny change and will merge it soon.

@janosg
janosg merged commit cb05d04 into optimagic-dev:main Aug 3, 2026
20 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.

Docs: Explain problem types (AggregationLevel) in the docs

2 participants