ModelMetaInfo

The function provides meta information on the models obtained.

Parameters:

models_dict: dict
Dictionary containing models.
sort_by: str, {'gini_test', 'gini_train', 'auc_test', 'auc_train', 'Brier_test', 'Brier_train', 'F1_test', 'F1_train'}
A column name to sort by.

Returns:

final_data: pd.DataFrame
Dataframe containing meta information.

Exceptions:

ValueError
Raised if sort_by parameter not in [gini_test, gini_train, auc_test, auc_train, Brier_test, Brier_train, F1_test, F1_train]
TypeError
Raised if models_dict is not a dict

Example:

from combat.combat import ModelMetaInfo
from combat.models import LogitModel

# Sample input data
models_dict = {1: model1 # LogitModel instance
              , 2: model2 # LogitModel instance
              , 3: model3 # LogitModel instance
              }
sort_by = 'gini_test'

# Get meta information on models
meta_info = ModelMetaInfo(models_dict, sort_by)
print("Model meta information:", meta_info)