From eec208b71087097f820b792d8a3631425032ea32 Mon Sep 17 00:00:00 2001 From: egillax <egillax@gmail.com> Date: Mon, 27 Nov 2023 14:43:08 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20OHDSI/De?= =?UTF-8?q?epPatientLevelPrediction@8900d8cd684ca25f15d6f4aef9bb93a522239f?= =?UTF-8?q?1b=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dev/articles/BuildingDeepModels.html | 2 +- dev/articles/FirstModel.html | 2 +- dev/articles/Installing.html | 2 +- dev/pkgdown.yml | 2 +- dev/reference/DeepPatientLevelPrediction.html | 6 +- dev/reference/index.html | 8 +- dev/reference/setDefaultResNet.html | 2 +- dev/reference/setEstimator.html | 15 +- dev/reference/setMultiLayerPerceptron.html | 11 +- dev/reference/setResNet.html | 21 +- dev/reference/setTransformer.html | 15 +- dev/reference/trainingCache.html | 257 ++++++++++++++++++ dev/sitemap.xml | 6 +- 13 files changed, 314 insertions(+), 35 deletions(-) create mode 100644 dev/reference/trainingCache.html diff --git a/dev/articles/BuildingDeepModels.html b/dev/articles/BuildingDeepModels.html index 5e3d793..82d372e 100644 --- a/dev/articles/BuildingDeepModels.html +++ b/dev/articles/BuildingDeepModels.html @@ -105,7 +105,7 @@ <h4 data-toc-skip class="author">Jenna Reps, Egill Fridgeirsson, Chungsoo Kim, Henrik John, Seng Chan You, Xiaoyong Pan</h4> - <h4 data-toc-skip class="date">2023-11-08</h4> + <h4 data-toc-skip class="date">2023-11-27</h4> <small class="dont-index">Source: <a href="https://github.com/OHDSI/DeepPatientLevelPrediction/blob/HEAD/vignettes/BuildingDeepModels.Rmd" class="external-link"><code>vignettes/BuildingDeepModels.Rmd</code></a></small> <div class="hidden name"><code>BuildingDeepModels.Rmd</code></div> diff --git a/dev/articles/FirstModel.html b/dev/articles/FirstModel.html index 4bbb7dd..9422ea1 100644 --- a/dev/articles/FirstModel.html +++ b/dev/articles/FirstModel.html @@ -104,7 +104,7 @@ <h1 data-toc-skip>Developing your first DeepPLP model</h1> <h4 data-toc-skip class="author">Egill Fridgeirsson</h4> - <h4 data-toc-skip class="date">2023-11-08</h4> + <h4 data-toc-skip class="date">2023-11-27</h4> <small class="dont-index">Source: <a href="https://github.com/OHDSI/DeepPatientLevelPrediction/blob/HEAD/vignettes/FirstModel.Rmd" class="external-link"><code>vignettes/FirstModel.Rmd</code></a></small> <div class="hidden name"><code>FirstModel.Rmd</code></div> diff --git a/dev/articles/Installing.html b/dev/articles/Installing.html index 12b4565..3b8f213 100644 --- a/dev/articles/Installing.html +++ b/dev/articles/Installing.html @@ -105,7 +105,7 @@ <h1 data-toc-skip>DeepPatientLevelPrediction Installation <h4 data-toc-skip class="author">Egill Fridgeirsson</h4> - <h4 data-toc-skip class="date">2023-11-08</h4> + <h4 data-toc-skip class="date">2023-11-27</h4> <small class="dont-index">Source: <a href="https://github.com/OHDSI/DeepPatientLevelPrediction/blob/HEAD/vignettes/Installing.Rmd" class="external-link"><code>vignettes/Installing.Rmd</code></a></small> <div class="hidden name"><code>Installing.Rmd</code></div> diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml index 0783f25..663b949 100644 --- a/dev/pkgdown.yml +++ b/dev/pkgdown.yml @@ -5,5 +5,5 @@ articles: BuildingDeepModels: BuildingDeepModels.html FirstModel: FirstModel.html Installing: Installing.html -last_built: 2023-11-08T22:11Z +last_built: 2023-11-27T14:42Z diff --git a/dev/reference/DeepPatientLevelPrediction.html b/dev/reference/DeepPatientLevelPrediction.html index 43dd962..c7d3ca4 100644 --- a/dev/reference/DeepPatientLevelPrediction.html +++ b/dev/reference/DeepPatientLevelPrediction.html @@ -1,5 +1,6 @@ <!DOCTYPE html> -<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>DeepPatientLevelPrediction — DeepPatientLevelPrediction • DeepPatientLevelPrediction</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/cosmo/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="DeepPatientLevelPrediction — DeepPatientLevelPrediction"><meta property="og:description" content="A package containing deep learning extensions for developing prediction models using data in the OMOP CDM"><meta name="robots" content="noindex"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]> +<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>DeepPatientLevelPrediction — DeepPatientLevelPrediction • DeepPatientLevelPrediction</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/cosmo/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="DeepPatientLevelPrediction — DeepPatientLevelPrediction"><meta property="og:description" content="A package containing deep learning extensions for developing +prediction models using data in the OMOP CDM"><meta name="robots" content="noindex"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]> <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> <![endif]--></head><body data-spy="scroll" data-target="#toc"> @@ -80,7 +81,8 @@ <h1>DeepPatientLevelPrediction</h1> </div> <div class="ref-description"> - <p>A package containing deep learning extensions for developing prediction models using data in the OMOP CDM</p> + <p>A package containing deep learning extensions for developing +prediction models using data in the OMOP CDM</p> </div> diff --git a/dev/reference/index.html b/dev/reference/index.html index 0ad24ee..82dab28 100644 --- a/dev/reference/index.html +++ b/dev/reference/index.html @@ -85,10 +85,6 @@ <h2 id="all-functions">All functions <a href="#all-functions" class="anchor" ari <p><code><a href="DeepPatientLevelPrediction.html">DeepPatientLevelPrediction</a></code> </p> </td> <td><p>DeepPatientLevelPrediction</p></td> - </tr><tr><td> - <p><code><a href="TrainingCache.html">TrainingCache</a></code> </p> - </td> - <td><p>TrainingCache</p></td> </tr><tr><td> <p><code><a href="camelCaseToSnakeCase.html">camelCaseToSnakeCase()</a></code> </p> </td> @@ -145,6 +141,10 @@ <h2 id="all-functions">All functions <a href="#all-functions" class="anchor" ari <p><code><a href="setTransformer.html">setTransformer()</a></code> </p> </td> <td><p>create settings for training a non-temporal transformer</p></td> + </tr><tr><td> + <p><code><a href="trainingCache.html">trainingCache</a></code> </p> + </td> + <td><p>TrainingCache</p></td> </tr></tbody></table></div> <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar"> diff --git a/dev/reference/setDefaultResNet.html b/dev/reference/setDefaultResNet.html index 9fbfefd..f7a7417 100644 --- a/dev/reference/setDefaultResNet.html +++ b/dev/reference/setDefaultResNet.html @@ -98,7 +98,7 @@ <h2>Arguments</h2> </dl></div> <div id="details"> <h2>Details</h2> - <p>Model architecture from by https://arxiv.org/abs/2106.11959 . + <p>Model architecture from by https://arxiv.org/abs/2106.11959 . Hyperparameters chosen by a experience on a few prediction problems.</p> </div> diff --git a/dev/reference/setEstimator.html b/dev/reference/setEstimator.html index 83ea950..0b2d071 100644 --- a/dev/reference/setEstimator.html +++ b/dev/reference/setEstimator.html @@ -119,7 +119,8 @@ <h2>Arguments</h2> <dt>device</dt> -<dd><p>what device to train on, can be a string or a function to that evaluates +<dd><p>what device to train on, can be a string or a function to +that evaluates to the device during runtime</p></dd> @@ -136,13 +137,17 @@ <h2>Arguments</h2> <dt>earlyStopping</dt> -<dd><p>If earlyStopping should be used which stops the training of your metric is not improving</p></dd> +<dd><p>If earlyStopping should be used which stops the +training of your metric is not improving</p></dd> <dt>metric</dt> -<dd><p>either `auc` or `loss` or a custom metric to use. This is the metric used for scheduler and earlyStopping. -Needs to be a list with function `fun`, mode either `min` or `max` and a `name`, -`fun` needs to be a function that takes in prediction and labels and outputs a score.</p></dd> +<dd><p>either `auc` or `loss` or a custom metric to use. This is the +metric used for scheduler and earlyStopping. +Needs to be a list with function `fun`, mode either `min` or `max` and a +`name`, +`fun` needs to be a function that takes in prediction and labels and +outputs a score.</p></dd> <dt>seed</dt> diff --git a/dev/reference/setMultiLayerPerceptron.html b/dev/reference/setMultiLayerPerceptron.html index ea4d068..2128a8b 100644 --- a/dev/reference/setMultiLayerPerceptron.html +++ b/dev/reference/setMultiLayerPerceptron.html @@ -104,15 +104,17 @@ <h2>Arguments</h2> <dt>sizeHidden</dt> -<dd><p>Amount of neurons in each default layer, default: 2^(6:9) (64 to 512)</p></dd> +<dd><p>Amount of neurons in each default layer, +default: 2^(6:9) (64 to 512)</p></dd> <dt>dropout</dt> -<dd><p>How much dropout to apply after first linear, default: seq(0, 0.3, 0.05)</p></dd> +<dd><p>How much dropout to apply after first linear, +default: seq(0, 0.3, 0.05)</p></dd> <dt>sizeEmbedding</dt> -<dd><p>Size of embedding layer, default: 2^(6:9) (64 to 512)</p></dd> +<dd><p>Size of embedding default: 2^(6:9) (64 to 512)</p></dd> <dt>estimatorSettings</dt> @@ -120,7 +122,8 @@ <h2>Arguments</h2> <dt>hyperParamSearch</dt> -<dd><p>Which kind of hyperparameter search to use random sampling or exhaustive grid search. default: 'random'</p></dd> +<dd><p>Which kind of hyperparameter search to use random +sampling or exhaustive grid search. default: 'random'</p></dd> <dt>randomSample</dt> diff --git a/dev/reference/setResNet.html b/dev/reference/setResNet.html index 715e349..de392cf 100644 --- a/dev/reference/setResNet.html +++ b/dev/reference/setResNet.html @@ -106,23 +106,28 @@ <h2>Arguments</h2> <dt>sizeHidden</dt> -<dd><p>Amount of neurons in each default layer, default: 2^(6:10) (64 to 1024)</p></dd> +<dd><p>Amount of neurons in each default layer, default: +2^(6:10) (64 to 1024)</p></dd> <dt>hiddenFactor</dt> -<dd><p>How much to grow the amount of neurons in each ResLayer, default: 1:4</p></dd> +<dd><p>How much to grow the amount of neurons in each +ResLayer, default: 1:4</p></dd> <dt>residualDropout</dt> -<dd><p>How much dropout to apply after last linear layer in ResLayer, default: seq(0, 0.3, 0.05)</p></dd> +<dd><p>How much dropout to apply after last linear layer +in ResLayer, default: seq(0, 0.3, 0.05)</p></dd> <dt>hiddenDropout</dt> -<dd><p>How much dropout to apply after first linear layer in ResLayer, default: seq(0, 0.3, 0.05)</p></dd> +<dd><p>How much dropout to apply after first linear layer +in ResLayer, default: seq(0, 0.3, 0.05)</p></dd> <dt>sizeEmbedding</dt> -<dd><p>Size of embedding layer, default: 2^(6:9) (64 to 512)</p></dd> +<dd><p>Size of embedding layer, default: 2^(6:9) +'(64 to 512)</p></dd> <dt>estimatorSettings</dt> @@ -130,11 +135,13 @@ <h2>Arguments</h2> <dt>hyperParamSearch</dt> -<dd><p>Which kind of hyperparameter search to use random sampling or exhaustive grid search. default: 'random'</p></dd> +<dd><p>Which kind of hyperparameter search to use random +sampling or exhaustive grid search. default: 'random'</p></dd> <dt>randomSample</dt> -<dd><p>How many random samples from hyperparameter space to use</p></dd> +<dd><p>How many random samples from hyperparameter space +to use</p></dd> <dt>randomSampleSeed</dt> diff --git a/dev/reference/setTransformer.html b/dev/reference/setTransformer.html index 992e579..449fa2f 100644 --- a/dev/reference/setTransformer.html +++ b/dev/reference/setTransformer.html @@ -113,7 +113,8 @@ <h2>Arguments</h2> <dt>dimOut</dt> -<dd><p>dimension of output, usually 1 for binary problems</p></dd> +<dd><p>dimension of output, usually 1 for binary +problems</p></dd> <dt>numHeads</dt> @@ -137,7 +138,8 @@ <h2>Arguments</h2> <dt>dimHiddenRatio</dt> -<dd><p>dimension of the feedforward block as a ratio of dimToken (embedding size)</p></dd> +<dd><p>dimension of the feedforward block as a ratio +of dimToken (embedding size)</p></dd> <dt>estimatorSettings</dt> @@ -145,15 +147,18 @@ <h2>Arguments</h2> <dt>hyperParamSearch</dt> -<dd><p>what kind of hyperparameter search to do, default 'random'</p></dd> +<dd><p>what kind of hyperparameter search to do, +default 'random'</p></dd> <dt>randomSample</dt> -<dd><p>How many samples to use in hyperparameter search if random</p></dd> +<dd><p>How many samples to use in hyperparameter +search if random</p></dd> <dt>randomSampleSeed</dt> -<dd><p>Random seed to sample hyperparameter combinations</p></dd> +<dd><p>Random seed to sample hyperparameter +combinations</p></dd> </dl></div> <div id="details"> diff --git a/dev/reference/trainingCache.html b/dev/reference/trainingCache.html new file mode 100644 index 0000000..4b3c3ec --- /dev/null +++ b/dev/reference/trainingCache.html @@ -0,0 +1,257 @@ +<!DOCTYPE html> +<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>TrainingCache — trainingCache • DeepPatientLevelPrediction</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/cosmo/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="TrainingCache — trainingCache"><meta property="og:description" content="Parameter caching for training persistence and continuity"><meta name="robots" content="noindex"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]> +<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> +<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> +<![endif]--></head><body data-spy="scroll" data-target="#toc"> + + + <div class="container template-reference-topic"> + <header><div class="navbar navbar-default navbar-fixed-top" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <span class="navbar-brand"> + <a class="navbar-link" href="../index.html">DeepPatientLevelPrediction</a> + <span class="version label label-danger" data-toggle="tooltip" data-placement="bottom" title="In-development version">2.0.1.9999</span> + </span> + </div> + + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav"><li> + <a href="../index.html"> + <span class="fa fa-home fa-lg"></span> + + </a> +</li> +<li> + <a href="../articles/Installing.html">Get started</a> +</li> +<li> + <a href="../articles/FirstModel.html">My first deep learning model</a> +</li> +<li> + <a href="../reference/index.html">Reference</a> +</li> +<li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false"> + Articles + + <span class="caret"></span> + </a> + <ul class="dropdown-menu" role="menu"><li> + <a href="../articles/BuildingDeepModels.html">Building Deep Learning Models</a> + </li> + <li> + <a href="../articles/FirstModel.html">Developing your first DeepPLP model</a> + </li> + <li> + <a href="../articles/Installing.html">DeepPatientLevelPrediction Installation Guide</a> + </li> + </ul></li> +<li> + <a href="../news/index.html">Changelog</a> +</li> + </ul><ul class="nav navbar-nav navbar-right"><li> + <a href="https://ohdsi.github.io/Hades" class="external-link"><img src='https://ohdsi.github.io/Hades/images/hadesMini.png' width=80 height=17 style='vertical-align: top;'></a> +</li> +<li> + <a href="https://github.com/OHDSI/DeepPatientLevelPrediction" class="external-link"> + <span class="fa fa-github fa-lg"></span> + + </a> +</li> + </ul></div><!--/.nav-collapse --> + </div><!--/.container --> +</div><!--/.navbar --> + + + + </header><div class="row"> + <div class="col-md-9 contents"> + <div class="page-header"> + <h1>TrainingCache</h1> + <small class="dont-index">Source: <a href="https://github.com/OHDSI/DeepPatientLevelPrediction/blob/HEAD/R/TrainingCache-class.R" class="external-link"><code>R/TrainingCache-class.R</code></a></small> + <div class="hidden name"><code>trainingCache.Rd</code></div> + </div> + + <div class="ref-description"> + <p>Parameter caching for training persistence and continuity</p> + </div> + + + <div id="value"> + <h2>Value</h2> + + +<p>Whether the provided and cached parameter grid is identical</p> + + +<p>Grid search results from the training cache</p> + + +<p>Boolen</p> + + +<p>Last grid search index</p> + </div> + <div id="methods"> + <h2>Methods</h2> + +<div class="section"> +<h3 id="public-methods">Public methods<a class="anchor" aria-label="anchor" href="#public-methods"></a></h3> + +<ul><li><p><a href="#method-TrainingCache-new"><code>trainingCache$new()</code></a></p></li> +<li><p><a href="#method-TrainingCache-isParamGridIdentical"><code>trainingCache$isParamGridIdentical()</code></a></p></li> +<li><p><a href="#method-TrainingCache-saveGridSearchPredictions"><code>trainingCache$saveGridSearchPredictions()</code></a></p></li> +<li><p><a href="#method-TrainingCache-saveModelParams"><code>trainingCache$saveModelParams()</code></a></p></li> +<li><p><a href="#method-TrainingCache-getGridSearchPredictions"><code>trainingCache$getGridSearchPredictions()</code></a></p></li> +<li><p><a href="#method-TrainingCache-isFull"><code>trainingCache$isFull()</code></a></p></li> +<li><p><a href="#method-TrainingCache-getLastGridSearchIndex"><code>trainingCache$getLastGridSearchIndex()</code></a></p></li> +<li><p><a href="#method-TrainingCache-dropCache"><code>trainingCache$dropCache()</code></a></p></li> +<li><p><a href="#method-TrainingCache-clone"><code>trainingCache$clone()</code></a></p></li> +</ul></div><p></p><hr><a id="method-TrainingCache-new"></a><div class="section"> +<h3 id="method-new-">Method <code>new()</code><a class="anchor" aria-label="anchor" href="#method-new-"></a></h3> +<p>Creates a new training cache</p><div class="section"> +<h4 id="usage">Usage<a class="anchor" aria-label="anchor" href="#usage"></a></h4> +<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va"><a href="../reference/trainingCache.html">trainingCache</a></span><span class="op">$</span><span class="fu">new</span><span class="op">(</span><span class="va">inDir</span><span class="op">)</span></span></code></pre></div><p></p></div> +</div> + +<div class="section"> +<h4 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h4> +<p></p><div class="arguments"><dl><dt><code>inDir</code></dt> +<dd><p>Path to the analysis directory</p></dd> + + +</dl><p></p></div> +</div> + +</div><p></p><hr><a id="method-TrainingCache-isParamGridIdentical"></a><div class="section"> +<h3 id="method-isparamgrididentical-">Method <code>isParamGridIdentical()</code><a class="anchor" aria-label="anchor" href="#method-isparamgrididentical-"></a></h3> +<p>Checks whether the parameter grid in the model settings is identical to +the cached parameters.</p><div class="section"> +<h4 id="usage-1">Usage<a class="anchor" aria-label="anchor" href="#usage-1"></a></h4> +<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">trainingCache</span><span class="op">$</span><span class="fu">isParamGridIdentical</span><span class="op">(</span><span class="va">inModelParams</span><span class="op">)</span></span></code></pre></div><p></p></div> +</div> + +<div class="section"> +<h4 id="arguments-1">Arguments<a class="anchor" aria-label="anchor" href="#arguments-1"></a></h4> +<p></p><div class="arguments"><dl><dt><code>inModelParams</code></dt> +<dd><p>Parameter grid from the model settings</p></dd> + + +</dl><p></p></div> +</div> + +</div><p></p><hr><a id="method-TrainingCache-saveGridSearchPredictions"></a><div class="section"> +<h3 id="method-savegridsearchpredictions-">Method <code>saveGridSearchPredictions()</code><a class="anchor" aria-label="anchor" href="#method-savegridsearchpredictions-"></a></h3> +<p>Saves the grid search results to the training cache</p><div class="section"> +<h4 id="usage-2">Usage<a class="anchor" aria-label="anchor" href="#usage-2"></a></h4> +<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">trainingCache</span><span class="op">$</span><span class="fu">saveGridSearchPredictions</span><span class="op">(</span><span class="va">inGridSearchPredictions</span><span class="op">)</span></span></code></pre></div><p></p></div> +</div> + +<div class="section"> +<h4 id="arguments-2">Arguments<a class="anchor" aria-label="anchor" href="#arguments-2"></a></h4> +<p></p><div class="arguments"><dl><dt><code>inGridSearchPredictions</code></dt> +<dd><p>Grid search predictions</p></dd> + + +</dl><p></p></div> +</div> + +</div><p></p><hr><a id="method-TrainingCache-saveModelParams"></a><div class="section"> +<h3 id="method-savemodelparams-">Method <code>saveModelParams()</code><a class="anchor" aria-label="anchor" href="#method-savemodelparams-"></a></h3> +<p>Saves the parameter grid to the training cache</p><div class="section"> +<h4 id="usage-3">Usage<a class="anchor" aria-label="anchor" href="#usage-3"></a></h4> +<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">trainingCache</span><span class="op">$</span><span class="fu">saveModelParams</span><span class="op">(</span><span class="va">inModelParams</span><span class="op">)</span></span></code></pre></div><p></p></div> +</div> + +<div class="section"> +<h4 id="arguments-3">Arguments<a class="anchor" aria-label="anchor" href="#arguments-3"></a></h4> +<p></p><div class="arguments"><dl><dt><code>inModelParams</code></dt> +<dd><p>Parameter grid from the model settings</p></dd> + + +</dl><p></p></div> +</div> + +</div><p></p><hr><a id="method-TrainingCache-getGridSearchPredictions"></a><div class="section"> +<h3 id="method-getgridsearchpredictions-">Method <code>getGridSearchPredictions()</code><a class="anchor" aria-label="anchor" href="#method-getgridsearchpredictions-"></a></h3> +<p>Gets the grid search results from the training cache</p><div class="section"> +<h4 id="usage-4">Usage<a class="anchor" aria-label="anchor" href="#usage-4"></a></h4> +<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">trainingCache</span><span class="op">$</span><span class="fu">getGridSearchPredictions</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div> +</div> + + +</div><p></p><hr><a id="method-TrainingCache-isFull"></a><div class="section"> +<h3 id="method-isfull-">Method <code>isFull()</code><a class="anchor" aria-label="anchor" href="#method-isfull-"></a></h3> +<p>Check if cache is full</p><div class="section"> +<h4 id="usage-5">Usage<a class="anchor" aria-label="anchor" href="#usage-5"></a></h4> +<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">trainingCache</span><span class="op">$</span><span class="fu">isFull</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div> +</div> + + +</div><p></p><hr><a id="method-TrainingCache-getLastGridSearchIndex"></a><div class="section"> +<h3 id="method-getlastgridsearchindex-">Method <code>getLastGridSearchIndex()</code><a class="anchor" aria-label="anchor" href="#method-getlastgridsearchindex-"></a></h3> +<p>Gets the last index from the cached grid search</p><div class="section"> +<h4 id="usage-6">Usage<a class="anchor" aria-label="anchor" href="#usage-6"></a></h4> +<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">trainingCache</span><span class="op">$</span><span class="fu">getLastGridSearchIndex</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div> +</div> + + +</div><p></p><hr><a id="method-TrainingCache-dropCache"></a><div class="section"> +<h3 id="method-dropcache-">Method <code>dropCache()</code><a class="anchor" aria-label="anchor" href="#method-dropcache-"></a></h3> +<p>Remove the training cache from the analysis path</p><div class="section"> +<h4 id="usage-7">Usage<a class="anchor" aria-label="anchor" href="#usage-7"></a></h4> +<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">trainingCache</span><span class="op">$</span><span class="fu">dropCache</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div> +</div> + + +</div><p></p><hr><a id="method-TrainingCache-clone"></a><div class="section"> +<h3 id="method-clone-">Method <code>clone()</code><a class="anchor" aria-label="anchor" href="#method-clone-"></a></h3> +<p>The objects of this class are cloneable with this method.</p><div class="section"> +<h4 id="usage-8">Usage<a class="anchor" aria-label="anchor" href="#usage-8"></a></h4> +<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">trainingCache</span><span class="op">$</span><span class="fu">clone</span><span class="op">(</span>deep <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div><p></p></div> +</div> + +<div class="section"> +<h4 id="arguments-4">Arguments<a class="anchor" aria-label="anchor" href="#arguments-4"></a></h4> +<p></p><div class="arguments"><dl><dt><code>deep</code></dt> +<dd><p>Whether to make a deep clone.</p></dd> + + +</dl><p></p></div> +</div> + +</div> + + </div> + + </div> + <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar"> + <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2> + </nav></div> +</div> + + + <footer><div class="copyright"> + <p></p><p>Developed by Egill Fridgeirsson, Jenna Reps, Seng Chan You, Chungsoo Kim, Henrik John.</p> +</div> + +<div class="pkgdown"> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> +</div> + + </footer></div> + + + + + + + </body></html> + diff --git a/dev/sitemap.xml b/dev/sitemap.xml index a422ef0..2432bf4 100644 --- a/dev/sitemap.xml +++ b/dev/sitemap.xml @@ -24,9 +24,6 @@ <url> <loc>/reference/DeepPatientLevelPrediction.html</loc> </url> - <url> - <loc>/reference/TrainingCache.html</loc> - </url> <url> <loc>/reference/camelCaseToSnakeCase.html</loc> </url> @@ -72,4 +69,7 @@ <url> <loc>/reference/setTransformer.html</loc> </url> + <url> + <loc>/reference/trainingCache.html</loc> + </url> </urlset>