From bfaa6c5dc87abcee9a9660984ea790feeb5a61f3 Mon Sep 17 00:00:00 2001
From: egillax <egillax@gmail.com>
Date: Thu, 21 Nov 2024 15:36:41 +0100
Subject: [PATCH] docs

---
 DESCRIPTION                    | 2 +-
 man/setEstimator.Rd            | 3 +++
 man/setMultiLayerPerceptron.Rd | 2 +-
 3 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/DESCRIPTION b/DESCRIPTION
index 94e0aed..1119a68 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -38,7 +38,7 @@ Suggests:
 Remotes:
     ohdsi/PatientLevelPrediction,
     ohdsi/ResultModelManager
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
 Encoding: UTF-8
 Config/testthat/edition: 3
 Config/testthat/parallel: TRUE
diff --git a/man/setEstimator.Rd b/man/setEstimator.Rd
index d9dd3d8..3557211 100644
--- a/man/setEstimator.Rd
+++ b/man/setEstimator.Rd
@@ -15,6 +15,7 @@ setEstimator(
     list(patience = 1)),
   criterion = torch$nn$BCEWithLogitsLoss,
   earlyStopping = list(useEarlyStopping = TRUE, params = list(patience = 4)),
+  compile = FALSE,
   metric = "auc",
   accumulationSteps = NULL,
   seed = NULL
@@ -41,6 +42,8 @@ that evaluates to the device during runtime}
 \item{earlyStopping}{If earlyStopping should be used which stops the
 training of your metric is not improving}
 
+\item{compile}{if the model should be compiled before training, default FALSE}
+
 \item{metric}{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
diff --git a/man/setMultiLayerPerceptron.Rd b/man/setMultiLayerPerceptron.Rd
index a5f96d7..fd78ef1 100644
--- a/man/setMultiLayerPerceptron.Rd
+++ b/man/setMultiLayerPerceptron.Rd
@@ -1,5 +1,5 @@
 % Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/MLP.R
+% Please edit documentation in R/MultiLayerPerceptron.R
 \name{setMultiLayerPerceptron}
 \alias{setMultiLayerPerceptron}
 \title{setMultiLayerPerceptron}