final fix before release 0.0.1

giotto-ai · Jun 17, 2022 · d441ca7 · d441ca7
1 parent 548c1f2
commit d441ca7
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 4 deletions.
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -26,4 +26,5 @@ jobs:
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
         python setup.py sdist bdist_wheel
+        twine check dist/*
         twine upload dist/*
diff --git a/gdeep/topology_layers/__init__.py b/gdeep/topology_layers/__init__.py
@@ -8,4 +8,6 @@
     'PersformerConfig',
     'Persformer',
     'PersformerWrapper',
+    "attention",
+    "pooling_layers"
 ]
diff --git a/gdeep/topology_layers/attention/attention_base.py b/gdeep/topology_layers/attention/attention_base.py
@@ -8,7 +8,11 @@
 # Type aliases
 Tensor = torch.Tensor
 
+
 class AttentionBase(Module, ABC):
+    """Base class for attention layers. This class
+    can be used in generic transformer models.
+    """
     def __init__(self, config: PersformerConfig):
         super().__init__()
         self.config = config

diff --git a/gdeep/topology_layers/attention/induced_attention.py b/gdeep/topology_layers/attention/induced_attention.py
@@ -10,6 +10,7 @@
 
 
 class InducedAttention(AttentionBase):
+    """Class implementing the induced attention"""
     def __init__(self, config: PersformerConfig) -> None:
         super().__init__(config)
         raise NotImplementedError

diff --git a/gdeep/topology_layers/attention/scaled_dot_product_attention.py b/gdeep/topology_layers/attention/scaled_dot_product_attention.py
@@ -24,8 +24,7 @@ def __init__(self,
                                dropout=config.attention_probs_dropout_prob,
                                batch_first=True)
         self.dropout = Dropout(config.hidden_dropout_prob)
-
-
+
     def forward(self,  # type: ignore
                 input: Tensor,
                 attention_mask: Optional[Tensor] = None

diff --git a/gdeep/topology_layers/pooling_layers/attention_pooling_layer.py b/gdeep/topology_layers/pooling_layers/attention_pooling_layer.py
@@ -9,8 +9,11 @@
 # Type aliases
 Tensor = torch.Tensor
 
+
 class AttentionPoolingLayer(Module):
-
+    """This class implements the attention mechanism
+    with a pooling layer to enforce permutation
+    invariance"""
     config: PersformerConfig
 
     def __init__(self, config: PersformerConfig):

diff --git a/gdeep/topology_layers/pooling_layers/max_pooling_layer.py b/gdeep/topology_layers/pooling_layers/max_pooling_layer.py
@@ -10,7 +10,7 @@
 
 
 class MaxPoolingLayer(Module):
-
+    """Implementation of the max pooling layer"""
     config: PersformerConfig
 
     def __init__(self, config: PersformerConfig):