Compare 0bd9bec ... +13 ... 1460bb8

#'

#' This function calculates explanations on a dataset level set that explore model response as a function of selected variables.

#' The explanations can be calulated as Partial Dependence Profile or  Accumulated Local Dependence Profile.

#' The \code{variable_profile} function is a copy of \code{model_profile}.

#'

#' Underneath this function calls the \code{\link[ingredients]{partial_dependence}} or

#' @return An object of the class \code{model_profile}.

#' It's a data frame with calculated average model responses.

#'

#'

#' @name model_profile

#' @examples

#'

#' This function calculated individual profiles aka Ceteris Paribus Profiles.

#' From DALEX version 1.0 this function calls the \code{\link[ingredients]{ceteris_paribus}} from the \code{ingredients} package.

#'

#' @param explainer a model to be explained, preprocessed by the \code{explain} function

#' @param new_observation a new observation for which predictions need to be explained

#' @return An object of the class \code{ceteris_paribus_explainer}.

#' It's a data frame with calculated average response.

#'

#' @export

#'

#' @examples

#' \item \code{type} - character that specifies type of the task.

#' }

#'

#' @importFrom stats median weighted.mean

#' @export

#' @examples

#' \item \code{model_info} named list contating basic information about model, like package, version of package and type.

#' }

#'

#' @rdname explain

#' @export

#' @importFrom stats predict

#' This function performs local diagnostic of residuals.

#' For a single instance its neighbors are identified in the validation data.

#' Residuals are calculated for neighbors and plotted against residuals for all data.

#'

#' @param explainer a model to be explained, preprocessed by the 'explain' function

#' @param new_observation a new observation for which predictions need to be explained

#' @return An object of the class 'predict_diagnostics'.

#' It's a data frame with calculated distribution of residuals.

#'

#' @export

#' @importFrom stats ks.test

#' @importFrom graphics plot