dot-parse_setup_settings: Internal function for parsing settings related to the...

In familiar: End-to-End Automated Machine Learning and Model Evaluation

Internal function for parsing settings related to the computational setup

Description

Internal function for parsing settings related to the computational setup

Usage

.parse_setup_settings(
  config = NULL,
  parallel = waiver(),
  parallel_nr_cores = waiver(),
  restart_cluster = waiver(),
  cluster_type = waiver(),
  backend_type = waiver(),
  server_port = waiver(),
  ...
)

Arguments

config	A list of settings, e.g. from an xml file.
parallel	(optional) Enable parallel processing. Defaults to TRUE. When set to FALSE, this disables all parallel processing, regardless of specific parameters such as parallel_preprocessing. However, when parallel is TRUE, parallel processing of different parts of the workflow can be disabled by setting respective flags to FALSE.
parallel_nr_cores	(optional) Number of cores available for parallelisation. Defaults to 2. This setting does nothing if parallelisation is disabled.
restart_cluster	(optional) Restart nodes used for parallel computing to free up memory prior to starting a parallel process. Note that it does take time to set up the clusters. Therefore setting this argument to TRUE may impact processing speed. This argument is ignored if parallel is FALSE or the cluster was initialised outside of familiar. Default is FALSE, which causes the clusters to be initialised only once.
cluster_type	(optional) Selection of the cluster type for parallel processing. Available types are the ones supported by the parallel package that is part of the base R distribution: psock (default), fork, mpi, nws, sock. In addition, none is available, which also disables parallel processing.
backend_type	(optional) Selection of the backend for distributing copies of the data. This backend ensures that only a single master copy is kept in memory. This limits memory usage during parallel processing. Several backend options are available, notably socket_server, and none (default). socket_server is based on the callr package and R sockets, comes with familiar and is available for any OS. none uses the package environment of familiar to store data, and is available for any OS. However, none requires copying of data to any parallel process, and has a larger memory footprint.
server_port	(optional) Integer indicating the port on which the socket server or RServe process should communicate. Defaults to port 6311. Note that ports 0 to 1024 and 49152 to 65535 cannot be used.
...	Unused arguments.

Value

List of parameters related to the computational setup.

familiar documentation built on Sept. 30, 2024, 9:18 a.m.