hippoformer 0.0.1__py3-none-any.whl

hippoformer/hippoformer.py

@@ -0,0 +1,116 @@
+from __future__ import annotations
+
+import torch
+from torch import nn, Tensor, stack, einsum
+import torch.nn.functional as F
+from torch.nn import Module
+from torch.jit import ScriptModule, script_method
+
+from einops import repeat, rearrange
+from einops.layers.torch import Rearrange
+
+from x_mlps_pytorch import create_mlp
+
+from assoc_scan import AssocScan
+
+# helpers
+
+def exists(v):
+    return v is not None
+
+def default(v, d):
+    return v if exists(v) else d
+
+def l2norm(t):
+    return F.normalize(t, dim = -1)
+
+# path integration
+
+class RNN(ScriptModule):
+    def __init__(
+        self,
+        dim,
+    ):
+        super().__init__()
+        self.init_hidden = nn.Parameter(torch.randn(1, dim) * 1e-2)
+
+    @script_method
+    def forward(
+        self,
+        transitions: Tensor,
+        hidden: Tensor | None = None
+    ) -> Tensor:
+
+        batch, seq_len = transitions.shape[:2]
+
+        if hidden is None:
+            hidden = l2norm(self.init_hidden)
+            hidden = hidden.expand(batch, -1)
+
+        hiddens: list[Tensor] = []
+
+        for i in range(seq_len):
+            transition = transitions[:, i]
+
+            hidden = einsum('b i, b i j -> b j', hidden, transition)
+            hidden = F.relu(hidden)
+            hidden = l2norm(hidden)
+
+            hiddens.append(hidden)
+
+        return stack(hiddens, dim = 1)
+
+class PathIntegration(Module):
+    def __init__(
+        self,
+        dim_action,
+        dim_structure,
+        mlp_hidden_dim = None,
+        mlp_depth = 2
+    ):
+        # they use the same approach from Ruiqi Gao's paper from 2021
+        super().__init__()
+
+        self.init_structure = nn.Parameter(torch.randn(dim_structure))
+
+        self.to_transitions = create_mlp(
+            default(mlp_hidden_dim,  dim_action * 4),
+            dim_in = dim_action,
+            dim_out = dim_structure * dim_structure,
+            depth = mlp_depth
+        )
+
+        self.mlp_out_to_weights = Rearrange('... (i j) -> ... i j', j = dim_structure)
+
+        self.rnn = RNN(dim_structure)
+
+    def forward(
+        self,
+        actions,                 # (b n d)
+        prev_structural = None   # (b n d) | (b d)
+    ):
+        batch = actions.shape[0]
+
+        transitions = self.to_transitions(actions)
+        transitions = self.mlp_out_to_weights(transitions)
+
+        if exists(prev_structural) and prev_structural.ndim == 3:
+            prev_structural = prev_structural[:, -1]
+
+        return self.rnn(transitions, prev_structural)
+
+# proposed mmTEM
+
+class mmTEM(Module):
+    def __init__(
+        self,
+        dim
+    ):
+        super().__init__()
+
+
+    def forward(
+        self,
+        data
+    ):
+        raise NotImplementedError

hippoformer-0.0.1.dist-info/METADATA

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: hippoformer
+Version: 0.0.1
+Summary: hippoformer
+Project-URL: Homepage, https://pypi.org/project/hippoformer/
+Project-URL: Repository, https://github.com/lucidrains/hippoformer
+Author-email: Phil Wang <lucidrains@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Phil Wang
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: artificial intelligence,deep learning,hippocampus,memory
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9
+Requires-Dist: assoc-scan
+Requires-Dist: einops>=0.8.1
+Requires-Dist: torch>=2.4
+Requires-Dist: x-mlps-pytorch
+Provides-Extra: examples
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/markdown
+
+<img src="./hippoformer-fig6.png" width="400px"></img>
+
+## Hippoformer (wip)
+
+Implementation of [Hippoformer](https://openreview.net/forum?id=hxwV5EubAw), Integrating Hippocampus-inspired Spatial Memory with Transformers
+
+[Temporary Discord](https://discord.gg/MkACrrkrYR)
+
+## Citations
+
+```bibtex
+@inproceedings{anonymous2025hippoformer,
+    title   = {Hippoformer: Integrating Hippocampus-inspired Spatial Memory with Transformers},
+    author  = {Anonymous},
+    booktitle = {Submitted to The Fourteenth International Conference on Learning Representations},
+    year    = {2025},
+    url     = {https://openreview.net/forum?id=hxwV5EubAw},
+    note    = {under review}
+}
+```

hippoformer-0.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+hippoformer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hippoformer/hippoformer.py,sha256=6tA4ZWYKbzclpeTUhJtr2OguVOyyAGFxuLf9bfnfO_M,2682
+hippoformer-0.0.1.dist-info/METADATA,sha256=4hnfh1oIIlcGsIQ7qD7fZHWfM5ltnHhATAPcN-4vkxQ,2773
+hippoformer-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hippoformer-0.0.1.dist-info/licenses/LICENSE,sha256=1yCiA9b5nhslTavxPjsQAO-wpOnwJR9-l8LTVi7GJuk,1066
+hippoformer-0.0.1.dist-info/RECORD,,

hippoformer-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

hippoformer-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Phil Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.