Skip to content

Commit

Permalink
fix wrong Rd cross-reference
Browse files Browse the repository at this point in the history
  • Loading branch information
nkoenen committed Nov 25, 2024
1 parent 15c89af commit f9f9b80
Show file tree
Hide file tree
Showing 16 changed files with 24 additions and 20 deletions.
3 changes: 2 additions & 1 deletion R/Converter.R
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,8 @@ Converter <- R6Class("Converter",
#' torch-converted model ([ConvertedModel]) is created and stored in
#' the field `model`.
#'
#' @param model ([`nn_sequential`], \code{\link[keras]{keras_model}},
#' @param model (\code{\link[torch]{nn_sequential}},
#' \code{\link[keras]{keras_model}},
#' \code{\link[neuralnet]{neuralnet}} or `list`)\cr
#' A trained neural network for classification or regression
#' tasks to be interpreted. Only models from the following types or
Expand Down
3 changes: 2 additions & 1 deletion R/DeepLift.R
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,8 @@ DeepSHAP <- R6Class(
#' another variant is implemented, which treats a MaxPooling layer as an
#' AveragePooling layer in the backward pass only, leading to an uniform
#' distribution of the upper-layer contribution to the lower layer.\cr
#' @param data_ref ([`array`], [`data.frame`], [`torch_tensor`] or `list`)\cr
#' @param data_ref ([`array`], [`data.frame`],
#' \code{\link[torch]{torch_tensor}} or `list`)\cr
#' The reference data which is used to estimate the conditional expectation.
#' These must have the same format as the input data of the passed model to
#' the converter object. This means either
Expand Down
4 changes: 2 additions & 2 deletions R/GradienBased.R
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ IntegratedGradient <- R6Class(
#' @param n (`integer(1)`)\cr
#' Number of steps for the approximation of the integration path along
#' \eqn{\alpha} (default: \eqn{50}).\cr
#' @param x_ref ([`array`], [`data.frame`], [`torch_tensor`] or `list`)\cr
#' @param x_ref ([`array`], [`data.frame`], \code{\link[torch]{torch_tensor}} or `list`)\cr
#' The reference input for the IntegratedGradient method. This value
#' must have the same format as the input data of the passed model to the
#' converter object. This means either
Expand Down Expand Up @@ -723,7 +723,7 @@ ExpectedGradient <- R6Class(
#' Number of samples from the distribution of reference values and number
#' of samples for the approximation of the integration path along
#' \eqn{\alpha} (default: \eqn{50}).\cr
#' @param data_ref ([`array`], [`data.frame`], [`torch_tensor`] or `list`)\cr
#' @param data_ref ([`array`], [`data.frame`], \code{\link[torch]{torch_tensor}} or `list`)\cr
#' The reference inputs for the ExpectedGradient method. This value
#' must have the same format as the input data of the passed model to the
#' converter object. This means either
Expand Down
2 changes: 1 addition & 1 deletion man/AgnosticWrapper.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/ConnectionWeights.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/Converter.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/DeepLift.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions man/DeepSHAP.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/ExpectedGradient.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/Gradient.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/GradientBased.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/IntegratedGradient.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/LIME.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/LRP.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/SHAP.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/SmoothGrad.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f9f9b80

Please sign in to comment.