log-depth-recurrent-modeling 0.0.1__tar.gz

log_depth_recurrent_modeling-0.0.1/.gitignore

@@ -0,0 +1,220 @@
+*.sh
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

log_depth_recurrent_modeling-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 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.

log_depth_recurrent_modeling-0.0.1/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.5
+Name: log-depth-recurrent-modeling
+Version: 0.0.1
+Summary: Log Depth Recurrent Modeling
+Project-URL: Homepage, https://pypi.org/project/log-depth-recurrent-modeling/
+Project-URL: Repository, https://github.com/lucidrains/log-depth-recurrent-modeling
+Author-email: Phil Wang <lucidrains@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 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
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: einops>=0.8.1
+Requires-Dist: torch-einops-utils>=0.1.30
+Requires-Dist: torch>=2.5
+Requires-Dist: x-mlps-pytorch>=0.6.2
+Provides-Extra: examples
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/markdown
+
+<img src="./ldrlm-fig1.png" width="350px"></img>
+
+## Log Depth Recurrent Modeling (wip)
+
+Explorations into the [Log Depth Recurrent Modeling](https://arxiv.org/abs/2609.28212) proposed by Yiqin Wang of Imperial College London
+
+## Citations
+
+```bibtex
+@misc{wang2026logdepthrecurrentlanguagemodeling,
+    title    = {Log-Depth Recurrent Language Modeling},
+    author   = {Yiqin Wang and Nuri Cingillioglu and Charles Pert},
+    year     = {2026},
+    eprint   = {2609.28212},
+    archivePrefix = {arXiv},
+    primaryClass = {cs.LG},
+    url      = {https://arxiv.org/abs/2609.28212},
+}
+```
+
+```bibtex
+@misc{shen2019orderedmemory,
+    title   = {Ordered Memory},
+    author  = {Yikang Shen and Shawn Tan and Arian Hosseini and Zhouhan Lin and Alessandro Sordoni and Aaron Courville},
+    year    = {2019},
+    eprint  = {1910.13466},
+    archivePrefix = {arXiv},
+    primaryClass = {cs.LG},
+    url     = {https://arxiv.org/abs/1910.13466},
+}
+```
+
+```bibtex
+@misc{pert2026lengthgeneralizationlogdepthrecurrent,
+    title     = {Length Generalization with Log-Depth Recurrent Units},
+    author    = {Charles Pert and Dalal Alrajeh and Alessandra Russo},
+    year      = {2026},
+    eprint    = {2605.26035},
+    archivePrefix = {arXiv},
+    primaryClass = {cs.LG},
+    url       = {https://arxiv.org/abs/2605.26035},
+}
+```

log_depth_recurrent_modeling-0.0.1/README.md

@@ -0,0 +1,43 @@
+<img src="./ldrlm-fig1.png" width="350px"></img>
+
+## Log Depth Recurrent Modeling (wip)
+
+Explorations into the [Log Depth Recurrent Modeling](https://arxiv.org/abs/2609.28212) proposed by Yiqin Wang of Imperial College London
+
+## Citations
+
+```bibtex
+@misc{wang2026logdepthrecurrentlanguagemodeling,
+    title    = {Log-Depth Recurrent Language Modeling},
+    author   = {Yiqin Wang and Nuri Cingillioglu and Charles Pert},
+    year     = {2026},
+    eprint   = {2609.28212},
+    archivePrefix = {arXiv},
+    primaryClass = {cs.LG},
+    url      = {https://arxiv.org/abs/2609.28212},
+}
+```
+
+```bibtex
+@misc{shen2019orderedmemory,
+    title   = {Ordered Memory},
+    author  = {Yikang Shen and Shawn Tan and Arian Hosseini and Zhouhan Lin and Alessandro Sordoni and Aaron Courville},
+    year    = {2019},
+    eprint  = {1910.13466},
+    archivePrefix = {arXiv},
+    primaryClass = {cs.LG},
+    url     = {https://arxiv.org/abs/1910.13466},
+}
+```
+
+```bibtex
+@misc{pert2026lengthgeneralizationlogdepthrecurrent,
+    title     = {Length Generalization with Log-Depth Recurrent Units},
+    author    = {Charles Pert and Dalal Alrajeh and Alessandra Russo},
+    year      = {2026},
+    eprint    = {2605.26035},
+    archivePrefix = {arXiv},
+    primaryClass = {cs.LG},
+    url       = {https://arxiv.org/abs/2605.26035},
+}
+```

log_depth_recurrent_modeling-0.0.1/log_depth_recurrent_modeling/__init__.py

@@ -0,0 +1,7 @@
+from log_depth_recurrent_modeling.ar_grc import (
+    AutoregressiveGatedRecursiveCell
+)
+
+__all__ = [
+    'AutoregressiveGatedRecursiveCell'
+]

log_depth_recurrent_modeling-0.0.1/log_depth_recurrent_modeling/ar_grc.py

@@ -0,0 +1,167 @@
+from __future__ import annotations
+import math
+
+import torch
+from torch import nn
+from torch.nn import Module, Linear, RMSNorm, LayerNorm
+import torch.nn.functional as F
+
+from einops import einsum, rearrange, repeat
+
+from x_mlps_pytorch import create_mlp
+
+from torch_einops_utils import pad_at_dim_to_multiple, pack_with_inverse
+
+# helper functions
+
+def exists(v):
+    return v is not None
+
+def default(*args):
+    for arg in args:
+        if exists(arg):
+            return arg
+    return None
+
+# classes
+
+class GatedRecursiveCell(Module):
+    def __init__(
+        self,
+        dim,
+        dim_hidden = None,
+        activation = nn.SiLU(),
+        depth = 1,
+        use_rmsnorm = True
+    ):
+        super().__init__()
+        dim_out = dim * 4
+        dim_hidden = default(dim_hidden, dim_out)
+
+        self.mlp = create_mlp(
+            dim_in = 2 * dim,
+            dim = dim_hidden,
+            dim_out = dim_out,
+            activation = activation,
+            depth = depth
+        )
+
+        self.norm = RMSNorm(dim) if use_rmsnorm else LayerNorm(dim, bias = False)
+
+    def forward(self, x, y):
+
+        x_gate, y_gate, c_gate, c = self.mlp((x, y)).chunk(4, dim = -1)
+
+        return self.norm(x * x_gate.sigmoid() + y * y_gate.sigmoid() + c_gate.sigmoid() * c)
+
+# main class
+
+class AutoregressiveGatedRecursiveCell(Module):
+    def __init__(
+        self,
+        *,
+        num_tokens,
+        dim_embed,
+        dim,
+        window_size,
+        separate_grc = False,
+        grc_kwargs: dict = dict()
+    ):
+        super().__init__()
+
+        tree_depth = math.log2(window_size)
+        assert tree_depth.is_integer()
+
+        self.dim = dim
+
+        # embed
+
+        self.token_embed = nn.Embedding(num_tokens, dim_embed)
+
+        # project to and from
+
+        self.embed_to_model = Linear(dim_embed, dim)
+        self.model_to_embed = Linear(dim, dim_embed)
+
+        # recursive tree, up and down (blelloch scan)
+
+        self.window_size = window_size
+
+        self.tree_depth = int(tree_depth)
+
+        self.root_hidden = nn.Parameter(torch.randn(dim) * 1e-2)
+
+        self.separate_grc = separate_grc
+        self.up_grc = GatedRecursiveCell(dim = dim, **grc_kwargs)
+        self.down_grc = GatedRecursiveCell(dim = dim, **grc_kwargs) if separate_grc else self.up_grc
+
+    def forward(
+        self,
+        ids,
+        return_loss = False
+    ):
+        up_grc, down_grc, root_hidden = self.up_grc, self.down_grc, self.root_hidden
+
+        if return_loss:
+            ids, labels = ids[:, :-1], ids[:, 1:]
+
+        embeds = self.token_embed(ids)
+
+        x = self.embed_to_model(embeds)
+
+        x, remove_padding = pad_at_dim_to_multiple(x, multiple = self.window_size, dim = -2)
+
+        # divide into window size
+
+        x = rearrange(x, 'b (w n) d -> b w n d', n = self.window_size)
+        x, inverse_pack_window = pack_with_inverse(x, '* n d')
+
+        # up sweep
+
+        curr = x
+        up_hiddens = [x]
+
+        for _ in range(self.tree_depth - 1):
+
+            left, right = rearrange(curr, 'b (h two) d -> two b h d', two = 2)
+            curr = up_grc(left, right)
+
+            up_hiddens.append(curr)
+
+        # down sweep (blelloch)
+
+        curr = repeat(root_hidden, 'd -> b 1 d', b = x.shape[0])
+
+        for _ in range(self.tree_depth):
+            left_up, _ = rearrange(up_hiddens.pop(), 'b (h two) d -> two b h d', two = 2)
+
+            right_carry = down_grc(curr, left_up)
+
+            curr = rearrange([curr, right_carry], 'two b h d -> b (h two) d')
+
+        # include each leaf
+
+        x = down_grc(curr, x)
+
+        # restore window
+
+        x = inverse_pack_window(x)
+        x = rearrange(x, 'b w n d -> b (w n) d')
+
+        # slice out padding
+
+        x = remove_padding(x)
+
+        embeds = self.model_to_embed(x)
+
+        logits = einsum(embeds, self.token_embed.weight, 'b n d, l d -> b n l')
+
+        if not return_loss:
+            return logits
+
+        return F.cross_entropy(rearrange(logits, 'b n l -> b l n'), labels, ignore_index = -1)
+
+# alias
+
+GRC = GatedRecursiveCell
+ARGRC = AutoregressiveGatedRecursiveCell

log_depth_recurrent_modeling-0.0.1/pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = "log-depth-recurrent-modeling"
+version = "0.0.1"
+description = "Log Depth Recurrent Modeling"
+authors = [
+    { name = "Phil Wang", email = "lucidrains@gmail.com" }
+]
+readme = "README.md"
+requires-python = ">= 3.10"
+license = { file = "LICENSE" }
+keywords = [
+    'artificial intelligence',
+    'deep learning'
+]
+
+classifiers = [
+    'Development Status :: 4 - Beta',
+    'Intended Audience :: Developers',
+    'Topic :: Scientific/Engineering :: Artificial Intelligence',
+    'License :: OSI Approved :: MIT License',
+    'Programming Language :: Python :: 3.10',
+]
+
+dependencies = [
+    "einops>=0.8.1",
+    "torch>=2.5",
+    "torch-einops-utils>=0.1.30",
+    "x-mlps-pytorch>=0.6.2"
+]
+
+[project.urls]
+Homepage = "https://pypi.org/project/log-depth-recurrent-modeling/"
+Repository = "https://github.com/lucidrains/log-depth-recurrent-modeling"
+
+[project.optional-dependencies]
+examples = []
+test = [
+    "pytest"
+]
+
+[tool.pytest.ini_options]
+pythonpath = [
+    "."
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.rye]
+managed = true
+dev-dependencies = []
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build]
+include = [
+    "log_depth_recurrent_modeling",
+    "pyproject.toml",
+    "README.md",
+    "LICENSE"
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["log_depth_recurrent_modeling"]