:py:mod:`anomalib.models.stfpm.lightning_model`
===============================================

.. py:module:: anomalib.models.stfpm.lightning_model

.. autoapi-nested-parse::

   STFPM: Student-Teacher Feature Pyramid Matching for Unsupervised Anomaly Detection.

   https://arxiv.org/abs/2103.04257



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   anomalib.models.stfpm.lightning_model.StfpmLightning




.. py:class:: StfpmLightning(hparams: Union[omegaconf.DictConfig, omegaconf.ListConfig])

   Bases: :py:obj:`Stfpm`

   PL Lightning Module for the STFPM algorithm.

   :param hparams: Model params
   :type hparams: Union[DictConfig, ListConfig]

   .. py:method:: configure_callbacks(self)

      Configure model-specific callbacks.

      .. note::

         This method is used for the existing CLI.
         When PL CLI is introduced, configure callback method will be
             deprecated, and callbacks will be configured from either
             config.yaml file or from CLI.


   .. py:method:: configure_optimizers(self) -> torch.optim.Optimizer

      Configures optimizers for each decoder.

      .. note::

         This method is used for the existing CLI.
         When PL CLI is introduced, configure optimizers method will be
             deprecated, and optimizers will be configured from either
             config.yaml file or from CLI.

      :returns: Adam optimizer for each decoder
      :rtype: Optimizer