xlstm

环境要求

• Python 环境（README 提供 conda 环境文件 environment_pt240cu124.yaml）
• PyTorch >= 1.8（README 说明已测试的版本范围）
• 使用 xLSTM Large 7B 时需额外安装 mlstm_kernels 包
• 可选的 conda 或 pip 包管理工具

安装与启动步骤

1. 1创建conda环境

   用仓库提供的 environment_pt240cu124.yaml 创建隔离环境，这是 README 推荐的经过测试的环境。

   conda env create -f environment_pt240cu124.yaml

   复制

2. 2克隆并安装仓库

   从 GitHub 拉取源码并以可编辑模式安装 xlstm 模块，适合需要修改代码的场景。

   git clone https://github.com/NX-AI/xlstm.git
   cd xlstm
   pip install -e .

   复制

3. 3或用pip直接安装

   只想用模型代码、不需要改源码时，直接安装 xlstm 包即可。

   pip install xlstm

   复制

4. 4安装7B依赖内核

   若要使用 xLSTM Large 7B 模型，需先安装官方 mlstm_kernels 内核包。

   pip install mlstm_kernels

   复制

5. 5跑前向传播验证

   按 README 在 notebooks/xlstm_large/demo.ipynb 中的示例，初始化随机模型并做一次前向传播。

   import torch
   from xlstm.xlstm_large.model import xLSTMLargeConfig, xLSTMLarge
   
   # run a forward pass
   out = xlstm(input)
   out.shape[1:] == (256, 2048)

   复制

如何确认成功

执行前向传播后输出张量形状满足 out.shape[1:]==(256, 2048)，即说明安装与模型调用成功。

常见问题

注意事项

• README 中 conda 创建命令被截断，此处按官方环境文件的标准用法补全，请以仓库内文件说明为准。
• 使用 xLSTM Large 7B 前务必先安装 mlstm_kernels，否则单文件实现无法运行。
• 推荐优先用 conda 环境文件复现经过测试的依赖组合，避免自行升级 PyTorch 导致不兼容。