Linear Verbosity Specifiers by jClugstor · Pull Request #1049 · SciML/SciMLBase.jl

jClugstor · 2025-06-05T16:21:25Z

Checklist

Appropriate tests were added
Any code changes were done in a way that does not break public API
All documentation related to code changes were updated
The new code follows the
contributor guidelines, in particular the SciML Style Guide and
COLPRAC.
Any new documentation only uses public API

Additional context

This contains just the things necessary to use the verbosity system with LinearSolve, so we can test things out and make sure that this meets the requirements for the verbosity system.

A Moshi.jl ADT is used for the base verbosity specifiers. LinearVerbosity holds a LinearErrorControlVerbosity, a LinearPerformanceVerbosity, and a LinearNumericalVerbosity. The @SciMLMessage macro takes a String or a function that returns a String, a verbosity object, a symbol representing the base toggle, and a symbol representing what group the message belongs to.

using SciMLBase
using SciMLBase: Verbosity


verbose = SciMLBase.LinearVerbosity(default_lu_fallback=Verbosity.Warn())

SciMLBase.@SciMLMessage("LU factorization failed, switching to QR factorization", verbose, :default_lu_fallback, :error_control)


verbose = SciMLBase.LinearVerbosity(numerical = Verbosity.Info())

SciMLBase.@SciMLMessage("Using IterativeSolvers", verbose, :using_IterativeSolvers, :numerical)


error_verb = SciMLBase.LinearErrorControlVerbosity(Verbosity.Info())

verbose = SciMLBase.LinearVerbosity(error_control = error_verb)

SciMLBase.@SciMLMessage("LU factorization failed, switching to QR factorization", verbose, :default_lu_fallback, :error_control)


x = 10
y = 20

SciMLBase.@SciMLMessage(verbose, :default_lu_fallback, :error_control) do 
    z = x + y
    "z is $z."
end

jClugstor · 2025-06-11T20:10:43Z

@ChrisRackauckas this is the PR with the types and constructors for LinearVerbosity, along with the @SciMLMessage macro. This stuff is used in SciML/LinearSolve.jl#622

ChrisRackauckas · 2025-06-20T09:59:09Z

@@ -0,0 +1,298 @@
+@data Verbosity begin


what is this macro? It's not standard, namespace it.

ChrisRackauckas · 2025-06-20T09:59:31Z

+linear_defaults = Dict(
+    :default_lu_fallback => Verbosity.Warn(),
+    :no_right_preconditioning => Verbosity.Warn(),
+    :using_iterative_solvers => Verbosity.Warn(),
+    :using_IterativeSolvers => Verbosity.Warn(),
+    :IterativeSolvers_iterations => Verbosity.Warn(),
+    :KrylovKit_verbosity => Verbosity.Warn(),
+    :KrylovJL_verbosity => Verbosity.None()
+)


This should live in LinearSolve

ChrisRackauckas · 2025-06-20T10:00:24Z

+mutable struct LinearPerformanceVerbosity
+    no_right_preconditioning::Verbosity.Type
+
+    function LinearPerformanceVerbosity(;
+            no_right_preconditioning = linear_defaults[:no_right_preconditioning])
+        new(no_right_preconditioning)
+    end
+
+    function LinearPerformanceVerbosity(verbose::Verbosity.Type)
+        @match verbose begin
+            Verbosity.None() => new(fill(
+                Verbosity.None(), length(fieldnames(LinearPerformanceVerbosity)))...)
+
+            Verbosity.Info() => new(fill(
+                Verbosity.Info(), length(fieldnames(LinearPerformanceVerbosity)))...)
+
+            Verbosity.Warn() => new(fill(
+                Verbosity.Warn(), length(fieldnames(LinearPerformanceVerbosity)))...)
+
+            Verbosity.Error() => new(fill(
+                Verbosity.Error(), length(fieldnames(LinearPerformanceVerbosity)))...)
+
+            Verbosity.Default() => LinearPerformanceVerbosity()
+
+            Verbosity.Edge() => LinearPerformanceVerbosity()
+
+            _ => @error "Not a valid choice for verbosity."
+        end
+    end
+
+end
+
+mutable struct LinearNumericalVerbosity
+    using_IterativeSolvers::Verbosity.Type
+    IterativeSolvers_iterations::Verbosity.Type
+    KrylovKit_verbosity::Verbosity.Type
+    KrylovJL_verbosity::Verbosity.Type
+
+    function LinearNumericalVerbosity(;
+            using_IterativeSolvers = linear_defaults[:using_IterativeSolvers],
+            IterativeSolvers_iterations = linear_defaults[:IterativeSolvers_iterations],
+            KrylovKit_verbosity = linear_defaults[:KrylovKit_verbosity],
+            KrylovJL_verbosity = linear_defaults[:KrylovJL_verbosity])
+        new(using_IterativeSolvers, IterativeSolvers_iterations, KrylovKit_verbosity, KrylovJL_verbosity)
+    end
+
+    function LinearNumericalVerbosity(verbose::Verbosity.Type)
+        @match verbose begin
+            Verbosity.None() => new(fill(
+                Verbosity.None(), length(fieldnames(LinearNumericalVerbosity)))...)
+
+            Verbosity.Info() => new(fill(
+                Verbosity.Info(), length(fieldnames(LinearNumericalVerbosity)))...)
+
+            Verbosity.Warn() => new(fill(
+                Verbosity.Warn(), length(fieldnames(LinearNumericalVerbosity)))...)
+
+            Verbosity.Error() => new(fill(
+                Verbosity.Error(), length(fieldnames(LinearNumericalVerbosity)))...)
+
+            Verbosity.Default() => LinearNumericalVerbosity()
+
+            Verbosity.Edge() => LinearNumericalVerbosity()
+
+            _ => @error "Not a valid choice for verbosity."
+        end
+    end
+end
+
+
+
+struct LinearVerbosity{T} <: AbstractVerbositySpecifier{T}
+    error_control::LinearErrorControlVerbosity
+    performance::LinearPerformanceVerbosity
+    numerical::LinearNumericalVerbosity
+end
+
+function LinearVerbosity(verbose::Verbosity.Type)
+    @match verbose begin
+        Verbosity.Default() => LinearVerbosity{true}(
+            LinearErrorControlVerbosity(Verbosity.Default()),
+            LinearPerformanceVerbosity(Verbosity.Default()),
+            LinearNumericalVerbosity(Verbosity.Default())
+        )
+
+        Verbosity.None() => LinearVerbosity{false}(
+            LinearErrorControlVerbosity(Verbosity.None()),
+            LinearPerformanceVerbosity(Verbosity.None()),
+            LinearNumericalVerbosity(Verbosity.None()))
+
+        Verbosity.All() => LinearVerbosity{true}(
+            LinearErrorControlVerbosity(Verbosity.Info()),
+            LinearPerformanceVerbosity(Verbosity.Info()),
+            LinearNumericalVerbosity(Verbosity.Info())
+        )
+
+        _ => @error "Not a valid choice for LinearVerbosity. Available choices are `Default`, `None`, and `All`."
+    end
+end
+
+function LinearVerbosity(;
+        error_control = Verbosity.Default(), performance = Verbosity.Default(),
+        numerical = Verbosity.Default(), kwargs...)
+    if error_control isa Verbosity.Type
+        error_control_verbosity = LinearErrorControlVerbosity(error_control)
+    else
+        error_control_verbosity = error_control
+    end
+
+    if performance isa Verbosity.Type
+        performance_verbosity = LinearPerformanceVerbosity(performance)
+    else
+        performance_verbosity = performance
+    end
+
+    if numerical isa Verbosity.Type
+        numerical_verbosity = LinearNumericalVerbosity(numerical)
+    else
+        numerical_verbosity = numerical
+    end
+
+    if !isempty(kwargs)
+        for (key, value) in pairs(kwargs)
+            if hasfield(LinearErrorControlVerbosity, key)
+                setproperty!(error_control_verbosity, key, value)
+            elseif hasfield(LinearPerformanceVerbosity, key)
+                setproperty!(performance_verbosity, key, value)
+            elseif hasfield(LinearNumericalVerbosity, key)
+                setproperty!(numerical_verbosity, key, value)
+            else
+                error("$key is not a recognized verbosity toggle.")
+            end
+        end
+    end
+
+    LinearVerbosity{true}(error_control_verbosity,
+        performance_verbosity, numerical_verbosity)
+end


All of this should go to linearsolve since it will be edited alongside the code

AayushSabharwal

It would be nice if this can be moved to something like SciMLVerbosity.jl so

packages not depending on SciMLBase can use this
we can version it independently and break the API if we need to

I'd really like to use this in MTK and possibly Symbolics.

AayushSabharwal · 2025-06-25T11:57:49Z

+    group = getproperty(verbose, group)
+    opt_level = getproperty(group, option)


Does this mean every AbstractVerbositySpecifier has to have exactly 2 levels of nesting?

Yes but this can definitely be changed to be more flexible.

AayushSabharwal · 2025-06-25T11:58:37Z

+end
+
+function emit_message(
+        f::Function, verbose::V, option, group, file, line,


What if we don't type this as ::Function, so that any callable can go here?

Yeah that makes sense.

AayushSabharwal · 2025-06-25T12:00:30Z

+    level = message_level(
+        verbose, option, group)
+    if !isnothing(level)
+        message = f()


Can we pass the option and group here? This allows for the function to have side effects at specific locations. My main use case is hooking into Infiltrator.jl.

I think what we could do is have a 'Code' verbosity type that holds a quote, and we can modify the '@SciMLMessage' macro to evaluate the quote when called. That way you can just set one of the toggles of the verbosity object to 'Code(:Main.@infiltrate)' and it will infiltrate whenever it hits the part of the code associated with the toggle.

I'm pretty sure runtime eval doesn't have access to local function scope, which means @infiltrate won't really do anything useful.

I probably used the wrong words, but I think if I write the macro correctly it should have the same access as surrounding code. Anyways the details can be worked out when I get back on Monday 🙂

Sure, sounds good.

jClugstor mentioned this pull request Jun 5, 2025

Use verbosity system SciML/LinearSolve.jl#622

Merged

5 tasks

jClugstor added 7 commits June 9, 2025 13:26

add linear verbosity stuff

84978db

add to SciMLBase

72bf843

add defaults

8d4ff8a

add AbstractVerbositySpecifier

f69d5d3

move to inner constructors so they can use new

91a421b

update error message

3373aaf

add group to macro, add simple logger

233818c

jClugstor force-pushed the linear_verbosity branch from 37a20d3 to 233818c Compare June 9, 2025 17:26

add KrylovJL verbosity setting

c2b2ad8

ChrisRackauckas reviewed Jun 20, 2025

View reviewed changes

AayushSabharwal reviewed Jun 25, 2025

View reviewed changes

jClugstor closed this Aug 13, 2025

		group = getproperty(verbose, group)
		opt_level = getproperty(group, option)

Uh oh!

Uh oh!

Conversation

jClugstor commented Jun 5, 2025

Checklist

Additional context

Uh oh!

jClugstor commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AayushSabharwal left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jClugstor commented Jun 11, 2025 •

edited

Loading

AayushSabharwal left a comment •

edited

Loading