ConvLSTM_pytorch

此文件包含由我和DavideA实现的PyTorch版卷积LSTM。

我们以此实现为基础，对其进行了大量重构，并添加了满足我们需求的新特性。

请注意，在本仓库中我们实现了如下动态：

该动态与原始论文中的略有不同。

使用方法

ConvLSTM模块继承自nn.Module，因此可以像其他任何PyTorch模块一样使用。

ConvLSTM类支持任意数量的层。在这种情况下，可以为每一层指定隐藏维度（即通道数）和卷积核大小。如果指定了多层但只提供了一个值，则该值将被复制应用于所有层。例如，在下面的代码片段中，三层分别具有不同的隐藏维度，但卷积核大小相同。

使用示例：

model = ConvLSTM(input_dim=channels,
                 hidden_dim=[64, 64, 128],
                 kernel_size=(3, 3),
                 num_layers=3,
                 batch_first=True
                 bias=True,
                 return_all_layers=False)

待办事项（进行中...）

• 添加代码注释
• 补充文档
• 在一个玩具问题上添加使用示例
• 实现状态化机制
• ...

免责声明

这仍然是一个正在进行中的项目，远未达到完美状态：如果您发现任何错误，请随时提交Issue。

ConvLSTM_pytorch 快速上手指南

环境准备

• 系统要求：支持 Python 3.x 的操作系统（Linux, macOS, Windows）。
• 前置依赖：
  • PyTorch（建议安装最新稳定版）
  • 确保已配置好 CUDA 环境（如需 GPU 加速）

安装步骤

本项目为单文件实现，无需通过 pip 安装。请直接下载核心代码文件：

1. 从 GitHub 仓库下载 convlstm.py 文件： convlstm.py 下载地址

2. 将 convlstm.py 放置在你的项目目录下，确保可以被导入。

基本使用

ConvLSTM 模块继承自 nn.Module，用法与标准 PyTorch 层一致。它支持任意数量的层，并允许为每层指定不同的隐藏维度（通道数）和卷积核大小。

以下是一个构建三层 ConvLSTM 模型的示例：

from convlstm import ConvLSTM

# 初始化模型
model = ConvLSTM(input_dim=channels,      # 输入通道数
                 hidden_dim=[64, 64, 128], # 每层的隐藏维度（通道数）
                 kernel_size=(3, 3),       # 卷积核大小
                 num_layers=3,             # 层数
                 batch_first=True,         # 输入格式是否为 (batch, seq, channel, height, width)
                 bias=True,                # 是否使用偏置
                 return_all_layers=False)  # 是否返回所有层的输出

# 注意：
# 1. 如果 hidden_dim 或 kernel_size 传入单个值，该值将应用于所有层。
# 2. 输入数据形状需符合 batch_first 设置（默认为 False 时为首维是序列长度）。

参数说明：

• input_dim: 输入数据的通道数。
• hidden_dim: 隐藏状态的通道数。可以是整数（所有层相同）或列表（每层不同）。
• kernel_size: 卷积核尺寸。可以是整数或元组。
• num_layers: ConvLSTM 的堆叠层数。
• batch_first: 若为 True，输入形状为 (batch, seq_len, channels, height, width)；否则为 (seq_len, batch, channels, height, width)。
• return_all_layers: 若为 True，返回所有层的输出状态；否则仅返回最后一层。