diff --git a/pkgdown.yml b/pkgdown.yml index 725ba0493..f8bda4afe 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -4,7 +4,7 @@ pkgdown_sha: ~ articles: understanding_shapr_vaeac: understanding_shapr_vaeac.html understanding_shapr: understanding_shapr.html -last_built: 2024-04-11T07:02Z +last_built: 2024-04-12T08:12Z urls: reference: https://norskregnesentral.github.io/shapr/reference article: https://norskregnesentral.github.io/shapr/articles diff --git a/reference/compute_shapley_new.html b/reference/compute_shapley_new.html index 89dd71e31..3a287e1e9 100644 --- a/reference/compute_shapley_new.html +++ b/reference/compute_shapley_new.html @@ -71,12 +71,14 @@

Compute shapley values

Arguments

-
dt_vS
-

The contribution matrix.

+
internal
+

List. +Holds all parameters, data, functions and computed objects used within explain() +The list contains one or more of the elements parameters, data, objects, output.

-
explainer
-

An explain object.

+
dt_vS
+

The contribution matrix.

diff --git a/reference/default_doc.html b/reference/default_doc.html index 84a68de9f..430afd1ca 100644 --- a/reference/default_doc.html +++ b/reference/default_doc.html @@ -66,7 +66,7 @@

Unexported documentation helper function.

-
default_doc()
+
default_doc(internal, model, predict_model, output_size, extra, ...)
diff --git a/reference/default_doc_explain.html b/reference/default_doc_explain.html index f21634112..ac55c2545 100644 --- a/reference/default_doc_explain.html +++ b/reference/default_doc_explain.html @@ -66,7 +66,7 @@

Exported documentation helper function.

-
default_doc_explain()
+
default_doc_explain(internal, index_features)
diff --git a/reference/shapr-package.html b/reference/shapr-package.html index dfcfec106..3fad6f871 100644 --- a/reference/shapr-package.html +++ b/reference/shapr-package.html @@ -80,9 +80,9 @@

Author

  • Lars Henry Berge Olsen lholsen@math.uio.no (ORCID)

  • Annabelle Redelmeier Annabelle.Redelmeier@nr.no

  • Jon Lachmann Jon@lachmann.nu

  • -

    Other contributors:

    Other contributors:

    diff --git a/reference/specified_masks_mask_generator.html b/reference/specified_masks_mask_generator.html index 9a65177ab..ac8f25a8e 100644 --- a/reference/specified_masks_mask_generator.html +++ b/reference/specified_masks_mask_generator.html @@ -89,12 +89,6 @@

    Arguments

    the first half and second half of the rows are duplicates of each other. That is, batch = [row1, row1, row2, row2, row3, row3, ...].

    - -
    batch
    -

    Matrix/Tensor. Only used to get the dimensions and to check if any of the -entries are missing. If any are missing, then the returned mask will ensure that -these missing entries are masked.

    -

    Author

    diff --git a/reference/vaeac_preprocess_data.html b/reference/vaeac_preprocess_data.html index e66f49436..2660935f6 100644 --- a/reference/vaeac_preprocess_data.html +++ b/reference/vaeac_preprocess_data.html @@ -101,10 +101,6 @@

    Arguments

    norm_std

    Torch tensor (optional). A 1D array containing the stds of the columns of x_torch.

    - -
    x_torch
    -

    Torch tensor. A 2D matrix containing the data to normalize.

    -

    Value

    diff --git a/reference/vaeac_print_train_summary.html b/reference/vaeac_print_train_summary.html index daf058759..2cfcb7137 100644 --- a/reference/vaeac_print_train_summary.html +++ b/reference/vaeac_print_train_summary.html @@ -79,7 +79,7 @@

    Arguments

    Positive integer. The epoch with the lowest running validation error.

    -
    last_epoch
    +
    last_state

    The state list (i.e., the saved vaeac object) of vaeac model at the epoch with the lowest IWAE.