hyper-connections 0.1.6__tar.gz → 0.1.7__tar.gz

{hyper_connections-0.1.6 → hyper_connections-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyper-connections
-Version: 0.1.6
+Version: 0.1.7
 Summary: Hyper-Connections
 Project-URL: Homepage, https://pypi.org/project/hyper-connections/
 Project-URL: Repository, https://github.com/lucidrains/hyper-connections

{hyper_connections-0.1.6 → hyper_connections-0.1.7}/hyper_connections/hyper_connections.py

@@ -73,16 +73,18 @@ class Residual(Module):
         self,
         *args,
         branch: Module | None = None,
+        residual_transform: Module | None = None,
         **kwargs
     ):
         super().__init__()
         self.branch = branch
+        self.residual_transform = default(residual_transform, nn.Identity())
 
     def width_connection(self, residuals):
         return residuals, residuals, dict()
 
     def depth_connection(self, branch_output, residuals):
-        return branch_output + residuals
+        return branch_output + self.residual_transform(residuals)
 
     def decorate_branch(self, branch: Callable):
         assert not exists(self.branch), 'branch was already wrapped on init'
@@ -128,7 +130,8 @@ class HyperConnections(Module):
         layer_index = None,
         tanh = True,
         channel_first = False,
-        dropout = 0.
+        dropout = 0.,
+        residual_transform: Module | None = None, # to support resnet blocks where dimension in not equal to dimension out - usually a residual conv
     ):
         """
         Appendix J, Algorithm2 in - https://arxiv.org/abs/2409.19606
@@ -168,7 +171,14 @@ class HyperConnections(Module):
 
         self.channel_first = channel_first
 
+        # maybe residual transform
+
+        self.residual_transform = default(residual_transform, nn.Identity())
+
     def width_connection(self, residuals):
+
+        maybe_transformed_residuals = self.residual_transform(residuals)
+
         # width connection
 
         if self.channel_first:
@@ -197,7 +207,7 @@ class HyperConnections(Module):
         if self.channel_first:
             branch_input = rearrange(branch_input, 'b ... d -> b d ...')
 
-        return branch_input, residuals, dict(beta = beta)
+        return branch_input, maybe_transformed_residuals, dict(beta = beta)
 
     def depth_connection(self, branch_output, residuals, *, beta):
         # 'depth' connection
@@ -205,13 +215,15 @@ class HyperConnections(Module):
         if self.channel_first:
             branch_output = rearrange(branch_output, 'b d ... -> b ... d')
 
-        residuals = einsum(branch_output, beta, 'b ... d, b ... s -> b ... s d') + residuals
-        output = rearrange(residuals, 'b ... s d -> (b s) ... d')
+        output = einsum(branch_output, beta, 'b ... d, b ... s -> b ... s d')
+        output = rearrange(output, 'b ... s d -> (b s) ... d')
 
         if self.channel_first:
             output = rearrange(output, 'b ... d -> b d ...')
 
-        return self.dropout(output)
+        residuals = residuals + output
+
+        return self.dropout(residuals)
 
     def decorate_branch(self, branch: Callable):
         assert not exists(self.branch), 'branch was already wrapped on init'

{hyper_connections-0.1.6 → hyper_connections-0.1.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hyper-connections"
-version = "0.1.6"
+version = "0.1.7"
 description = "Hyper-Connections"
 authors = [
     { name = "Phil Wang", email = "lucidrains@gmail.com" }

{hyper_connections-0.1.6 → hyper_connections-0.1.7}/tests/test_hyper_connections.py

@@ -136,3 +136,46 @@ def test_multi_input_hyper_connections(disable):
     residual = reduce_stream(residual)
 
     assert residual.shape == (3, 1024, 512)
+
+@pytest.mark.parametrize('disable', (False, True))
+def test_residual_transform(disable):
+
+    # a single branch layer
+
+    branch = nn.Sequential(
+        nn.Linear(512, 512),
+        nn.SiLU(),
+        nn.Linear(512, 256)
+    )
+
+    residual_fn = nn.Linear(512, 256)
+
+    # before
+
+    residual = torch.randn(2, 1024, 512)
+
+    before_residual = branch(residual) + residual_fn(residual)
+
+    # after, say 4 streams in paper
+
+    from hyper_connections import get_init_and_expand_reduce_stream_functions
+
+    init_hyper_conn, expand_stream, reduce_stream = get_init_and_expand_reduce_stream_functions(4, disable = disable)
+
+    # 1. wrap your branch function
+
+    hyper_conn_branch = init_hyper_conn(dim = 512, branch = branch, residual_transform = residual_fn)
+
+    # 2. expand to 4 streams, this must be done before your trunk, typically a for-loop with many branch functions
+
+    residual = expand_stream(residual)
+
+    # 3. forward your residual as usual into the wrapped branch function(s)
+
+    residual = hyper_conn_branch(residual) 
+
+    # 4. reduce 4 streams with a summation, this has to be done after your for-loop trunk. for transformer, unsure whether to do before or after final norm
+
+    after_residual = reduce_stream(residual)
+
+    assert before_residual.shape == after_residual.shape