Skip to content

docs: document solver-specific statistics in solve_problems - #186

Merged
tmigot merged 5 commits into
JuliaSmoothOptimizers:mainfrom
arnavk23:main
Nov 16, 2025
Merged

tmigot merged 5 commits into
JuliaSmoothOptimizers:mainfrom
arnavk23:main

Conversation

@arnavk23

@arnavk23 arnavk23 commented Oct 30, 2025 •

Copy link
Copy Markdown
Contributor

Added a "Solver-specific statistics" section to the solve_problems docstring in run_solver.jl. The new text explains how entries in s.solver_specific are handled:

  • scalar (non-vector) entries become additional DataFrame columns;
  • vector-valued entries are ignored for column creation;
  • columns are created when the first successful run returns those keys;
  • skipped or exception rows are filled with missing for solver-specific columns;
  • how to set solver-specific values from a solver (e.g. via callbacks and set_solver_specific!), with tests/examples already exercising the behavior.

Fixes #152

@arnavk23

Copy link
Copy Markdown
Contributor Author

@tmigot please review this pr.

@tmigot tmigot 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.

I don't think we need to know all that, only that solver_specific is taken into accounts and columns are created for those.

We should try to be as concise as possible here, and maybe move this next to coltitle.

@arnavk23
arnavk23 requested a review from tmigot October 30, 2025 11:47
Comment thread src/run_solver.jl Outdated
Co-authored-by: Tangi Migot <tangi.migot@gmail.com>
@arnavk23
arnavk23 requested a review from tmigot November 6, 2025 03:48
@arnavk23

Copy link
Copy Markdown
Contributor Author

@tmigot I think we can merge this now.

Comment thread src/run_solver.jl Outdated
@codecov

codecov Bot commented Nov 16, 2025 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.52%. Comparing base (4c0fcd2) to head (2609f5e).
⚠️ Report is 29 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #186      +/-   ##
==========================================
+ Coverage   76.71%   85.52%   +8.80%     
==========================================
  Files          12       10       -2     
  Lines         292      297       +5     
==========================================
+ Hits          224      254      +30     
+ Misses         68       43      -25     

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

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

@tmigot
tmigot merged commit 3571b13 into JuliaSmoothOptimizers:main Nov 16, 2025
9 of 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.

Add documentation on solver_specific in benchmark

2 participants