vaeac_check_save_names

Function that checks that the save folder exists and for a valid file name

internal

Complex machine learning models are often hard to interpret. However, in
many situations it is crucial to understand and explain why a model made a specific
prediction. Shapley values is the only method for such prediction explanation framework
with a solid theoretical foundation. Previously known methods for estimating the Shapley
values do, however, assume feature independence. This package implements methods which accounts for any feature
dependence, and thereby produces more accurate estimates of the true Shapley values.
An accompanying 'Python' wrapper ('shaprpy') is available through the GitHub repository.

Martin Jullum

shapr

Prediction Explanation with Dependence-Aware Shapley Values

Lars Henry Berge Olsen

Annabelle Redelmeier

Jon Lachmann

Nikolai Sellereite

Anders Løland

Jens Christian Wahl

Camilla Lingjærde

Norsk Regnesentral 

vaeac_check_save_names function

<dl><dt>folder_to_save_model</dt>
<dd>String (default is <code><a href="/link/base%3A%3Atempdir()?package=shapr&version=1.0.6" data-mini-rdoc="shapr::base::tempdir()">base::tempdir()</a></code>). String specifying a path to a folder where
the function is to save the fitted vaeac model. Note that the path will be removed from the returned
<code>explain()</code> object if <code>vaeac.save_model = FALSE</code>.</dd>
<dt>model_description</dt>
<dd>String (default is <code>make.names(Sys.time())</code>). String containing, e.g., the name of the
data distribution or additional parameter information. Used in the save name of the fitted model. If not provided,
then a name will be generated based on <code><a href="/link/base%3A%3ASys.time()?package=shapr&version=1.0.6" data-mini-rdoc="shapr::base::Sys.time()">base::Sys.time()</a></code> to ensure a unique name. We use <code><a href="/link/base%3A%3Amake.names()?package=shapr&version=1.0.6" data-mini-rdoc="shapr::base::make.names()">base::make.names()</a></code> to
ensure a valid file name for all operating systems.</dd></dl>

Arguments

Author

Function that checks that the save folder exists and for a valid file name — vaeac_check_save_names

<dl>

<dt>folder_to_save_model</dt>
<dd>String (default is <code><a href='https://rdrr.io/r/base/tempfile.html'>base::tempdir()</a></code>). String specifying a path to a folder where
the function is to save the fitted vaeac model. Note that the path will be removed from the returned
<code>explain()</code> object if <code>vaeac.save_model = FALSE</code>.</dd>


<dt>model_description</dt>
<dd>String (default is <code>make.names(Sys.time())</code>). String containing, e.g., the name of the
data distribution or additional parameter information. Used in the save name of the fitted model. If not provided,
then a name will be generated based on <code><a href='https://rdrr.io/r/base/Sys.time.html'>base::Sys.time()</a></code> to ensure a unique name. We use <code><a href='https://rdrr.io/r/base/make.names.html'>base::make.names()</a></code> to
ensure a valid file name for all operating systems.</dd>

</dl>

Function that checks that the save folder exists and for a valid file name

vaeac_check_save_names: Function that checks that the save folder exists and for a valid file name

Description

Usage

Value

Arguments

Author