Skip to content

Clarify Sophia package in Optimisers docs - #1396

Merged
ChrisRackauckas merged 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:docs/optimisers-sophia
Oct 4, 2026
Merged

ChrisRackauckas merged 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:docs/optimisers-sophia

Conversation

@ChrisRackauckas-Claude

@ChrisRackauckas-Claude ChrisRackauckas-Claude commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

The optimisers.md page now attributes Sophia to the OptimizationSophia.jl package and links to its documentation page. This corrects the package attribution while keeping the algorithms page navigation direct.

Verification

  • typos docs/src/optimization_packages/optimisers.md — exit 0, no findings.
  • git diff --check — exit 0, no findings.
  • julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' — exit 0; 753 dependencies successfully precompiled in 1659 seconds. 26 already precompiled. Precompile output included ModelingToolkitBase @nospecialize warnings and MicroMamba/CondaPkg artifact-download notices.
  • julia --project=docs docs/make.jl — failed on the existing docs/src/optimization_packages/pycma.md:24-34 example with Python: ModuleNotFoundError: No module named 'cma'. The final error was makedocs encountered an error [:example_block] -- terminating build before rendering. The build reached cross-reference and document checks; those reported only redirects for the BlackBoxOptim and MadNLP GitHub URLs. This is the same unrelated local docs-build blocker recorded in the pre-change check results.

Not verified

  • A clean full docs build, because the Python cma module is unavailable in this environment.
  • CI results; the draft has not run in GitHub Actions yet.

Please ignore this draft until reviewed by @ChrisRackauckas.

Risk assessment

  • Risk: low
  • Blast radius: One documentation sentence and an intra-doc link; no code or public API changes.
  • Evidence: typos and git diff --check passed. The docs build reached cross-reference checks but stopped on the existing PyCMA Python dependency error.
  • Independent review: pending
  • Merge: needs human review because the independent review and CI are pending.

🤖 Generated with Codex CLI 0.160.0 (model: gpt-6-luna). Transcript: /home/crackauc/sandbox/goals/qa-hygiene/jobs/optimisers-fixes/log.txt

Risk assessment

  • Risk: low
  • Blast radius: Documentation only. The PR replaces one sentence in docs/src/optimization_packages/optimisers.md with an @ref sophia link. That anchor exists in docs/src/optimization_packages/sophia.md as # [OptimizationSophia.jl](@id sophia), and the Documentation CI build passed with it. No code, public API, tests or dependencies change. The new sentence is accurate: a code search finds Sophia only under lib/OptimizationSophia, not in lib/OptimizationOptimisers, so the old text saying OptimizationOptimisers "also provides" Sophia was out of date.
  • Evidence: On head 166299fb, Documentation, Runic, runic-suggestions, Typos, DiffEqFlux.jl/All and NeuralPDE.jl/NNPDE1 pass. Two IntegrationTest jobs fail, and both are pre-existing, not regressions:
    • NeuralPDE.jl/NNPDE2 fails with EnzymeRuntimeActivityError at integrals.jl:202 (26 pass, 1 error). The same job fails the same way on master bda578c7 (run 37108468945), and also fails on 0cd7ee90, ab327ac0 and c3c0bdb4.
    • ModelingToolkit.jl/Optimization fails with Unsatisfiable requirements detected for package TimerOutputs. The same error appears on master bda578c7. That job also fails on 0cd7ee90 and c3c0bdb4, and was cancelled on ab327ac0.
    • The PR has no review comments and one approval, from SebastianM-C on the head commit.
    • The PR description is out of date: it says "CI results; the draft has not run in GitHub Actions yet", but CI has run. It also blames the local docs failure on the PyCMA cma module, while the CI docs build passes. Neither affects risk.
  • Independent review: Devin CLI (Mac) / fusion-claude-opus-5-5-high-sidekick-swe-2-medium rated it low, high confidence: it is a one-line docs change, the link target exists and builds, and both failing checks fail identically on recent master commits.
  • Merge: auto-merge candidate

🤖 Risk assessment posted by an AI agent (fleet master) — harness: Devin CLI (Mac) / fusion-claude-opus-5-5-high-sidekick-swe-2-medium; dispatched by Devin CLI 3000.11.3 (Mac) fleet-master caretaker, model Fusion (claude-opus-5-5 medium + swe-2 medium)
Conversation: local transcript ~/.local/share/devin/cli/transcripts/speckle-whale.json (Chris's Mac)

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Codex <noreply@openai.com>
Agent-Harness: Codex CLI 0.160.0
Agent-Model: gpt-6-luna
Agent-Session: local session, transcript at /home/crackauc/sandbox/goals/qa-hygiene/jobs/optimisers-fixes/log.txt on amdci2
@ChrisRackauckas
ChrisRackauckas marked this pull request as ready for review October 4, 2026 14:20
@ChrisRackauckas
ChrisRackauckas merged commit 46f1f47 into SciML:master Oct 4, 2026
6 of 8 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.

3 participants