Replace old Gibbs sampler with the experimental one.

.JuliaFormatter.toml

@@ -6,9 +6,7 @@ import_to_using = false
 # These ignores should be removed once the relevant PRs are merged/closed.
 ignore = [
     # https://github.com/TuringLang/Turing.jl/pull/2231/files
-    "src/experimental/gibbs.jl",
     "src/mcmc/abstractmcmc.jl",
-    "test/experimental/gibbs.jl",
     "test/test_utils/numerical_tests.jl",
     # https://github.com/TuringLang/Turing.jl/pull/2218/files
     "src/mcmc/Inference.jl",

.github/workflows/Tests.yml

@@ -22,9 +22,8 @@ jobs:
           - "mcmc/hmc.jl"
           - "mcmc/abstractmcmc.jl"
           - "mcmc/Inference.jl"
-          - "experimental/gibbs.jl"
           - "mcmc/ess.jl"
-          - "--skip essential/ad.jl mcmc/gibbs.jl mcmc/hmc.jl mcmc/abstractmcmc.jl mcmc/Inference.jl experimental/gibbs.jl mcmc/ess.jl"
+          - "--skip essential/ad.jl mcmc/gibbs.jl mcmc/hmc.jl mcmc/abstractmcmc.jl mcmc/Inference.jl mcmc/ess.jl"
         version:
           - '1.7'
           - '1'
@@ -79,7 +78,7 @@ jobs:
       - uses: julia-actions/julia-buildpkg@v1
       # TODO: Use julia-actions/julia-runtest when test_args are supported
       # Custom calls of Pkg.test tend to miss features such as e.g. adjustments for CompatHelper PRs
-      # Ref https://github.com/julia-actions/julia-runtest/pull/73  
+      # Ref https://github.com/julia-actions/julia-runtest/pull/73
       - name: Call Pkg.test
         run: julia --color=yes --inline=yes --depwarn=yes --check-bounds=yes --threads=${{ matrix.num_threads }} --project=@. -e 'import Pkg; Pkg.test(; coverage=parse(Bool, ENV["COVERAGE"]), test_args=ARGS)' -- ${{ matrix.test-args }}
       - uses: julia-actions/julia-processcoverage@v1

HISTORY.md

@@ -1,3 +1,19 @@
+# Release 0.35.0
+
+## Breaking changes
+
+0.35.0 introduces a new Gibbs sampler. It's been included in several previous releases as `Turing.Experimental.Gibbs`, but now takes over the old Gibbs sampler, which gets removed completely.
+
+The new Gibbs sampler supports the same user-facing interface as the old one. However, given
+that the internals of it having been completely rewritten in a very different manner, there
+may be accidental breakage that we haven't anticipated. Please report any you find.
+
+`GibbsConditional` has also been removed. It was never very user-facing, but it was exported, so technically this is breaking.
+
+The old Gibbs constructor relied on being called with several subsamplers, and each of the constructors of the subsamplers would take as arguments the symbols for the variables that they are to sample, e.g. `Gibbs(HMC(:x), MH(:y))`. This constructor has been deprecated, and will be removed in the future. The new constructor works by assigning samplers to either symbols or `VarNames`, e.g. `Gibbs(; x=HMC(), y=MH())` or `Gibbs(@varname(x) => HMC(), @varname(y) => MH())`. This allows more granular specification of which sampler to use for which variable.
+
+Likewise, the old constructor for calling one subsampler more often than another, `Gibbs((HMC(:x), 2), (MH(:y), 1))` has been deprecated. The new way to achieve this effect is to list the same sampler multiple times, e.g. as `hmc = HMC(); mh = MH(); Gibbs(@varname(x) => hmc, @varname(x) => hmc, @varname(y) => mh)`.
+
 # Release 0.33.0
 
 ## Breaking changes

src/Turing.jl

@@ -55,7 +55,6 @@ using .Variational
 include("optimisation/Optimisation.jl")
 using .Optimisation
 
-include("experimental/Experimental.jl")
 include("deprecated.jl") # to be removed in the next minor version release
 
 ###########
@@ -86,7 +85,6 @@ export @model,                 # modelling
     Emcee,
     ESS,
     Gibbs,
-    GibbsConditional,
     HMC,                    # Hamiltonian-like sampling
     SGLD,
     SGHMC,