umx_set_cores: Set the number of cores your models will use.

In umx: Structural Equation Modeling and Twin Modeling in R

Set the number of cores your models will use.

Description

To take advantage of multiple cores

umx_set_cores()  # Show many cores are currently requested
5/5 (P-cores / total: 11)
umx_set_cores(3) # Request use of 3 cores

Usage

umx_set_cores(cores = NA, model = NULL, silent = FALSE)

Arguments

cores	number of cores to use. NA (the default) returns current value. "-1" will set to umx_detect_cores().
model	an (optional) model to set. If left NULL, the global option is updated.
silent	If TRUE, no message will be printed.

Details

note: This function is smart: it will default to all performance cores (low power cores are typically so slow its not worth forcing the power cores to wait for them.

Value

• number of cores

References

https://tbates.github.io, https://github.com/tbates/umx

See Also

• umx_time()

Other Get and set: umx, umx_detect_cores(), umx_get_checkpoint(), umx_get_options(), umx_scale_reliabilities(), umx_set_auto_plot(), umx_set_auto_run(), umx_set_checkpoint(), umx_set_condensed_slots(), umx_set_data_variance_check(), umx_set_dollar_symbol(), umx_set_optimization_options(), umx_set_optimizer(), umx_set_plot_file_suffix(), umx_set_plot_format(), umx_set_separator(), umx_set_silent(), umx_set_table_format()

Examples

library(umx)
manifests = c("mpg", "disp", "gear")
m1 = umxRAM("ind", data = mxData(mtcars[, manifests], type = "raw"),
	umxPath(v.m. = manifests)
)
umx_set_cores() # print current value
oldCores = umx_set_cores(silent = TRUE)  # store existing value
umx_set_cores(omxDetectCores()) # set to max
umx_set_cores(-1); umx_set_cores() # set to max (performance cores)
m1 = umx_set_cores(1, m1)  # set m1 usage to 1 core
umx_set_cores(model = m1)  # show new value for m1
umx_set_cores(oldCores)    # reinstate old global value

umx documentation built on Oct. 11, 2026, 5:07 p.m.