================ 简介

.. |build| image:: https://github.com/jeshraghian/snntorch/actions/workflows/build.yml/badge.svg :target: https://snntorch.readthedocs.io/en/latest/?badge=latest

.. |docs| image:: https://readthedocs.org/projects/snntorch/badge/?version=latest :target: https://snntorch.readthedocs.io/en/latest/?badge=latest

.. |discord| image:: https://img.shields.io/discord/906036932725841941 :target: https://discord.gg/cdZb5brajb

.. |pypi| image:: https://img.shields.io/pypi/v/snntorch.svg :target: https://pypi.python.org/pypi/snntorch

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/snntorch.svg :target: https://anaconda.org/conda-forge/snntorch

.. |downloads| image:: https://static.pepy.tech/personalized-badge/snntorch?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Downloads :target: https://pepy.tech/project/snntorch

.. |neuromorphiccomputing| image:: https://img.shields.io/badge/Collaboration_Network-Open_Neuromorphic-blue :target: https://open-neuromorphic.org/neuromorphic-computing/

|build| |docs| |discord| |pypi| |conda| |downloads| |neuromorphiccomputing|

大脑是寻找灵感以开发更高效神经网络的理想场所。与现代深度学习的主要区别之一在于，大脑通过脉冲而非连续激活来编码信息。 snnTorch 是一个用于执行基于梯度的脉冲神经网络学习的 Python 软件包。 它扩展了 PyTorch 的功能，利用其 GPU 加速的张量计算，并将其应用于脉冲神经元网络。预先设计好的脉冲神经元模型无缝集成到 PyTorch 框架中，可以被视为递归激活单元。

.. image:: https://github.com/jeshraghian/snntorch/blob/master/docs/_static/img/spike_excite_alpha_ps2.gif?raw=true :align: center :width: 800

如果您喜欢这个项目，请考虑为本仓库标上星⭐，这是支持该项目最简单也是最好的方式。

如果您遇到问题、有任何意见，或者正在寻求关于训练脉冲神经网络的建议，您可以在我们的 discord <https://discord.gg/cdZb5brajb>_ 频道中提交问题、发起讨论或进行交流。

snnTorch 结构 ^^^^^^^^^^^^^^^^^^^^^^^^ snnTorch 包含以下组件：

.. list-table:: :widths: 20 60 :header-rows: 1

• • 组件
  • 描述
• • snntorch <https://snntorch.readthedocs.io/en/latest/snntorch.html>_
  • 类似于 torch.nn 的脉冲神经元库，与 autograd 深度集成
• • snntorch.export_nir <https://snntorch.readthedocs.io/en/latest/snntorch.export_nir.html>_
  • 通过 NIR <https://nnir.readthedocs.io/en/latest/>_ 实现与其他 SNN 库的导出功能
• • snntorch.functional <https://snntorch.readthedocs.io/en/latest/snntorch.functional.html>_
  • 针对脉冲的常用算术运算，例如损失函数、正则化等
• • snntorch.import_nir <https://snntorch.readthedocs.io/en/latest/snntorch.import_nir.html>_
  • 通过 NIR <https://nnir.readthedocs.io/en/latest/>_ 实现从其他 SNN 库导入的功能
• • snntorch.spikegen <https://snntorch.readthedocs.io/en/latest/snntorch.spikegen.html>_
  • 用于脉冲生成和数据转换的工具库
• • snntorch.spikeplot <https://snntorch.readthedocs.io/en/latest/snntorch.spikeplot.html>_
  • 使用 matplotlib 和 celluloid 对基于脉冲的数据进行可视化的工具
• • snntorch.surrogate <https://snntorch.readthedocs.io/en/latest/snntorch.surrogate.html>_
  • 可选的替代梯度函数
• • snntorch.utils <https://snntorch.readthedocs.io/en/latest/snntorch.utils.html>_
  • 数据集相关的实用函数

snnTorch 的设计旨在与 PyTorch 相互配合，使用起来直观便捷，仿佛每个脉冲神经元只是序列层中的另一个激活单元。 因此，它对全连接层、卷积层、残差连接等都具有通用性。

目前，神经元模型由递归函数表示，这使得在计算梯度时无需存储系统中所有神经元的膜电位轨迹。 snnTorch 的轻量化特性使其能够在必要时在 CPU 上有效地训练小型和大型网络。 只要将网络模型和张量加载到 CUDA 上，snnTorch 就能像 PyTorch 一样充分利用 GPU 加速。

引用 ^^^^^^^^^^^^^^^^^^^^^^^^ 如果您在工作中发现 snnTorch 很有用，请引用以下文献：

Jason K. Eshraghian, Max Ward, Emre Neftci, Xinxin Wang, Gregor Lenz, Girish Dwivedi, Mohammed Bennamoun, Doo Seok Jeong, and Wei D. Lu “Training Spiking Neural Networks Using Lessons From Deep Learning”. Proceedings of the IEEE, 111(9) September 2023. <https://ieeexplore.ieee.org/abstract/document/10242251>_

.. code-block:: bash

@article{eshraghian2021training, title = {Training spiking neural networks using lessons from deep learning}, author = {Eshraghian, Jason K and Ward, Max and Neftci, Emre and Wang, Xinxin and Lenz, Gregor and Dwivedi, Girish and Bennamoun, Mohammed and Jeong, Doo Seok and Lu, Wei D}, journal = {Proceedings of the IEEE}, volume = {111}, number = {9}, pages = {1016--1054}, year = {2023} }

如果您在任何有趣的工作、研究或博客中使用了 snnTorch，请告知我们，我们非常期待了解更多信息！请发送邮件至 snntorch@gmail.com。

要求 ^^^^^^^^^^^^^^^^^^^^^^^^ 要使用 snnTorch，必须先安装 PyTorch。请确保为您的系统安装正确版本的 PyTorch，以实现 CUDA 兼容性。

如果使用 pip 命令安装，以下软件包会自动安装：

• numpy
• pandas

使用 export_nir 和 import_nir 功能时，需要以下软件包：

• nir>=1.0.6
• nirtorch>=2.0.5

使用 spikeplot 功能时，需要以下软件包：

• matplotlib

安装 ^^^^^^^^^^^^^^^^^^^^^^^^

运行以下命令进行安装：

.. code-block:: bash

$ python $ pip install snntorch

若要从源代码安装 snnTorch：

$ git clone https://github.com/jeshraghian/snntorch $ cd snntorch $ python setup.py install

使用 conda 安装 snnTorch：

$ conda install -c conda-forge snntorch

若要为基于 Graphcore 加速器的智能处理单元（IPU）构建环境安装：

$ pip install snntorch-ipu

API 与示例 ^^^^^^^^^^^^^^^^^^^^^^^^ 完整的 API 文档可在 这里 <https://snntorch.readthedocs.io/>__ 查阅。同时提供示例、教程和 Colab 笔记本。

快速入门 ^^^^^^^^^^^^^^^^^^^^^^^^

.. image:: https://colab.research.google.com/assets/colab-badge.svg :alt: 在 Colab 中打开 :target: https://colab.research.google.com/github/jeshraghian/snntorch/blob/master/examples/quickstart.ipynb

以下是开始使用 snnTorch 的几种方式：

• 快速入门笔记本（在 Colab 中打开）_

• API 参考文档_

• 示例_

• 教程_

.. _快速入门笔记本（在 Colab 中打开）: https://colab.research.google.com/github/jeshraghian/snntorch/blob/master/examples/quickstart.ipynb .. _API 参考文档: https://snntorch.readthedocs.io/ .. _示例: https://snntorch.readthedocs.io/en/latest/examples.html .. _教程: https://snntorch.readthedocs.io/en/latest/tutorials/index.html

要快速运行 snnTorch 示例，请参阅以下代码片段，或尝试运行快速入门笔记本：

.. code-block:: python

import torch, torch.nn as nn import snntorch as snn from snntorch import surrogate from snntorch import utils

num_steps = 25 # 时间步数 batch_size = 1 beta = 0.5 # 神经元衰减率 spike_grad = surrogate.fast_sigmoid() # 替代梯度

net = nn.Sequential( nn.Conv2d(1, 8, 5), nn.MaxPool2d(2), snn.Leaky(beta=beta, init_hidden=True, spike_grad=spike_grad), nn.Conv2d(8, 16, 5), nn.MaxPool2d(2), snn.Leaky(beta=beta, init_hidden=True, spike_grad=spike_grad), nn.Flatten(), nn.Linear(16 * 4 * 4, 10), snn.Leaky(beta=beta, init_hidden=True, spike_grad=spike_grad, output=True) )

data_in = torch.rand(num_steps, batch_size, 1, 28, 28) # 随机输入数据 spike_recording = [] # 记录随时间变化的尖峰信号 utils.reset(net) # 重置/初始化所有神经元的隐藏状态

for step in range(num_steps): # 按时间步循环 spike, state = net(data_in[step]) # 单个时间步的前向传播 spike_recording.append(spike) # 将尖峰信号记录到列表中

SNN 深度解析 ^^^^^^^^^^^^^^^^^^^^^^^^^^^ 如果您希望学习训练脉冲神经网络的所有基础知识，从神经元模型、神经编码到反向传播，snnTorch 教程系列是一个很好的起点。它由交互式笔记本组成，提供了完整的解释，可以帮助您迅速掌握相关知识。

.. list-table:: :widths: 20 60 30 :header-rows: 1

• • 教程
  • 标题
  • Colab 链接
• • 教程 1 <https://snntorch.readthedocs.io/en/latest/tutorials/tutorial_1.html>_
  • 使用 snnTorch 进行尖峰编码
  • .. image:: https://colab.research.google.com/assets/colab-badge.svg :alt: 在 Colab 中打开 :target: https://colab.research.google.com/github/jeshraghian/snntorch/blob/master/examples/tutorial_1_spikegen.ipynb
• • 教程 2 <https://snntorch.readthedocs.io/en/latest/tutorials/tutorial_2.html>_
  • 泄漏积分发放神经元
  • .. image:: https://colab.research.google.com/assets/colab-badge.svg :alt: 在 Colab 中打开 :target: https://colab.research.google.com/github/jeshraghian/snntorch/blob/master/examples/tutorial_2_lif_neuron.ipynb
• • 教程 3 <https://snntorch.readthedocs.io/en/latest/tutorials/tutorial_3.html>_
  • 前馈型脉冲神经网络
  • .. image:: https://colab.research.google.com/assets/colab-badge.svg :alt: 在 Colab 中打开 :target: https://colab.research.google.com/github/jeshraghian/snntorch/blob/master/examples/tutorial_3_feedforward_snn.ipynb
• • 教程 4 <https://snntorch.readthedocs.io/en/latest/tutorials/tutorial_4.html>_
  • 二阶脉冲神经元模型（可选）
  • .. image:: https://colab.research.google.com/assets/colab-badge.svg :alt: 在 Colab 中打开 :target: https://colab.research.google.com/github/jeshraghian/snntorch/blob/master/examples/tutorial_4_advanced_neurons.ipynb
• • 教程 5 <https://snntorch.readthedocs.io/en/latest/tutorials/tutorial_5.html>_
  • 使用 snnTorch 训练脉冲神经网络
  • .. image:: https://colab.research.google.com/assets/colab-badge.svg :alt: 在 Colab 中打开 :target: https://colab.research.google.com/github/jeshraghian/snntorch/blob/master/examples/tutorial_5_FCN.ipynb
• • 教程 6 <https://snntorch.readthedocs.io/en/latest/tutorials/tutorial_6.html>_
  • 卷积脉冲神经网络中的替代梯度下降
  • .. image:: https://colab.research.google.com/assets/colab-badge.svg :alt: 在 Colab 中打开 :target: https://colab.research.google.com/github/jeshraghian/snntorch/blob/master/examples/tutorial_6_CNN.ipynb
• • 教程 7 <https://snntorch.readthedocs.io/en/latest/tutorials/tutorial_7.html>_
  • 使用 Tonic + snnTorch 处理神经形态数据集
  • .. image:: https://colab.research.google.com/assets/colab-badge.svg :alt: 在 Colab 中打开 :target: https://colab.research.google.com/github/jeshraghian/snntorch/blob/master/examples/tutorial_7_neuromorphic_datasets.ipynb

.. list-table:: :widths: 70 40 :header-rows: 1

• • 高级教程
  • Colab 链接
• • 群体编码 <https://snntorch.readthedocs.io/en/latest/tutorials/tutorial_pop.html>_
  • .. image:: https://colab.research.google.com/assets/colab-badge.svg :alt: 在 Colab 中打开 :target: https://colab.research.google.com/github/jeshraghian/snntorch/blob/master/examples/tutorial_pop.ipynb
• • 回归：第一部分——使用 LIF 神经元进行膜电位学习 <https://snntorch.readthedocs.io/en/latest/tutorials/tutorial_regression_1.html>_
  • .. image:: https://colab.research.google.com/assets/colab-badge.svg :alt: 在 Colab 中打开 :target: https://colab.research.google.com/github/jeshraghian/snntorch/blob/master/examples/tutorial_regression_1.ipynb
• • 回归：第二部分——基于回归的递归 LIF 神经元分类 <https://snntorch.readthedocs.io/en/latest/tutorials/tutorial_regression_2.html>_
  • .. image:: https://colab.research.google.com/assets/colab-badge.svg :alt: 在 Colab 中打开 :target: https://colab.research.google.com/github/jeshraghian/snntorch/blob/master/examples/tutorial_regression_2.ipynb
• • 在 IPU 上加速 snnTorch <https://snntorch.readthedocs.io/en/latest/tutorials/tutorial_ipu_1.html>_

  •   —
    

贡献 ^^^^^^^^^^^^^^^^^^^^^^^^ 如果您准备为 snnTorch 做出贡献，可以在此处找到相关说明：此处_。

.. _此处: https://snntorch.readthedocs.io/en/latest/contributing.html

致谢 ^^^^^^^^^^^^^^^^^^^^^^^^ snnTorch 目前由 UCSC 神经形态计算小组 <https://ncg.ucsc.edu>_ 维护。它最初由 Jason K. Eshraghian_ 在 密歇根大学 Lu 实验室_ 开发。

此外，Vincent Sun <https://github.com/vinniesun>、Peng Zhou <https://github.com/pengzhouzp>、Ridger Zhu <https://github.com/ridgerchu>、Alexander Henkes <https://github.com/ahenkes1>、Steven Abreu <https://github.com/stevenabreu7>、Xinxin Wang、Sreyes Venkatesh、gekkom <https://github.com/gekkom> 以及 Emre Neftci 也做出了重要贡献。

.. _杰森·K·埃什拉吉安: https://jasoneshraghian.com .. _卢组（密歇根大学）: https://lugroup.engin.umich.edu/

许可与版权 ^^^^^^^^^^^^^^^^^^^^^^^^ snnTorch 的源代码根据 MIT 许可证的条款发布。 snnTorch 的文档则采用知识共享署名-相同方式共享 3.0 未本地化许可协议（CC BY-SA 3.0 <https://creativecommons.org/licenses/by-sa/3.0/>_）授权。

snntorch 快速上手指南

snntorch 是一个基于 PyTorch 的脉冲神经网络（SNN）库，旨在利用深度学习的方法训练类脑神经网络。它将脉冲神经元模型无缝集成到 PyTorch 框架中，支持 GPU 加速，并允许将神经元视为循环激活单元进行处理。

环境准备

在使用 snntorch 之前，请确保您的系统满足以下要求：

• 操作系统：Linux, macOS, 或 Windows
• Python 版本：建议 Python 3.8+
• 核心依赖：必须预先安装 PyTorch。请根据您的 CUDA 版本安装对应的 torch 版本以启用 GPU 加速。
• 自动安装依赖：numpy, pandas
• 可选依赖：
  • 若需使用数据可视化 (spikeplot)：需安装 matplotlib
  • 若需与其他 SNN 库互操作 (export_nir/import_nir)：需安装 nir>=1.0.6 和 nirtorch>=2.0.5

国内开发者提示：如果下载 PyTorch 或 snntorch 速度较慢，推荐使用清华源或阿里源进行加速。

安装步骤

您可以选择以下任意一种方式进行安装：

方式一：使用 pip 安装（推荐）

直接使用 pip 安装最新版本：

pip install snntorch

国内加速安装（使用清华源）：

pip install snntorch -i https://pypi.tuna.tsinghua.edu.cn/simple

方式二：使用 Conda 安装

如果您使用 Anaconda 或 Miniconda 环境：

conda install -c conda-forge snntorch

方式三：从源码安装

git clone https://github.com/jeshraghian/snnTorch
cd snntorch
python setup.py install

特殊硬件支持

如果您使用的是 Graphcore 的智能处理单元 (IPU)：

pip install snntorch-ipu

基本使用

snntorch 的设计哲学是与 PyTorch 高度兼容。您可以像构建普通神经网络一样构建 SNN，只需将部分层替换为 snn 模块中的神经元层即可。

以下是一个最简单的示例，展示如何构建一个包含卷积层和泄漏积分发放（Leaky Integrate-and-Fire）神经元的网络，并进行时间步迭代推理：

import torch
import torch.nn as nn
import snntorch as snn
from snntorch import surrogate
from snntorch import utils

# 1. 定义超参数
num_steps = 25          # 时间步数量
batch_size = 1          
beta = 0.5              # 神经元衰减率 (leak rate)
spike_grad = surrogate.fast_sigmoid() # 代理梯度函数

# 2. 构建网络
# 注意：snn.Leaky 层可以像普通激活函数一样嵌入到 nn.Sequential 中
net = nn.Sequential(
    nn.Conv2d(1, 8, 5),
    nn.MaxPool2d(2),
    snn.Leaky(beta=beta, init_hidden=True, spike_grad=spike_grad),
    nn.Conv2d(8, 16, 5),
    nn.MaxPool2d(2),
    snn.Leaky(beta=beta, init_hidden=True, spike_grad=spike_grad),
    nn.Flatten(),
    nn.Linear(16 * 4 * 4, 10),
    snn.Leaky(beta=beta, init_hidden=True, spike_grad=spike_grad, output=True)
)

# 3. 准备输入数据 (时间步，批次，通道，高，宽)
data_in = torch.rand(num_steps, batch_size, 1, 28, 28) 

# 4. 初始化/重置神经元状态
utils.reset(net) 

spike_recording = [] # 用于记录每个时间步的脉冲输出

# 5. 时间步迭代前向传播
for step in range(num_steps):
    # 每次传入一个时间步的数据
    spike, state = net(data_in[step]) 
    spike_recording.append(spike)

# 此时 spike_recording 包含了整个时间窗口内的脉冲序列
print(f"模拟完成，共记录 {len(spike_recording)} 个时间步的脉冲数据。")

关键点说明：

• init_hidden=True：告诉神经元层在第一次前向传播时自动初始化膜电位状态。
• utils.reset(net)：在处理新的输入样本前，务必重置网络中所有神经元的隐藏状态（膜电位），否则状态会延续到下一个样本。
• 时间循环：SNN 的核心在于时间维度。通常需要将输入数据按时间步切片，并在循环中逐个传入网络。