Merge pull request #63 from deel-ai/feat/lorth_regul_comments

Add comments on reference papers

deel/lip/regularizers.py

@@ -38,6 +38,10 @@ def __init__(self, dim, kernel_shape=None, stride=1, conv_transpose=False) -> No
         """
         Base class for Lorth regularization. Not meant to be used standalone.
 
+        Ref. Achour & al., Existence, Stability And Scalability Of Orthogonal
+        Convolutional Neural Networks (2022).
+        https://www.jmlr.org/papers/v23/22-0026.html
+
         Args:
             dim (int): the rank of the convolution, e.g. "2" for 2D convolution.
             kernel_shape: the shape of the kernel.
@@ -80,6 +84,7 @@ def _alphaNormSpectral(self):
         return alpha
 
     def _check_if_orthconv_exists(self):
+        """check the existence of Orthogonal convolution (for circular padding)"""
         R, C, M = self._get_kernel_shape()
         msg = "Impossible {} configuration for orthogonal convolution."
         if C * self.stride**self.dim >= M:  # RO case
@@ -128,6 +133,9 @@ def __init__(self, kernel_shape=None, stride=1, conv_transpose=False) -> None:
         Lorth computation for 2D convolutions. Although this class allows to compute
         the regularization term, it cannot be used as it is in a layer.
 
+        Ref. Wang & al., Orthogonal Convolutional Neural Networks (2020).
+        http://arxiv.org/abs/1911.12207
+
         Args:
             kernel_shape: the shape of the kernel.
             stride (int): stride used in the associated convolution