#' @export
OfflineDirectMethodBandit <- R6::R6Class(
inherit = OfflineBootstrappedReplayBandit,
class = FALSE,
private = list(
r = NULL
),
public = list(
class_name = "OfflineDirectMethodBandit",
initialize = function(formula,
data, k = NULL, d = NULL,
unique = NULL, shared = NULL,
randomize = TRUE) {
super$initialize(formula,
data, k, d,
unique, shared,
randomize, replacement = FALSE,
jitter = FALSE, arm_multiply = FALSE)
},
post_initialization = function() {
super$post_initialization()
# modeled reward for each arm at each t
private$r <- model.matrix(private$formula, data = private$S, rhs = 3)[,-1]
},
get_reward = function(index, context, action) {
list(
reward = as.double(private$r[index,action$choice]),
optimal_reward = ifelse(private$or, as.double(private$S$optimal_reward[[index]]), NA),
optimal_arm = ifelse(private$oa, as.double(private$S$optimal_arm[[index]]), NA)
)
}
)
)
#' Bandit: Offline Direct Methods
#'
#' Policy for the evaluation of policies with offline data with modeled rewards per arm.
#'
#' @name OfflineDirectMethodBandit
#'
#' @section Usage:
#' \preformatted{
#' bandit <- OfflineDirectMethodBandit(formula,
#' data, k = NULL, d = NULL,
#' unique = NULL, shared = NULL,
#' randomize = TRUE)
#' }
#'
#' @section Arguments:
#'
#' \describe{
#' \item{\code{formula}}{
#' formula (required).
#' Format: \code{y.context ~ z.choice | x1.context + x2.xontext + ... | r1.reward + r2.reward ...}
#' Here, r1.reward to rk.reward represent regression based precalculated rewards per arm.
#' Adds an intercept to the context model by default. Exclude the intercept, by adding "0" or "-1" to
#' the list of contextual features, as in: \code{y.context ~ z.choice | x1.context + x2.xontext -1}
#' }
#' \item{\code{data}}{
#' data.table or data.frame; offline data source (required)
#' }
#' \item{\code{k}}{
#' integer; number of arms (optional). Optionally used to reformat the formula defined x.context vector
#' as a \code{k x d} matrix. When making use of such matrix formatted contexts, you need to define custom
#' intercept(s) when and where needed in data.table or data.frame.
#' }
#' \item{\code{d}}{
#' integer; number of contextual features (optional) Optionally used to reformat the formula defined
#' x.context vector as a \code{k x d} matrix. When making use of such matrix formatted contexts, you need
#' to define custom intercept(s) when and where needed in data.table or data.frame.
#' }
#' \item{\code{randomize}}{
#' logical; randomize rows of data stream per simulation (optional, default: TRUE)
#' }
#' \item{\code{replacement}}{
#' logical; sample with replacement (optional, default: FALSE)
#' }
#' \item{\code{replacement}}{
#' logical; add jitter to contextual features (optional, default: FALSE)
#' }
#' \item{\code{unique}}{
#' integer vector; index of disjoint features (optional)
#' }
#' \item{\code{shared}}{
#' integer vector; index of shared features (optional)
#' }
#'
#' }
#'
#' @section Methods:
#'
#' \describe{
#'
#' \item{\code{new(formula, data, k = NULL, d = NULL, unique = NULL, shared = NULL, randomize = TRUE)}}{
#' generates and instantializes a new \code{OfflineDirectMethodBandit} instance. }
#'
#' \item{\code{get_context(t)}}{
#' argument:
#' \itemize{
#' \item \code{t}: integer, time step \code{t}.
#' }
#' returns a named \code{list}
#' containing the current \code{d x k} dimensional matrix \code{context$X},
#' the number of arms \code{context$k} and the number of features \code{context$d}.
#' }
#'
#' \item{\code{get_reward(t, context, action)}}{
#' arguments:
#' \itemize{
#' \item \code{t}: integer, time step \code{t}.
#' \item \code{context}: list, containing the current \code{context$X} (d x k context matrix),
#' \code{context$k} (number of arms) and \code{context$d} (number of context features)
#' (as set by \code{bandit}).
#' \item \code{action}: list, containing \code{action$choice} (as set by \code{policy}).
#' }
#' returns a named \code{list} containing \code{reward$reward} and, where computable,
#' \code{reward$optimal} (used by "oracle" policies and to calculate regret).
#' }
#'
#' \item{\code{post_initialization()}}{
#' Randomize offline data by shuffling the offline data.table before the start of each
#' individual simulation when self$randomize is TRUE (default)
#' }
#' }
#'
#' @references
#'
#' Agarwal, Alekh, et al. "Taming the monster: A fast and simple algorithm for contextual bandits."
#' International Conference on Machine Learning. 2014.
#'
#' @seealso
#'
#' Core contextual classes: \code{\link{Bandit}}, \code{\link{Policy}}, \code{\link{Simulator}},
#' \code{\link{Agent}}, \code{\link{History}}, \code{\link{Plot}}
#'
#' Bandit subclass examples: \code{\link{BasicBernoulliBandit}}, \code{\link{ContextualLogitBandit}},
#' \code{\link{OfflineDirectMethodBandit}}
#'
#' Policy subclass examples: \code{\link{EpsilonGreedyPolicy}}, \code{\link{ContextualLinTSPolicy}}
#'
#' @examples
#'
#' \dontrun{
#'
#' library(contextual)
#' library(data.table)
#'
#' # Import myocardial infection dataset
#'
#' url <- "http://d1ie9wlkzugsxr.cloudfront.net/data_propensity/myocardial_propensity.csv"
#' data <- fread(url)
#'
#' simulations <- 50
#' horizon <- nrow(data)
#'
#' # arms always start at 1
#' data$trt <- data$trt + 1
#'
#' # turn death into alive, making it a reward
#' data$alive <- abs(data$death - 1)
#'
#' # Run regression per arm, predict outcomes, and save results, a column per arm
#'
#' f <- alive ~ age + male + risk + severity
#'
#' model_f <- function(arm) glm(f, data=data[trt==arm],
#' family=binomial(link="logit"),
#' y=FALSE, model=FALSE)
#'
#' arms <- sort(unique(data$trt))
#' model_arms <- lapply(arms, FUN = model_f)
#'
#' predict_arm <- function(model) predict(model, data, type = "response")
#' r_data <- lapply(model_arms, FUN = predict_arm)
#' r_data <- do.call(cbind, r_data)
#' colnames(r_data) <- paste0("R", (1:max(arms)))
#'
#' # Bind data and model predictions
#'
#' data <- cbind(data,r_data)
#'
#' # Define Bandit
#'
#' f <- alive ~ trt | age + male + risk + severity | R1 + R2 # y ~ z | x | r
#'
#' bandit <- OfflineDirectMethodBandit$new(formula = f, data = data)
#'
#' # Define agents.
#' agents <- list(Agent$new(LinUCBDisjointOptimizedPolicy$new(0.2), bandit, "LinUCB"),
#' Agent$new(FixedPolicy$new(1), bandit, "Arm1"),
#' Agent$new(FixedPolicy$new(2), bandit, "Arm2"))
#'
#' # Initialize the simulation.
#'
#' simulation <- Simulator$new(agents = agents, simulations = simulations, horizon = horizon)
#'
#' # Run the simulation.
#' sim <- simulation$run()
#'
#' # plot the results
#' plot(sim, type = "cumulative", regret = FALSE, rate = TRUE, legend_position = "bottomright")
#' plot(sim, type = "arms", limit_agents = "LinUCB", legend_position = "topright")
#'
#' }
NULL
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.