ExecutedModels: Handles training of M.L. models

ExecutedModelsR Documentation

Handles training of M.L. models

Description

Allows to manage the executed M.L. models.

Methods

Public methods


Method new()

Method for initializing the object arguments during runtime.

Usage
ExecutedModels$new(dir.path)
Arguments
dir.path

The location were the executed models will be saved.


Method getNames()

The function is used to obtain the name of the ML model achieved the best performance during training stage.

Usage
ExecutedModels$getNames()
Returns

A character vector of length 1 of NULL if no ML model have been trained.


Method getBest()

The function is responsible of returning the model achieving the best performance value during training stage.

Usage
ExecutedModels$getBest()
Returns

A Model object.


Method add()

The function inserts a new model to the list of executed models.

Usage
ExecutedModels$add(model, keep.best = TRUE)
Arguments
model

A previously trained model (in Model object).

keep.best

A logical value to define the saving operation. If TRUE only saves the best model, otherwise all executed models are saved.


Method exist()

The function is used to discern if a specific model has been executed previously.

Usage
ExecutedModels$exist(model.name)
Arguments
model.name

A character vector with the name of the model to check for existence.

Returns

A logical value. TRUE if the model exists and FALSE otherwise.


Method size()

The function is used to compute the number of executed ML models.

Usage
ExecutedModels$size()
Returns

A numeric vector or size 1.


Method save()

The function is responsible of saving the information of all executed models into a hidden file.

Usage
ExecutedModels$save()

Method delete()

The function removes an specific model.

Usage
ExecutedModels$delete(model.name)
Arguments
model.name

A character vector with the name of the model to be removed.


Method clone()

The objects of this class are cloneable with this method.

Usage
ExecutedModels$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

Model


D2MCS documentation built on Aug. 23, 2022, 5:07 p.m.