diff --git a/pkgdown.yml b/pkgdown.yml index 40f0bce..0d28849 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -5,5 +5,5 @@ articles: BuildingDeepModels: BuildingDeepModels.html FirstModel: FirstModel.html Installing: Installing.html -last_built: 2023-09-07T08:19Z +last_built: 2023-09-07T15:12Z diff --git a/reference/checkHigher.html b/reference/checkHigher.html new file mode 100644 index 0000000..cabb940 --- /dev/null +++ b/reference/checkHigher.html @@ -0,0 +1,124 @@ + +helper function to check that input is higher than a certain value — checkHigher • DeepPatientLevelPrediction + + +
+
+ + + +
+
+
+

helper function to check that input is higher than a certain value

+ Source: R/HelperFunctions.R + +
+ +
+

helper function to check that input is higher than a certain value

+
+ +
+ 
checkHigher(parameter, value)
+
+ +
+

Arguments

+
parameter
+

the input parameter to check, can be a vector

+ + +
value
+

which value it should be higher than

+ +
+ +
+ +
+ + +
+ + + + + + + + diff --git a/reference/checkHigherEqual.html b/reference/checkHigherEqual.html new file mode 100644 index 0000000..3310691 --- /dev/null +++ b/reference/checkHigherEqual.html @@ -0,0 +1,124 @@ + +helper function to check that input is higher or equal than a certain value — checkHigherEqual • DeepPatientLevelPrediction + + +
+
+ + + +
+
+
+

helper function to check that input is higher or equal than a certain value

+ Source: R/HelperFunctions.R + +
+ +
+

helper function to check that input is higher or equal than a certain value

+
+ +
+ 
checkHigherEqual(parameter, value)
+
+ +
+

Arguments

+
parameter
+

the input parameter to check, can be a vector

+ + +
value
+

which value it should be higher or equal than

+ +
+ +
+ +
+ + +
+ + + + + + + + diff --git a/reference/checkIsClass.html b/reference/checkIsClass.html new file mode 100644 index 0000000..fd93add --- /dev/null +++ b/reference/checkIsClass.html @@ -0,0 +1,124 @@ + +helper function to check class of input — checkIsClass • DeepPatientLevelPrediction + + +
+
+ + + +
+
+
+

helper function to check class of input

+ Source: R/HelperFunctions.R + +
+ +
+

helper function to check class of input

+
+ +
+ 
checkIsClass(parameter, classes)
+
+ +
+

Arguments

+
parameter
+

the input parameter to check

+ + +
classes
+

which classes it should belong to (one or more)

+ +
+ +
+ +
+ + +
+ + + + + + + + diff --git a/reference/index.html b/reference/index.html index f88d6ad..807020d 100644 --- a/reference/index.html +++ b/reference/index.html @@ -97,6 +97,18 @@

All functions camelCaseToSnakeCaseNames()

Convert the names of an object from camel case to snake case

+ +

checkHigher()

+ +

helper function to check that input is higher than a certain value

+ +

checkHigherEqual()

+ +

helper function to check that input is higher or equal than a certain value

+ +

checkIsClass()

+ +

helper function to check class of input

fitEstimator()

diff --git a/reference/setDefaultResNet.html b/reference/setDefaultResNet.html index 9cf8f5d..d8c5af1 100644 --- a/reference/setDefaultResNet.html +++ b/reference/setDefaultResNet.html @@ -86,7 +86,7 @@

setDefaultResNet

setDefaultResNet(
   estimatorSettings = setEstimator(learningRate = "auto", weightDecay = 1e-06, device =
-    "cpu", batchSize = 1024L, epochs = 50L, seed = NULL)
+    "cpu", batchSize = 1024, epochs = 50, seed = NULL)
 )
diff --git a/reference/setDefaultTransformer.html b/reference/setDefaultTransformer.html index c60ba17..82a1800 100644 --- a/reference/setDefaultTransformer.html +++ b/reference/setDefaultTransformer.html @@ -86,7 +86,7 @@

Create default settings for a non-temporal transformer

setDefaultTransformer(
   estimatorSettings = setEstimator(learningRate = "auto", weightDecay = 1e-04, batchSize
-    = 512L, epochs = 10L, seed = NULL, device = "cpu")
+    = 512, epochs = 10, seed = NULL, device = "cpu")
 )
diff --git a/reference/setEstimator.html b/reference/setEstimator.html index 756751a..b4213d3 100644 --- a/reference/setEstimator.html +++ b/reference/setEstimator.html @@ -87,14 +87,14 @@

setEstimator

setEstimator(
   learningRate = "auto",
   weightDecay = 0,
-  batchSize = 512L,
-  epochs = 30L,
+  batchSize = 512,
+  epochs = 30,
   device = "cpu",
   optimizer = torch$optim$AdamW,
   scheduler = list(fun = torch$optim$lr_scheduler$ReduceLROnPlateau, params =
-    list(patience = 1L)),
+    list(patience = 1)),
   criterion = torch$nn$BCEWithLogitsLoss,
-  earlyStopping = list(useEarlyStopping = TRUE, params = list(patience = 4L)),
+  earlyStopping = list(useEarlyStopping = TRUE, params = list(patience = 4)),
   metric = "auc",
   seed = NULL
 )
diff --git a/reference/setMultiLayerPerceptron.html b/reference/setMultiLayerPerceptron.html index 9e00ffc..8d5a9dd 100644 --- a/reference/setMultiLayerPerceptron.html +++ b/reference/setMultiLayerPerceptron.html @@ -85,12 +85,12 @@

setMultiLayerPerceptron

setMultiLayerPerceptron(
-  numLayers = as.integer(1:8),
-  sizeHidden = as.integer(2^(6:9)),
+  numLayers = c(1:8),
+  sizeHidden = c(2^(6:9)),
   dropout = c(seq(0, 0.3, 0.05)),
-  sizeEmbedding = as.integer(2^(6:9)),
+  sizeEmbedding = c(2^(6:9)),
   estimatorSettings = setEstimator(learningRate = "auto", weightDecay = c(1e-06, 0.001),
-    batchSize = 1024L, epochs = 30L, device = "cpu"),
+    batchSize = 1024, epochs = 30, device = "cpu"),
   hyperParamSearch = "random",
   randomSample = 100,
   randomSampleSeed = NULL
diff --git a/reference/setResNet.html b/reference/setResNet.html
index 3bf8e11..6988735 100644
--- a/reference/setResNet.html
+++ b/reference/setResNet.html
@@ -85,14 +85,14 @@ 
setResNet

 
     

     
setResNet(
-  numLayers = as.integer(1:8),
-  sizeHidden = as.integer(2^(6:10)),
-  hiddenFactor = as.integer(1:4),
+  numLayers = c(1:8),
+  sizeHidden = c(2^(6:10)),
+  hiddenFactor = c(1:4),
   residualDropout = c(seq(0, 0.5, 0.05)),
   hiddenDropout = c(seq(0, 0.5, 0.05)),
-  sizeEmbedding = as.integer(2^(6:9)),
+  sizeEmbedding = c(2^(6:9)),
   estimatorSettings = setEstimator(learningRate = "auto", weightDecay = c(1e-06, 0.001),
-    device = "cpu", batchSize = 1024L, epochs = 30L, seed = NULL),
+    device = "cpu", batchSize = 1024, epochs = 30, seed = NULL),
   hyperParamSearch = "random",
   randomSample = 100,
   randomSampleSeed = NULL
diff --git a/sitemap.xml b/sitemap.xml
index 8f4b3a6..4f7c24f 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -36,6 +36,15 @@
   
     /reference/camelCaseToSnakeCaseNames.html
   
+  
+    /reference/checkHigher.html
+  
+  
+    /reference/checkHigherEqual.html
+  
+  
+    /reference/checkIsClass.html
+  
   
     /reference/fitEstimator.html