hyper-connections 0.0.4__tar.gz → 0.0.6__tar.gz

{hyper_connections-0.0.4 → hyper_connections-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyper-connections
-Version: 0.0.4
+Version: 0.0.6
 Summary: Hyper-Connections
 Project-URL: Homepage, https://pypi.org/project/hyper-connections/
 Project-URL: Repository, https://github.com/lucidrains/hyper-connections
@@ -73,11 +73,11 @@ residual = branch(residual) + residual
 
 from hyper_connections import HyperConnections
 
-expand_stream, reduce_stream = HyperConnections.get_expand_reduce_stream_functions(4)
+init_hyper_conn, expand_stream, reduce_stream = HyperConnections.get_init_and_expand_reduce_stream_functions(4)
 
 # 1. wrap your branch function
 
-hyper_conn_branch = HyperConnections(4, dim = 512, branch = branch)
+hyper_conn_branch = init_hyper_conn(dim = 512, branch = branch)
 
 # 2. expand to 4 streams, this must be done before your trunk, typically a for-loop with many branch functions
 
@@ -112,11 +112,11 @@ residual = branch(residual) + residual
 
 from hyper_connections import HyperConnections
 
-expand_stream, reduce_stream = HyperConnections.get_expand_reduce_stream_functions(4)
+init_hyper_conn, expand_stream, reduce_stream = HyperConnections.get_init_and_expand_reduce_stream_functions(4)
 
-# 1. instantiate hyper connection with correct number of streams (4 in this case)
+# 1. instantiate hyper connection with correct number of streams (4 in this case) - or use the init function above
 
-hyper_conn = HyperConnections(4, dim = 512)
+hyper_conn = init_hyper_conn(dim = 512)
 
 # 2. expand to 4 streams
 
@@ -135,6 +135,12 @@ residual = add_residual(branch_output)
 residual = reduce_stream(residual)
 ```
 
+To compare hyper connections to plain residual without changing the code, just pass `disable = True` when fetching the functions
+
+```python
+HyperConnections.get_init_and_expand_reduce_stream_functions(4, disabled = True)
+```
+
 ## Citation
 
 ```bibtex

{hyper_connections-0.0.4 → hyper_connections-0.0.6}/README.md

@@ -30,11 +30,11 @@ residual = branch(residual) + residual
 
 from hyper_connections import HyperConnections
 
-expand_stream, reduce_stream = HyperConnections.get_expand_reduce_stream_functions(4)
+init_hyper_conn, expand_stream, reduce_stream = HyperConnections.get_init_and_expand_reduce_stream_functions(4)
 
 # 1. wrap your branch function
 
-hyper_conn_branch = HyperConnections(4, dim = 512, branch = branch)
+hyper_conn_branch = init_hyper_conn(dim = 512, branch = branch)
 
 # 2. expand to 4 streams, this must be done before your trunk, typically a for-loop with many branch functions
 
@@ -69,11 +69,11 @@ residual = branch(residual) + residual
 
 from hyper_connections import HyperConnections
 
-expand_stream, reduce_stream = HyperConnections.get_expand_reduce_stream_functions(4)
+init_hyper_conn, expand_stream, reduce_stream = HyperConnections.get_init_and_expand_reduce_stream_functions(4)
 
-# 1. instantiate hyper connection with correct number of streams (4 in this case)
+# 1. instantiate hyper connection with correct number of streams (4 in this case) - or use the init function above
 
-hyper_conn = HyperConnections(4, dim = 512)
+hyper_conn = init_hyper_conn(dim = 512)
 
 # 2. expand to 4 streams
 
@@ -92,6 +92,12 @@ residual = add_residual(branch_output)
 residual = reduce_stream(residual)
 ```
 
+To compare hyper connections to plain residual without changing the code, just pass `disable = True` when fetching the functions
+
+```python
+HyperConnections.get_init_and_expand_reduce_stream_functions(4, disabled = True)
+```
+
 ## Citation
 
 ```bibtex

{hyper_connections-0.0.4 → hyper_connections-0.0.6}/hyper_connections/__init__.py

@@ -1,3 +1,4 @@
 from hyper_connections.hyper_connections import (
-    HyperConnections
+    HyperConnections,
+    Residual
 )

{hyper_connections-0.0.4 → hyper_connections-0.0.6}/hyper_connections/hyper_connections.py

@@ -18,7 +18,46 @@ def exists(v):
 def default(v, d):
     return v if exists(v) else d
 
-# main class
+def identity(t):
+    return t
+
+# main classes
+
+# residual base class
+
+class Residual(Module):
+    def __init__(
+        self,
+        *args,
+        branch = None,
+        **kwargs
+    ):
+        super().__init__()
+        self.branch = branch
+
+    def width_connection(self, residuals):
+        return residuals, residuals, dict()
+
+    def depth_connection(self, branch_output, residuals):
+        return branch_output + residuals
+
+    def forward(self, residuals, *branch_args, **branch_kwargs):
+
+        branch_input, residuals, residual_kwargs = self.width_connection(residuals)
+
+        def add_residual_fn(branch_out):
+            return self.depth_connection(branch_out, residuals, **residual_kwargs)
+
+        if not exists(self.branch):
+            return branch_input, add_residual_fn
+
+        branch_output = self.branch(branch_input, *branch_args, **branch_kwargs)
+
+        (branch_output, *rest), tree_spec = tree_flatten(branch_output)
+
+        branch_output = add_residual_fn(branch_output)
+
+        return tree_unflatten((branch_output, *rest), tree_spec)
 
 # hyper connection residual streams
 
@@ -69,6 +108,16 @@ class HyperConnections(Module):
 
         return expand_fn, reduce_fn
 
+    @classmethod
+    def get_init_and_expand_reduce_stream_functions(cls, num_streams, disable = False):
+
+        hyper_conn_klass = cls if not disable else Residual
+
+        init_hyper_conn_fn = partial(hyper_conn_klass, num_streams)
+        expand_reduce_fns = cls.get_expand_reduce_stream_functions(num_streams) if not disable else (identity, identity)
+
+        return (init_hyper_conn_fn, *expand_reduce_fns)
+
     def width_connection(self, residuals):
         # width connection
 
@@ -98,9 +147,9 @@ class HyperConnections(Module):
         if self.channel_first:
             branch_input = rearrange(branch_input, 'b ... d -> b d ...')
 
-        return branch_input, residuals, beta
+        return branch_input, residuals, dict(beta = beta)
 
-    def depth_connection(self, branch_output, residuals, beta):
+    def depth_connection(self, branch_output, residuals, *, beta):
         # 'depth' connection
 
         if self.channel_first:
@@ -116,10 +165,10 @@ class HyperConnections(Module):
 
     def forward(self, residuals, *branch_args, **branch_kwargs):
 
-        branch_input, residuals, beta = self.width_connection(residuals)
+        branch_input, residuals, residual_kwargs = self.width_connection(residuals)
 
         def add_residual_fn(branch_out):
-            return self.depth_connection(branch_out, residuals, beta)
+            return self.depth_connection(branch_out, residuals, **residual_kwargs)
 
         if not exists(self.branch):
             return branch_input, add_residual_fn

{hyper_connections-0.0.4 → hyper_connections-0.0.6}/pyproject.toml

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