familiarEnsemble-class: Ensemble of familiar models.

familiarEnsemble-classR Documentation

Ensemble of familiar models.

Description

A familiarEnsemble object contains one or more familiarModel objects.

Slots

name

Name of the familiarEnsemble object.

model_list

List of attached familiarModel objects, or paths to these objects. Familiar attaches familiarModel objects when required.

outcome_type

Outcome type of the data used to create the object.

outcome_info

Outcome information object, which contains additional information concerning the outcome, such as class levels.

data_column_info

Data information object containing information regarding identifier column names and outcome column names.

learner

Learning algorithm used to create the models in the ensemble.

fs_method

Feature selection method used to determine variable importance for the models in the ensemble.

feature_info

List of objects containing feature information, e.g., name, class levels, transformation, normalisation and clustering parameters.

required_features

The set of features required for complete reproduction, i.e. with imputation.

model_features

The combined set of features that is used to train the models in the ensemble,

novelty_features

The combined set of features that is used to train all novelty detectors in the ensemble.

run_table

Run table for the data used to train the ensemble. Used internally.

calibration_info

Calibration information, e.g. baseline survival in the development cohort.

model_dir_path

Path to folder containing the familiarModel objects. Can be updated using the update_model_dir_path method.

auto_detach

Flag used to determine whether models should be detached from the model after use, or not. Used internally.

settings

A copy of the evaluation configuration parameters used at model creation. These are used as default parameters when evaluating the ensemble to create a familiarData object.

project_id

Identifier of the project that generated the underlying familiarModel object(s).

familiar_version

Version of the familiar package.


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