Add debug logger for solvers #1620

upsj · 2024-05-31T13:05:07Z

This debug logger prints out the value of all scalars inside the solver after each iteration:

Here we see the output of the simple-solver example with the logger running

gko::solver::Cg<double>::apply(0x124f04b60,0x124f04f00) of dimensions (19, 19) and 1 rhs
       Iteration           alpha            beta        prev_rho             rho
               0               0               0               1              19
               1               0             765       5.3109419              19
               2               0       151.51792       5.3109419       2.1541599
               3               0       56.610294      0.96997901       2.1541599
               4               0        22.91651      0.96997901      0.55031615
               5               0       13.637587      0.26380868      0.55031615
               6               0       5.8524907      0.26380868      0.14758275
               7               0       3.2949066      0.10013392      0.14758275
               8               0       2.3026212      0.10013392     0.051851311
               9               0       1.1447493     0.029006197     0.051851311
              10               0      0.64935163     0.029006197    0.0094813452
              11               0      0.22821574    0.0038048001    0.0094813452
              12               0     0.075631164    0.0038048001    0.0020622776
              13               0     0.047698364     0.001020997    0.0020622776
              14               0     0.023026955     0.001020997   0.00026116441
              15               0    0.0072957469   4.3166892e-05   0.00026116441
              16               0   0.00078229883   4.3166892e-05   6.9889839e-06
              17               0   0.00017981764   7.3755266e-07   6.9889839e-06
              18               0   1.9199351e-05   7.3755266e-07   8.2060081e-08
              19               0   1.9866215e-06   8.9249994e-28   8.2060081e-08

Should be useful for debugging #1563

include/ginkgo/core/log/solver_debug.hpp

upsj · 2024-05-31T13:10:17Z

Also relevant for investigating #1026 (which is where this idea came up originally)

upsj · 2024-05-31T13:21:36Z

Wondering about the name here - it might make sense to also have a version that stores all scalars and intermediate vectors in files - should it be SolverDebugPrint or similar?

tcojean

Some comments.

Also, to clarify, this would not give very helpful output with Gmres right, due to the nature of its "scalars" (in relation with krylov_dim most of the time)?

I think in general, having a version that stores output to files/json/wherever, in particular for vector cases would be really helpful as a general solution.

include/ginkgo/core/log/solver_debug.hpp

core/log/solver_debug.cpp

upsj · 2024-06-07T13:00:56Z

@tcojean There is now a printing and a storing variant + tests

MarcelKoch

I think the naming needs to be updated, and the internal dispatch in the scalar printer.

include/ginkgo/core/log/solver_debug.hpp

MarcelKoch · 2024-06-13T14:47:15Z

include/ginkgo/core/log/solver_debug.hpp

+ * solver after each iteration. If the solver is applied to multiple right-hand
+ * sides, only the first right-hand side gets printed.
+ */
+class SolverDebug : public Logger {


I think the name is not great. Maybe SolverStatePrinter, but that is also not great. I'm struggling a bit to find a more suitable name.

Pinging this again, I'm still unhappy with the name. It's rather non-descriptive, so users will have no idea what this is doing just from the name.

How would you describe what this logger is used for? My first thought was "It's for debugging solvers", so the name made sense. But from a user perspective, it's maybe slightly unintuitive. OTOH, will users need to use this regularly?

It's for debugging solvers in a very specific sense, by printing the internal state after every iteration. That can be reflected in the name. Just 'debug' can mean anything and nothing.
Regarding usage: it could also be used to achieve the same thing as in #1517, so perhaps users will use it for that.

How about SolverProgress?

TBH, I kinda warmed up to my first suggestion. SolverProgress could easily be understood to mean just the residual norm, so I think referencing the state might be useful.

include/ginkgo/core/log/solver_debug.hpp

core/log/solver_debug.cpp

core/test/log/solver_debug.cpp

fritzgoebel

This looks very useful!
LGTM

include/ginkgo/core/log/solver_debug.hpp

MarcelKoch

LGTM, except the name.

core/log/solver_debug.cpp

MarcelKoch · 2024-07-04T12:06:34Z

include/ginkgo/core/log/solver_debug.hpp

+ * solver after each iteration. If the solver is applied to multiple right-hand
+ * sides, only the first right-hand side gets printed.
+ */
+class SolverDebug : public Logger {


Pinging this again, I'm still unhappy with the name. It's rather non-descriptive, so users will have no idea what this is doing just from the name.

thoasm · 2024-07-04T12:43:36Z

Here are some alternative suggestions:

SolverIntricaciesLogger
SolverDetailsLogger
SolverNuancesLogger
SolverBreakdownLogger

Co-authored-by: Marcel Koch <marcel.koch@kit.edu>

sonarcloud · 2024-07-05T23:48:38Z

Quality Gate passed

Issues
12 New issues
0 Accepted issues

Measures
0 Security Hotspots
80.6% Coverage on New Code
9.6% Duplication on New Code

See analysis details on SonarCloud

upsj added the 1:ST:ready-for-review This PR is ready for review label May 31, 2024

upsj requested a review from a team May 31, 2024 13:05

upsj self-assigned this May 31, 2024

ginkgo-bot added reg:build This is related to the build system. reg:testing This is related to testing. mod:core This is related to the core module. labels May 31, 2024

upsj commented May 31, 2024

View reviewed changes

include/ginkgo/core/log/solver_debug.hpp Outdated Show resolved Hide resolved

tcojean reviewed May 31, 2024

View reviewed changes

include/ginkgo/core/log/solver_debug.hpp Outdated Show resolved Hide resolved

core/log/solver_debug.cpp Outdated Show resolved Hide resolved

MarcelKoch requested changes Jun 14, 2024

View reviewed changes

fritzgoebel approved these changes Jul 3, 2024

View reviewed changes

include/ginkgo/core/log/solver_debug.hpp Outdated Show resolved Hide resolved

upsj force-pushed the solver_debug_logger branch 3 times, most recently from a1dd3da to 88bbd77 Compare July 4, 2024 11:33

upsj requested a review from MarcelKoch July 4, 2024 11:37

MarcelKoch requested changes Jul 4, 2024

View reviewed changes

upsj and others added 9 commits July 5, 2024 13:11

add debug logger for solvers

c2523ec

add missing includes

82729e4

add file and csv output loggers

a0b6e31

improve naming and documentation

778e133

clean uninitialized values from comparison

639aab4

remove unused scalars

fb62e50

clean up and simplify code

921d430

simplify condition

1aa7547

Co-authored-by: Marcel Koch <marcel.koch@kit.edu>

Rename solver_debug to solver_progress

f7827bf

upsj force-pushed the solver_debug_logger branch from 90b6188 to f7827bf Compare July 5, 2024 11:12

upsj requested a review from MarcelKoch July 5, 2024 11:12

MarcelKoch approved these changes Jul 5, 2024

View reviewed changes

upsj added 1:ST:ready-to-merge This PR is ready to merge. and removed 1:ST:ready-for-review This PR is ready for review labels Jul 5, 2024

upsj merged commit 89a9c0e into develop Jul 5, 2024
12 of 14 checks passed

upsj deleted the solver_debug_logger branch July 5, 2024 16:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add debug logger for solvers #1620

Add debug logger for solvers #1620

upsj commented May 31, 2024

upsj commented May 31, 2024

upsj commented May 31, 2024

tcojean left a comment

upsj commented Jun 7, 2024

MarcelKoch left a comment

MarcelKoch Jun 13, 2024

MarcelKoch Jul 4, 2024

upsj Jul 4, 2024

MarcelKoch Jul 4, 2024

upsj Jul 4, 2024

MarcelKoch Jul 4, 2024

fritzgoebel left a comment

MarcelKoch left a comment

MarcelKoch Jul 4, 2024

thoasm commented Jul 4, 2024 •

edited

Loading

sonarcloud bot commented Jul 5, 2024

Add debug logger for solvers #1620

Add debug logger for solvers #1620

Conversation

upsj commented May 31, 2024

upsj commented May 31, 2024

upsj commented May 31, 2024

tcojean left a comment

Choose a reason for hiding this comment

upsj commented Jun 7, 2024

MarcelKoch left a comment

Choose a reason for hiding this comment

MarcelKoch Jun 13, 2024

Choose a reason for hiding this comment

MarcelKoch Jul 4, 2024

Choose a reason for hiding this comment

upsj Jul 4, 2024

Choose a reason for hiding this comment

MarcelKoch Jul 4, 2024

Choose a reason for hiding this comment

upsj Jul 4, 2024

Choose a reason for hiding this comment

MarcelKoch Jul 4, 2024

Choose a reason for hiding this comment

fritzgoebel left a comment

Choose a reason for hiding this comment

MarcelKoch left a comment

Choose a reason for hiding this comment

MarcelKoch Jul 4, 2024

Choose a reason for hiding this comment

thoasm commented Jul 4, 2024 • edited Loading

sonarcloud bot commented Jul 5, 2024

Quality Gate passed

thoasm commented Jul 4, 2024 •

edited

Loading