<filename>src/gt4sd/frameworks/granular/ml/models/vae_mlp/core.py
"""VaeMlp implementation."""

from argparse import ArgumentParser
from typing import Any, Dict, Tuple

from torch import nn

from ....arg_parser.utils import str2bool
from ..base_model import GranularEncoderDecoderModel
from ..loss import LOSS_FACTORY
from ..module import MlpDecoder, MlpEncoder
from ..utils import KLAnnealer


class VaeMlp(GranularEncoderDecoderModel):
    """VaeMlp - variational encoder using MLP with Gaussian prior and approximate posterior."""

    def __init__(
        self,
        name: str,
        position: int,
        data: Dict[str, str],
        input_size_enc: int = 256,
        hidden_size_enc: int = 256,
        n_layers_enc: int = 2,
        activation_enc: str = "linear",
        dropout_enc: float = 0.0,
        hidden_size_dec: int = 256,
        n_layers_dec: int = 2,
        activation_dec: str = "linear",
        dropout_dec: float = 0.0,
        output_size_dec: int = 256,
        latent_size: int = 196,
        loss_function: str = "mse",
        kl_low: float = 0.0,
        kl_high: float = 0.1,
        kl_n_epochs: int = 100,
        kl_start_epoch: int = 0,
        **kwargs,
    ) -> None:
        """Construct VaeMlp.

        Args:
            name: model name.
            position: position of the model.
            data: data name mappings.
            input_size_enc: encoder input size. Defaults to 256.
            hidden_size_enc: encoder hidden size. Defaults to 256.
            n_layers_enc: number of layers for the encoder. Defaults to 2.
            activation_enc: activation function for the encoder. Defaults to "linear".
            dropout_enc: encoder dropout rate. Defaults to 0.0.
            hidden_size_dec: decoder hidden size. Defaults to 256.
            n_layers_dec: number of layers for the decoder. Defaults to 2.
            activation_dec: activation function for the decoder. Defaults to "linear".
            dropout_dec: decoder dropout rate. Defaults to 0.0.
            output_size_dec: decoder output size. Defaults to 256.
            latent_size: size of the latent space. Defaults to 196.
            loss_function: loss function. Defaults to "mse".
            kl_low: low KL weight.
            kl_high: high KL weight.
            kl_n_epochs: KL number of epochs.
            kl_start_epoch: KL starting epoch.

        Raises:
            ValueError: in case the provided loss function is not supported.
        """
        super().__init__(name=name, data=data)
        self.position = position
        self.input_key = f"{name}_{data['input']}"
        self.target_key = f"{name}_{data['target']}"

        self.latent_size = latent_size
        self.hidden_size_enc = hidden_size_enc
        self.hidden_size_dec = hidden_size_dec
        self.input_size_enc = input_size_enc
        self.hidden_size_enc = hidden_size_enc
        self.n_layers_enc = n_layers_enc
        self.activation_enc = activation_enc
        self.dropout_enc = dropout_enc
        self.hidden_size_dec = hidden_size_dec
        self.n_layers_dec = n_layers_dec
        self.activation_dec = activation_dec
        self.dropout_dec = dropout_dec
        self.output_size_dec = output_size_dec

        self.loss_function_name = loss_function.lower()
        if self.loss_function_name not in LOSS_FACTORY:
            raise ValueError(
                f"loss_function={self.loss_function_name} not supported. Pick a valid one: {sorted(list(LOSS_FACTORY.keys()))}"
            )
        self.loss_function = LOSS_FACTORY[self.loss_function_name]

        self.encoder = MlpEncoder(
            input_size=input_size_enc,
            hidden_size=hidden_size_enc,
            output_size=hidden_size_enc,
            n_layers=n_layers_enc,
            activation=activation_enc,
            dropout=dropout_enc,
        )
        self.fc_mu = nn.Linear(hidden_size_enc, latent_size)
        self.fc_var = nn.Linear(hidden_size_enc, latent_size)
        self.decoder = MlpDecoder(
            latent_size=latent_size,
            hidden_size=hidden_size_dec,
            output_size=output_size_dec,
            n_layers=n_layers_dec,
            activation=activation_dec,
            dropout=dropout_dec,
        )

        self.epoch_counter = 0

        self.kl_annealer = KLAnnealer(
            kl_low=kl_low,
            kl_high=kl_high,
            n_epochs=kl_n_epochs,
            start_epoch=kl_start_epoch,
        )

    def decode(self, z: Any, *args, **kwargs) -> Any:
        """Decode a latent space point.

        Args:
            z: latent point.

        Returns:
            decoded sample.
        """
        return self.decoder(z)

    def _sampling_step(self, x: Any, *args, **kwargs) -> Any:
        """Run a sampling step in the model.

        Args:
            x: model input.

        Returns:
            model sampling step output.
        """
        x = self.encoder(x)
        mu = self.fc_mu(x)
        log_var = self.fc_var(x)
        return self.sample(mu, log_var)

    def encode(self, x: Any, *args, **kwargs) -> Any:
        """Encode a sample.

        Args:
            x: input sample.

        Returns:
            latent encoding.
        """
        _, _, z = self._sampling_step(x)
        return z

    def _run_step(self, x: Any, *args, **kwargs) -> Any:
        """Run a step in the model.

        Args:
            x: model input.

        Returns:
            model step output.
        """
        p, q, z = self._sampling_step(x)
        return z, self.decoder(z), p, q

    def step(
        self,
        input_data: Any,
        target_data: Any,
        device: str = "cpu",
        current_epoch: int = 0,
        *args,
        **kwargs,
    ) -> Tuple[Any, Any, Any]:
        """Training step for the model.

        Args:
            input_data: input for the step.
            target_data: target for the step.
            device: string representing the device to use. Defaults to "cpu".
            current_epoch: current epoch. Defaults to 0.

        Returns:
            a tuple containing the step output, the loss and the logs for the module.
        """
        x = input_data

        z, x_hat, p, q = self._run_step(x)

        x_hat = x_hat.view(-1, x_hat.size(-1))

        reconstruction_loss = self.loss_function(x_hat, x)

        log_qz = q.log_prob(z)
        log_pz = p.log_prob(z)
        kl_scaling_factor = self.kl_annealer(current_epoch)
        kl = log_qz - log_pz
        kl = kl.mean()
        kl_scaled = kl * kl_scaling_factor

        loss = kl_scaled + reconstruction_loss
        logs = {
            "reconstruction_loss": reconstruction_loss,
            "kl_scaled": kl_scaled,
            "kl_unscaled": kl,
            "kl_scaling_factor": kl_scaling_factor,
            "loss": loss,
        }

        return z, loss, logs

    def val_step(
        self,
        input_data: Any,
        target_data: Any,
        device: str = "cpu",
        current_epoch: int = 0,
        *args,
        **kwargs,
    ) -> Any:
        """Validation step for the model.

        Args:
            input_data: input for the step.
            target_data: target for the step.
            device: string representing the device to use. Defaults to "cpu".
            current_epoch: current epoch. Defaults to 0.

        Returns:
            a tuple containing the step output, the loss and the logs for the module.
        """
        return self.step(
            input_data=input_data,
            target_data=target_data,
            device=device,
            current_epoch=current_epoch,
        )

    @staticmethod
    def add_model_specific_args(
        parent_parser: ArgumentParser, name: str, *args, **kwargs
    ) -> ArgumentParser:
        """Adding to a parser model specific arguments.

        Args:
            parent_parser: patent parser.
            name: model name.

        Returns:
            updated parser.
        """
        parser = ArgumentParser(parents=[parent_parser], add_help=False)

        parser.add_argument(f"--data_path_{name}", type=str)
        parser.add_argument(f"--data_file_{name}", type=str)
        parser.add_argument(f"--dataset_type_{name}", type=str)
        parser.add_argument(f"--position_{name}", type=int, nargs="+")
        parser.add_argument(f"--input_{name}", type=str)
        parser.add_argument(f"--target_{name}", type=str)
        parser.add_argument(f"--checkpoint_path_{name}", type=str)
        parser.add_argument(f"--start_from_checkpoint_{name}", type=str2bool)
        parser.add_argument(f"--freeze_weights_{name}", type=str2bool)
        parser.add_argument(f"--checkpoint_model_name_{name}", type=str)
        parser.add_argument(f"--input_size_enc_{name}", type=int)
        parser.add_argument(f"--hidden_size_enc_{name}", type=int)
        parser.add_argument(f"--n_layers_enc_{name}", type=int)
        parser.add_argument(f"--activation_enc_{name}", type=str)
        parser.add_argument(f"--dropout_enc_{name}", type=float)
        parser.add_argument(f"--hidden_size_dec_{name}", type=int)
        parser.add_argument(f"--dropout_dec_{name}", type=float)
        parser.add_argument(f"--n_layers_dec_{name}", type=int)
        parser.add_argument(f"--activation_dec_{name}", type=str)
        parser.add_argument(f"--ouptput_size_enc_{name}", type=int)
        parser.add_argument(f"--loss_function_{name}", type=str)
        parser.add_argument(f"--latent_size_{name}", type=int)
        parser.add_argument(f"--kl_low_{name}", type=float)
        parser.add_argument(f"--kl_high_{name}", type=float)
        parser.add_argument(f"--kl_n_epochs_{name}", type=int)
        parser.add_argument(f"--kl_start_epoch_{name}", type=int)

        return parser
