File: mxPenaltySearch.Rd

package info (click to toggle)
r-cran-openmx 2.21.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 14,412 kB
  • sloc: cpp: 36,577; ansic: 13,811; fortran: 2,001; sh: 1,440; python: 350; perl: 21; makefile: 5
file content (44 lines) | stat: -rw-r--r-- 1,408 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/MxRun.R
\name{mxPenaltySearch}
\alias{mxPenaltySearch}
\title{mxPenaltySearch}
\usage{
mxPenaltySearch(
  model,
  ...,
  silent = FALSE,
  suppressWarnings = FALSE,
  unsafe = FALSE,
  checkpoint = FALSE,
  useSocket = FALSE,
  onlyFrontend = FALSE,
  beginMessage = !silent
)
}
\arguments{
\item{model}{A \link{MxModel} object to be optimized.}

\item{...}{Not used.  Forces remaining arguments to be specified by name}

\item{silent}{A boolean indicating whether to print status to terminal.}

\item{suppressWarnings}{A boolean indicating whether to suppress warnings.}

\item{unsafe}{A boolean indicating whether to ignore errors.}

\item{checkpoint}{A boolean indicating whether to periodically write parameter values to a file.}

\item{useSocket}{A boolean indicating whether to periodically write parameter values to a socket.}

\item{onlyFrontend}{A boolean indicating whether to run only front-end model transformations.}

\item{beginMessage}{A boolean indicating whether to print the number of parameters before invoking the backend.}
}
\description{
Grid search for the best \link[=MxPenalty-class]{MxPenalty} hyperparameters. Uses
\link{omxDefaultComputePlan} with
\code{penaltySearch=TRUE}. Specifically, wraps
\link{mxComputeGradientDescent} with \link{mxComputePenaltySearch}
and passes the model to the backend.
}