Catboost Model Definitions

This module contains the functions to save, load and train CatBoost models.

myogestic.models.definitions.catboost_models.load(model_path, model)[source]

Load a CatBoost model.

Parameters:

  • model_path (str) – The path to load the model.

  • model (_CatBoostBase) – A new instance of the CatBoost model. This instance is used to load the model.

Returns:

The loaded CatBoost model.

Return type:

_CatBoostBase

myogestic.models.definitions.catboost_models.save(model_path, model)[source]

Save a CatBoost model.

Parameters:

  • model_path (str) – The path to save the model.

  • model (catboost.core._CatBoostBase) – The CatBoost model to save.

Returns:

The path where the model was saved.

Return type:

str

myogestic.models.definitions.catboost_models.train(model, x_train, y_train, logger)[source]

Train a CatBoost model.

Parameters:

  • model (_CatBoostBase) – The CatBoost model to train.

  • x_train (np.ndarray) – The training data.

  • y_train (np.ndarray) – The training ground truth.

  • logger (CustomLogger) – The logger to use.

Returns:

The trained CatBoost model.

Return type:

_CatBoostBase