Move AD backends to standalone integration test suites

.github/workflows/CI.yml

@@ -6,6 +6,11 @@ on:
       - main
   pull_request:
 
+# needed to allow julia-actions/cache to delete old caches that it has created
+permissions:
+  actions: write
+  contents: read
+
 concurrency:
   # Skip intermediate builds: always.
   # Cancel intermediate builds: only if it is a pull request build.
@@ -14,6 +19,7 @@ concurrency:
 
 jobs:
   test:
+    name: ${{ matrix.group }} / Julia ${{ matrix.runner.version }} / ${{ matrix.runner.os }}
     runs-on: ${{ matrix.runner.os }}
     strategy:
       fail-fast: false
@@ -25,8 +31,6 @@ jobs:
             os: 'macos-latest'
           - version: '1'
             os: 'windows-latest'
-          - version: '1.11'
-            os: 'ubuntu-latest'
           - version: 'min'
             os: 'ubuntu-latest'
         group:

.github/workflows/Enzyme.yml

@@ -1,4 +1,4 @@
-name: Enzyme AD tests
+name: Enzyme
 
 on:
   push:
@@ -17,19 +17,33 @@ concurrency:
   cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
 
 jobs:
-  enzyme:
+  test:
+    name: Julia ${{ matrix.version }}
     runs-on: ubuntu-latest
+    # Enzyme is an integration test isolated from the main suite. It reports failures for
+    # visibility but does not block PRs: Enzyme regressions surface as red here without
+    # making the rest of the workflow fail.
+    continue-on-error: true
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - "min"
+          - "1"
     steps:
       - uses: actions/checkout@v6
 
       - uses: julia-actions/setup-julia@v3
         with:
-          version: "1.11"
+          version: ${{ matrix.version }}
 
       - uses: julia-actions/cache@v3
 
       - name: Run Enzyme tests
-        working-directory: test/integration/enzyme
+        working-directory: test/integration_tests/enzyme
+        # `Pkg.develop` makes Julia 1.10 use the working tree's Bijectors. The
+        # `[sources]` section in `Project.toml` only takes effect on Julia 1.11+,
+        # so on 1.10 the registry version would be resolved instead.
         run: |
-          julia --project=. --color=yes -e 'using Pkg; Pkg.instantiate()'
+          julia --project=. --color=yes -e 'using Pkg; Pkg.develop(PackageSpec(path="../../..")); Pkg.instantiate()'
           julia --project=. --color=yes main.jl

.github/workflows/Format.yml

@@ -15,7 +15,8 @@ concurrency:
   cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
 
 jobs:
-  format:
+  check:
+    name: runic
     runs-on: ubuntu-latest
 
     steps:

.github/workflows/Mooncake.yml

@@ -0,0 +1,45 @@
+name: Mooncake
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+# needed to allow julia-actions/cache to delete old caches that it has created
+permissions:
+  actions: write
+  contents: read
+
+# Cancel existing tests on the same PR if a new commit is added to a pull request
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  test:
+    name: Julia ${{ matrix.version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - "min"
+          - "1"
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: julia-actions/setup-julia@v3
+        with:
+          version: ${{ matrix.version }}
+
+      - uses: julia-actions/cache@v3
+
+      - name: Run Mooncake tests
+        working-directory: test/integration_tests/mooncake
+        # `Pkg.develop` makes Julia 1.10 use the working tree's Bijectors. The
+        # `[sources]` section in `Project.toml` only takes effect on Julia 1.11+,
+        # so on 1.10 the registry version would be resolved instead.
+        run: |
+          julia --project=. --color=yes -e 'using Pkg; Pkg.develop(PackageSpec(path="../../..")); Pkg.instantiate()'
+          julia --project=. --color=yes main.jl

.github/workflows/ReverseDiff.yml

@@ -0,0 +1,45 @@
+name: ReverseDiff
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+# needed to allow julia-actions/cache to delete old caches that it has created
+permissions:
+  actions: write
+  contents: read
+
+# Cancel existing tests on the same PR if a new commit is added to a pull request
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  test:
+    name: Julia ${{ matrix.version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - "min"
+          - "1"
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: julia-actions/setup-julia@v3
+        with:
+          version: ${{ matrix.version }}
+
+      - uses: julia-actions/cache@v3
+
+      - name: Run ReverseDiff tests
+        working-directory: test/integration_tests/reversediff
+        # `Pkg.develop` makes Julia 1.10 use the working tree's Bijectors. The
+        # `[sources]` section in `Project.toml` only takes effect on Julia 1.11+,
+        # so on 1.10 the registry version would be resolved instead.
+        run: |
+          julia --project=. --color=yes -e 'using Pkg; Pkg.develop(PackageSpec(path="../../..")); Pkg.instantiate()'
+          julia --project=. --color=yes main.jl

Project.toml

@@ -27,14 +27,12 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [weakdeps]
 ChainRules = "082447d4-558c-5d27-93f4-14fc19e9eca2"
-DistributionsAD = "ced4e74d-a319-5a8a-b0ac-84af2272839c"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
 LazyArrays = "5078a376-72f3-5289-bfd5-ec5146d43c02"
 Mooncake = "da2b9cff-9c12-43a0-ae48-6db2b0edb7d6"
 ReverseDiff = "37e2e3b7-166d-5795-8a7a-e32c996b4267"
 
 [extensions]
-BijectorsDistributionsADExt = "DistributionsAD"
 BijectorsForwardDiffExt = "ForwardDiff"
 BijectorsLazyArraysExt = "LazyArrays"
 BijectorsMooncakeExt = "Mooncake"
@@ -49,7 +47,6 @@ ChainRulesCore = "0.10.11, 1"
 ChangesOfVariables = "0.1"
 DifferentiationInterface = "0.7.14"
 Distributions = "0.25.33"
-DistributionsAD = "0.6"
 DocStringExtensions = "0.9"
 EnzymeCore = "0.8.15"
 FillArrays = "1"
@@ -69,7 +66,6 @@ Test = "1"
 julia = "1.10.8"
 
 [extras]
-DistributionsAD = "ced4e74d-a319-5a8a-b0ac-84af2272839c"
 EnzymeCore = "f151be2c-9106-41f4-ab19-57ee4f262869"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
 LazyArrays = "5078a376-72f3-5289-bfd5-ec5146d43c02"

docs/make.jl

@@ -20,5 +20,10 @@ makedocs(;
         "vector.md",
     ],
     checkdocs=:exports,
-    doctest=false,
+    doctest=true,
+    doctestfilters=[
+        # Ignore the source of a warning in the doctest output, since this is dependent
+        # on host. This is a line that starts with "└ @ " and ends with the line number.
+        r"└ @ .+:[0-9]+",
+    ],
 )

docs/src/vector.md

@@ -117,6 +117,7 @@ For more information about generally testing bijectors (and in particular how to
 
 One of the most tricky parts of testing Bijectors is ensuring that the transforms are compatible with automatic differentiation.
 This is important for DynamicPPL: we need to be able to compute the gradient of the log-density with respect to (possibly transformed) parameters, which may include the log-abs-det-Jacobian of the transformation.
-The default AD backends tested are ForwardDiff, ReverseDiff, Mooncake, and Enzyme.
+`test_all` accepts an `adtypes` keyword argument and defaults to `[AutoForwardDiff()]`, so the main test suite exercises ForwardDiff as the reference backend.
+ReverseDiff, Mooncake, and Enzyme are covered by standalone integration suites under `test/integration_tests/<backend>/`, each of which passes its own `adtypes` list through to `test_all`.
 It is acceptable to skip tests for a particular backend if there are genuine upstream bugs, especially with ReverseDiff, which is not actively maintained.
-However where possible it is best to ensure that all backends are supported, and to use `@test_broken` to mark any known issues with specific backends.
+Where possible it is best to ensure that all backends are supported, and to use `@test_broken` to mark any known issues with specific backends.