remove initial_parameters from kwargs in multi-chain functions

Author: shravanngoswamii

src/sample.jl

@@ -121,6 +121,11 @@ function mcmcsample(
     initial_state=nothing,
     kwargs...,
 )
+    # Warn if initial_parameters is passed instead of initial_params
+    if haskey(kwargs, :initial_parameters)
+        @warn "The `initial_parameters` keyword argument is not recognised; please use `initial_params` instead."
+    end
+
     # Check the number of requested samples.
     N > 0 || error("the number of samples must be ≥ 1")
     discard_initial >= 0 ||
@@ -408,6 +413,8 @@ function mcmcsample(
     # Warn if initial_parameters is passed instead of initial_params
     if haskey(kwargs, :initial_parameters)
         @warn "The `initial_parameters` keyword argument is not recognised; please use `initial_params` instead."
+        # Remove initial_parameters from kwargs to prevent it from being passed to single-chain sample
+        kwargs = pairs((; (k => v for (k, v) in pairs(kwargs) if k !== :initial_parameters)...))
     end
 
     # Check if actually multiple threads are used.
@@ -596,6 +603,8 @@ function mcmcsample(
     # Warn if initial_parameters is passed instead of initial_params
     if haskey(kwargs, :initial_parameters)
         @warn "The `initial_parameters` keyword argument is not recognised; please use `initial_params` instead."
+        # Remove initial_parameters from kwargs to prevent it from being passed to single-chain sample
+        kwargs = pairs((; (k => v for (k, v) in pairs(kwargs) if k !== :initial_parameters)...))
     end
 
     # Check if actually multiple processes are used.
@@ -740,6 +749,8 @@ function mcmcsample(
     # Warn if initial_parameters is passed instead of initial_params
     if haskey(kwargs, :initial_parameters)
         @warn "The `initial_parameters` keyword argument is not recognised; please use `initial_params` instead."
+        # Remove initial_parameters from kwargs to prevent it from being passed to single-chain sample
+        kwargs = pairs((; (k => v for (k, v) in pairs(kwargs) if k !== :initial_parameters)...))
     end
 
     # Check if the number of chains is larger than the number of samples

test/sample.jl

@@ -32,7 +32,12 @@
             @test chain[1].a == -1.8
             @test chain[1].b == 3.2
 
-            # test warning for initial_parameters (typo)
+            # test warning for initial_parameters (typo) in single-chain sampling
+            @test_logs (:warn, r"initial_parameters.*not recognised.*initial_params") sample(
+                MyModel(), MySampler(), 3; progress=false, initial_parameters=(b=1.0, a=2.0)
+            )
+
+            # test warning for initial_parameters (typo) in multi-chain sampling
             # Note: initial_parameters will be ignored, but it should warn the user
             @test_logs (:warn, r"initial_parameters.*not recognised.*initial_params") match_mode =
                 :any sample(