docs: make the permutation_init doctests deterministic (drop the duplicate docs workflow) - #542
Merged
ChrisRackauckas merged 3 commits intoSep 22, 2026
Conversation
This repo had complete docs sources but no docs CI. Standard reusable workflow call including the token permissions the reusable requires. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Agent-Harness: OpenCode Agent-Model: muse-spark-1.3-contributor-free Agent-Session: local session at /home/crackauc/sandbox/tmp_20260917_040834_91074 (no public conversation URL)
ChrisRackauckas
marked this pull request as ready for review
September 17, 2026 18:03
These doctests printed random permutations, passing only by luck of global RNG state (explicit seeds still differ across environments for this call path). Assert shape, nonzero count, and value multiset instead, matching the style of the adjacent weights example. Verified: full local docs build passes with 0 failures. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Agent-Harness: OpenCode Agent-Model: muse-spark-1.3-contributor-free Agent-Session: local session at /home/crackauc/sandbox/tmp_20260917_040834_91074 (no public conversation URL)
ChrisRackauckas-Claude
force-pushed
the
docs/fix-doctests-and-ci
branch
from
September 17, 2026 18:12
bab001d to
f5f88c6
Compare
ReservoirComputing already builds its documentation on a self-hosted GPU runner: the `gpu-docs` job in `.github/workflows/GPU.yml`, whose workflow is literally named "GPU Documentation", `runs-on: [self-hosted, Linux, X64, gpu]`. That job is green on master, so there is no docs build to repair and a second workflow on `ubuntu-latest` would only deploy the same site twice. Keep the deterministic-doctest fix: `permutation_init` returns a randomly permuted matrix and the old `jldoctest` printed it, so the expected output depended on the draw. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Agent-Harness: OpenCode Agent-Model: muse-spark-1.3-contributor-free Agent-Session: local session at /home/crackauc/sandbox/tmp_20260917_040834_91074 (no public conversation URL)
ChrisRackauckas
added a commit
that referenced
this pull request
Sep 23, 2026
Ships the deterministic permutation_init doctests and the removal of the duplicate docs workflow (#542). Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Claude <noreply@anthropic.com> Agent-Harness: Claude Code 2.1.273 Agent-Model: claude-opus-5[1m] Agent-Session: 6a01e420-3436-4518-83cc-6cd853283cfb (local transcript; this harness publishes no conversation URL)
ChrisRackauckas
added a commit
that referenced
this pull request
Sep 23, 2026
Ships the deterministic permutation_init doctests and the removal of the duplicate docs workflow (#542). Agent-Harness: Claude Code 2.1.273 Agent-Model: claude-opus-5[1m] Agent-Session: 6a01e420-3436-4518-83cc-6cd853283cfb (local transcript; this harness publishes no conversation URL) Co-authored-by: Claude <noreply@anthropic.com>
5 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Please ignore until reviewed by @ChrisRackauckas.
What changed and why
permutation_initreturns a randomly permuted matrix, but twojldoctestblocks in thepermutation_initdocstring printed that matrix, so the expected output depended on the draw. They now assert the structure instead:Correction: an earlier revision of this PR also added a
.github/workflows/Documentation.ymlbuilt onubuntu-latest. That was wrong and has been removed. ReservoirComputing already builds its documentation on a self-hosted GPU runner — thegpu-docsjob in.github/workflows/GPU.yml, whose workflow is literally named "GPU Documentation",runs-on: [self-hosted, Linux, X64, gpu]— and that job is green onmaster, so there was no docs build to repair.Verification
master's GPU docs job is green: run https://github.com/SciML/ReservoirComputing.jl/actions/runs/35146312301 →Documentation=success.grep -rl 'docs/make.jl' .github/workflowsmatches onlyGPU.ymlafter this change.Not verified
🤖 Generated with OpenCode (model: muse-spark-1.3-contributor-free); no public session URL (local session at /home/crackauc/sandbox/tmp_20260917_040834_91074).