Skip to content

docs: use SciMLLogging.None() instead of verbose=false (OrdinaryDiffEq v7)#131

Merged
ChrisRackauckas merged 1 commit into
SciML:mainfrom
ChrisRackauckas-Claude:fix-docs-verbose-v7
Jun 20, 2026
Merged

docs: use SciMLLogging.None() instead of verbose=false (OrdinaryDiffEq v7)#131
ChrisRackauckas merged 1 commit into
SciML:mainfrom
ChrisRackauckas-Claude:fix-docs-verbose-v7

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Contributor

Problem

The Documentation build on main is red. The @example blocks in docs/src/nnblock.md and docs/src/symbolic_ude_tutorial.md pass verbose = false (a Bool) to solve. OrdinaryDiffEq v7 no longer accepts a Bool for verbose:

ArgumentError: Passing a `Bool` for `verbose` is no longer supported in OrdinaryDiffEq v7.
Use `DEVerbosity()` or a preset like `Standard()`, `None()`, etc. from SciMLLogging.

This caused failed to run @example block errors at nnblock.md:208-292 and symbolic_ude_tutorial.md:74-83, which then cascaded into UndefVarErrors (new_sol1, opt_sol, oprob_fitted) in downstream blocks and terminated the build ([:example_block]).

Fix

verbose = false means "suppress all solver output", which maps to the SciMLLogging.None() preset (per DiffEqBase, _process_verbose_param(::Val{false}) resolves to DEVerbosity(SciMLLogging.None())). This PR:

  • Adds SciMLLogging (compat "2") to docs/Project.toml (resolves to the same v2.0.0 already in the docs Manifest, no other resolution changes).
  • Replaces verbose = false with verbose = SciMLLogging.None() in both tutorials, and adds import SciMLLogging to the relevant example modules.

Verification (local, Julia 1.10 / docs env)

  • Confirmed solve(prob, Tsit5(); verbose = SciMLLogging.None()) returns retcode = Success, while verbose = false still throws the ArgumentError.
  • Ran julia --project=docs docs/make.jl: the build now evaluates the nnblock.md potplate block (previously the first failure) with zero ArgumentError/failed to run/UndefVarError markers, and proceeds into the subsequent new_sol1 and equation_search blocks. (The local run was OOM-killed at the memory-heavy SymbolicRegression block on a heavily-loaded shared machine; this is unrelated to the docs error and will not occur on CI runners.)
  • Independently reproduced the symbolic_ude_tutorial.md loss-block solve call with verbose = SciMLLogging.None(): retcode = Success.

Note

There is a separate, pre-existing, platform-specific failure on the tests / All (julia lts, macos-latest) job only: @test res2.objective < 1.5e-4 evaluates to 0.000270... < 0.00015 on macOS aarch64 LTS. It passes on ubuntu/windows for both lts and 1. This is optimizer-convergence noise (LBFGS/Adam landing in a slightly worse local minimum due to aarch64 BLAS/LAPACK differences) and is intentionally not touched here — loosening that tolerance would risk masking a real regression on other platforms. Out of scope for this PR.

Please ignore until reviewed by @ChrisRackauckas

…ryDiffEq v7

OrdinaryDiffEq v7 no longer accepts a `Bool` for the `verbose` keyword of
`solve`; passing one throws

    ArgumentError: Passing a `Bool` for `verbose` is no longer supported in
    OrdinaryDiffEq v7. Use `DEVerbosity()` or a preset like `Standard()`,
    `None()`, etc. from SciMLLogging.

This broke the `@example` blocks in `nnblock.md` and `symbolic_ude_tutorial.md`
(and cascaded into `UndefVarError`s for `new_sol1`, `opt_sol`, `oprob_fitted`),
failing the Documentation build on `main`.

`verbose = false` means "suppress all solver output", which maps to the
`SciMLLogging.None()` preset. Add `SciMLLogging` (v2) as a docs dependency and
use `verbose = SciMLLogging.None()` in both tutorials.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@ChrisRackauckas ChrisRackauckas marked this pull request as ready for review June 20, 2026 11:06
@ChrisRackauckas ChrisRackauckas merged commit 8fad852 into SciML:main Jun 20, 2026
4 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.

2 participants