train_utils.py

# @author lucasmiranda42
# encoding: utf-8
# module deepof

"""

Simple utility functions used in deepof example scripts. These are not part of the main package

"""
from datetime import date, datetime

from kerastuner import BayesianOptimization, Hyperband
from kerastuner import HyperParameters
from kerastuner_tensorboard_logger import TensorBoardLogger
from typing import Tuple, Union, Any, List
import deepof.hypermodels
import deepof.model_utils
import numpy as np
import os
import pickle
import tensorflow as tf

hp = HyperParameters()


def load_hparams(hparams):
    """Loads hyperparameters from a custom dictionary pickled on disc.
    Thought to be used with the output of hyperparameter_tuning.py"""

    if hparams is not None:
        with open(hparams, "rb") as handle:
            hparams = pickle.load(handle)
    else:
        hparams = {
            "units_conv": 256,
            "units_lstm": 256,
            "units_dense2": 64,
            "dropout_rate": 0.25,
            "encoding": 16,
            "learning_rate": 1e-3,
        }
    return hparams


def load_treatments(train_path):
    """Loads a dictionary containing the treatments per individual,
    to be loaded as metadata in the coordinates class"""
    try:
        with open(
            os.path.join(
                train_path,
                [i for i in os.listdir(train_path) if i.endswith(".pkl")][0],
            ),
            "rb",
        ) as handle:
            treatment_dict = pickle.load(handle)
    except IndexError:
        treatment_dict = None

    return treatment_dict


def get_callbacks(
    X_train: np.array,
    batch_size: int,
    cp: bool,
    variational: bool,
    predictor: float,
    loss: str,
) -> List[Union[Any]]:
    """Generates callbacks for model training, including:
        - run_ID: run name, with coarse parameter details;
        - tensorboard_callback: for real-time visualization;
        - cp_callback: for checkpoint saving,
        - onecycle: for learning rate scheduling"""

    run_ID = "{}{}{}_{}".format(
        ("GMVAE" if variational else "AE"),
        ("P" if predictor > 0 and variational else ""),
        ("_loss={}".format(loss) if variational else ""),
        datetime.now().strftime("%Y%m%d-%H%M%S"),
    )

    log_dir = os.path.abspath("logs/fit/{}".format(run_ID))
    tensorboard_callback = tf.keras.callbacks.TensorBoard(
        log_dir=log_dir, histogram_freq=1, profile_batch=2,
    )

    onecycle = deepof.model_utils.one_cycle_scheduler(
        X_train.shape[0] // batch_size * 250, max_rate=0.005,
    )

    callbacks = [run_ID, tensorboard_callback, onecycle]

    if cp:
        cp_callback = tf.keras.callbacks.ModelCheckpoint(
            "./logs/checkpoints/" + run_ID + "/cp-{epoch:04d}.ckpt",
            verbose=1,
            save_best_only=False,
            save_weights_only=True,
            save_freq="epoch",
        )
        callbacks.append(cp_callback)

    return callbacks


def tune_search(
    data: List[np.array],
    bayopt_trials: int,
    hypermodel: str,
    k: int,
    kl_warmup_epochs: int,
    loss: str,
    mmd_warmup_epochs: int,
    overlap_loss: float,
    pheno_class: float,
    predictor: float,
    project_name: str,
    callbacks: List,
    n_epochs: int = 30,
    n_replicas: int = 1,
) -> Union[bool, Tuple[Any, Any]]:
    """Define the search space using keras-tuner and bayesian optimization

        Parameters:
            - train (np.array): dataset to train the model on
            - test (np.array): dataset to validate the model on
            - bayopt_trials (int): number of Bayesian optimization iterations to run
            - hypermodel (str): hypermodel to load. Must be one of S2SAE (plain autoencoder)
            or S2SGMVAE (Gaussian Mixture Variational autoencoder).
            - k (int) number of components of the Gaussian Mixture
            - loss (str): one of [ELBO, MMD, ELBO+MMD]
            - overlap_loss (float): assigns as weight to an extra loss term which
            penalizes overlap between GM components
            - pheno_class (float): adds an extra regularizing neural network to the model,
            which tries to predict the phenotype of the animal from which the sequence comes
            - predictor (float): adds an extra regularizing neural network to the model,
            which tries to predict the next frame from the current one
            - project_name (str): ID of the current run
            - callbacks (list): list of callbacks for the training loop
            - n_epochs (int): optional. Number of epochs to train each run for
            - n_replicas (int): optional. Number of replicas per parameter set. Higher values
             will yield more robust results, but will affect performance severely

        Returns:
            - best_hparams (dict): dictionary with the best retrieved hyperparameters
            - best_run (tf.keras.Model): trained instance of the best model found

    """

    X_train, y_train, X_val, y_val = data

    if hypermodel == "S2SAE":  # pragma: no cover
        assert (
            predictor == 0.0 and pheno_class == 0.0
        ), "Prediction branches are only available for variational models. See documentation for more details"
        hypermodel = deepof.hypermodels.SEQ_2_SEQ_AE(input_shape=X_train.shape)

    elif hypermodel == "S2SGMVAE":
        hypermodel = deepof.hypermodels.SEQ_2_SEQ_GMVAE(
            input_shape=X_train.shape,
            kl_warmup_epochs=kl_warmup_epochs,
            loss=loss,
            mmd_warmup_epochs=mmd_warmup_epochs,
            number_of_components=k,
            overlap_loss=overlap_loss,
            phenotype_predictor=pheno_class,
            predictor=predictor,
        )

    else:
        return False

    tuner = Hyperband(
        hypermodel,
        directory="HyperBandx_{}_{}".format(loss, str(date.today())),
        executions_per_trial=n_replicas,
        logger=TensorBoardLogger(metrics=["val_mae"], logdir="./logs/hparams"),
        max_epochs=bayopt_trials,
        objective="val_mae",
        project_name=project_name,
        seed=42,
        tune_new_entries=True,
    )

    print(tuner.search_space_summary())

    Xs, ys = [X_train], [X_train]
    Xvals, yvals = [X_val], [X_val]

    if predictor > 0.0:
        Xs, ys = X_train[:-1], [X_train[:-1], X_train[1:]]
        Xvals, yvals = X_val[:-1], [X_val[:-1], X_val[1:]]

    if pheno_class > 0.0:
        ys += [y_train]
        yvals += [y_val]

    tuner.search(
        Xs,
        ys,
        epochs=n_epochs,
        validation_data=(Xvals, yvals),
        verbose=1,
        batch_size=256,
        callbacks=callbacks,
    )

    best_hparams = tuner.get_best_hyperparameters(num_trials=1)[0]
    best_run = tuner.hypermodel.build(best_hparams)

    print(tuner.results_summary())

    return best_hparams, best_run


# TODO:
#    - load_treatments should be part of the main data module. If available in the main directory,
#    a table (preferrable in csv) should be loaded as metadata of the coordinates automatically.
#    This becomes particularly important por the supervised models that include phenotype classification
#    alongside the encoding.