feat: add reslstmcell

docs/api/cells.rst

@@ -33,6 +33,7 @@ This page documents all custom recurrent cells provided in the `torchrecurrent.c
    torchrecurrent.OriginalLSTMCell
    torchrecurrent.PeepholeLSTMCell
    torchrecurrent.RANCell
+   torchrecurrent.ResLSTMCell
    torchrecurrent.SCRNCell
    torchrecurrent.SGUCell
    torchrecurrent.SGRNCell

docs/api/layers.rst

@@ -33,6 +33,7 @@ This page documents all custom recurrent layers provided in the `torchrecurrent`
    torchrecurrent.OriginalLSTM
    torchrecurrent.PeepholeLSTM
    torchrecurrent.RAN
+   torchrecurrent.ResLSTM
    torchrecurrent.SCRN
    torchrecurrent.SGU
    torchrecurrent.SGRN

docs/generated/torchrecurrent.ResLSTM.rst

@@ -0,0 +1,8 @@
+torchrecurrent.ResLSTM
+======================
+
+.. currentmodule:: torchrecurrent
+
+.. autoclass:: ResLSTM
+
+   .. automethod:: __init__

docs/generated/torchrecurrent.ResLSTMCell.rst

@@ -0,0 +1,8 @@
+torchrecurrent.ResLSTMCell
+==========================
+
+.. currentmodule:: torchrecurrent
+
+.. autoclass:: ResLSTMCell
+
+   .. automethod:: __init__

docs/models.rst

@@ -95,6 +95,9 @@ references and official implementations where available.
    * - :doc:`RAN <generated/torchrecurrent.RAN>`
      - `arXiv 2017 <https://arxiv.org/abs/1705.07393>`__
      - `kentonl/ran <https://github.com/kentonl/ran>`__
+   * - :doc:`ResLSTM <generated/torchrecurrent.ResLSTM>`
+     - `arXiv 2017 <https://arxiv.org/abs/1701.03360>`__
+     - –
    * - :doc:`SCRN <generated/torchrecurrent.SCRN>`
      - `ICLR 2015 <https://arxiv.org/abs/1412.7753>`__
      - `facebookarchive/SCRNNs <https://github.com/facebookarchive/SCRNNs>`__

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "torchrecurrent"
-version = "0.2.1"
+version = "0.2.2"
 description = "A package for recurrent neural networks in PyTorch"
 readme = "README.md"
 authors = [

tests/test_cells.py

@@ -33,6 +33,7 @@
     OriginalLSTMCell,
     PeepholeLSTMCell,
     RANCell,
+    ResLSTMCell,
     SCRNCell,
     SGUCell,
     SGRNCell,
@@ -68,6 +69,7 @@
     (PeepholeLSTMCell, 5, 10, True),
     (OriginalLSTMCell, 3, 5, True),
     (RANCell, 4, 9, True),
+    (ResLSTMCell, 4, 9, True),
     (SCRNCell, 3, 5, True),
     (SGUCell, 3, 5, False),
     (SGRNCell, 3, 5, False),
@@ -120,6 +122,16 @@ def test_cell_output_and_state_shapes(Cell, in_size, hid_size, double):
         assert h3.shape == (B, hid_size)
 
 
+def test_reslstm_cell_parameter_shapes():
+    cell = ResLSTMCell(4, 9)
+
+    assert cell.weight_ih.shape == (36, 4)
+    assert cell.weight_hh.shape == (36, 9)
+    assert cell.weight_proj.shape == (9, 9)
+    assert cell.weight_res.shape == (9, 4)
+    assert cell.weight_ph.shape == (27,)
+
+
 @pytest.mark.parametrize("Cell, in_size, hid_size, _", CELL_CASES)
 def test_cell_gradients(Cell, in_size, hid_size, _):
     """A quick smoke test: outputs should be differentiable wrt parameters."""

tests/test_layers.py

@@ -25,6 +25,7 @@
     OriginalLSTM,
     PeepholeLSTM,
     RAN,
+    ResLSTM,
     SCRN,
     SGU,
     SGRN,
@@ -57,6 +58,7 @@
     OriginalLSTM,
     PeepholeLSTM,
     RAN,
+    ResLSTM,
     SCRN,
     SGU,
     SGRN,
@@ -90,6 +92,7 @@
     (OriginalLSTM, True),
     (PeepholeLSTM, True),
     (RAN, True),
+    (ResLSTM, True),
     (SCRN, True),
     (SGU, False),
     (SGRN, False),

torchrecurrent/__init__.py

@@ -27,6 +27,7 @@
     OriginalLSTMCell,
     PeepholeLSTMCell,
     RANCell,
+    ResLSTMCell,
     coRNNCell,
     SCRNCell,
     SGUCell,
@@ -64,6 +65,7 @@
     OriginalLSTM,
     PeepholeLSTM,
     RAN,
+    ResLSTM,
     coRNN,
     SCRN,
     SGU,
@@ -127,6 +129,8 @@
     "PeepholeLSTMCell",
     "RAN",
     "RANCell",
+    "ResLSTM",
+    "ResLSTMCell",
     "SCRN",
     "SCRNCell",
     "SGU",

torchrecurrent/cells/__init__.py

@@ -24,6 +24,7 @@
 from .originallstm_cell import OriginalLSTM, OriginalLSTMCell
 from .peepholelstm_cell import PeepholeLSTM, PeepholeLSTMCell
 from .ran_cell import RAN, RANCell
+from .reslstm_cell import ResLSTM, ResLSTMCell
 from .scrn_cell import SCRN, SCRNCell
 from .sgu_cell import DSGU, DSGUCell, SGU, SGUCell
 from .sgrn_cell import SGRN, SGRNCell
@@ -86,6 +87,8 @@
     "PeepholeLSTMCell",
     "RAN",
     "RANCell",
+    "ResLSTM",
+    "ResLSTMCell",
     "SCRN",
     "SCRNCell",
     "DSGU",