Rename variance_adapter to variance_shape_adapter

UCL · Oct 24, 2024 · 9a9eb41 · 9a9eb41
1 parent 9375960
commit 9a9eb41
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 12 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -12,4 +12,4 @@ export(sample_chain)
 export(simple_scale_adapter)
 export(target_distribution_from_stan_model)
 export(trace_function_from_stan_model)
-export(variance_adapter)
+export(variance_shape_adapter)
diff --git a/R/adaptation.R b/R/adaptation.R
@@ -152,9 +152,9 @@ dual_averaging_scale_adapter <- function(
 #'   grad_log_density = function(x) -x
 #' )
 #' proposal <- barker_proposal(target_distribution)
-#' adapter <- variance_adapter()
+#' adapter <- variance_shape_adapter()
 #' adapter$initialize(proposal, chain_state(c(0, 0)))
-variance_adapter <- function(kappa = 0.6) {
+variance_shape_adapter <- function(kappa = 0.6) {
   mean_estimate <- NULL
   variance_estimate <- NULL
   initialize <- function(proposal, initial_state) {

diff --git a/README.Rmd b/README.Rmd
@@ -59,7 +59,7 @@ results <- sample_chain(
   initial_state = rnorm(dimension),
   n_warm_up_iteration = 1000,
   n_main_iteration = 1000,
-  adapters = list(simple_scale_adapter(), variance_adapter())
+  adapters = list(simple_scale_adapter(), variance_shape_adapter())
 )
 mean_accept_prob <- mean(results$statistics[, "accept_prob"])
 adapted_shape <- proposal$parameters()$shape

diff --git a/README.md b/README.md
@@ -56,7 +56,7 @@ results <- sample_chain(
   initial_state = rnorm(dimension),
   n_warm_up_iteration = 1000,
   n_main_iteration = 1000,
-  adapters = list(simple_scale_adapter(), variance_adapter())
+  adapters = list(simple_scale_adapter(), variance_shape_adapter())
 )
 mean_accept_prob <- mean(results$statistics[, "accept_prob"])
 adapted_shape <- proposal$parameters()$shape

diff --git a/man/variance_adapter.Rd → man/variance_shape_adapter.Rd b/man/variance_adapter.Rd → man/variance_shape_adapter.Rd
diff --git a/tests/testthat/test-adaptation.R b/tests/testthat/test-adaptation.R
@@ -216,7 +216,7 @@ for (dimension in c(1L, 2L, 5L)) {
         ),
         {
           proposal <- dummy_proposal_with_shape_parameter()
-          adapter <- variance_adapter(kappa = kappa)
+          adapter <- variance_shape_adapter(kappa = kappa)
           check_adapter(adapter)
           withr::local_seed(default_seed())
           target_scales <- exp(2 * rnorm(dimension))

diff --git a/vignettes/barker-proposal.Rmd b/vignettes/barker-proposal.Rmd
@@ -77,7 +77,7 @@ adapters <- list(
     initial_scale = 2.38^2 / dimension^(1 / 3),
     target_accept_prob = 0.4
   ),
-  variance_adapter()
+  variance_shape_adapter()
 )
 ```
 
@@ -208,7 +208,7 @@ mala_results <- sample_chain(
   initial_state = initial_state,
   n_warm_up_iteration = n_warm_up_iteration,
   n_main_iteration = n_main_iteration,
-  adapters = list(simple_scale_adapter(), variance_adapter()),
+  adapters = list(simple_scale_adapter(), variance_shape_adapter()),
   trace_warm_up = TRUE
 )
 ```