一种用于神经形态计算的软件框架

如果你喜欢 Lava 并希望支持它，最简单的方法就是给我们的仓库点个赞（点击右上角的星标）。

概述

Lava 是一个开源的软件框架，用于开发针对神经形态硬件架构的应用程序。它为开发者提供了抽象层和工具，以构建分布式、大规模并行的应用程序。这些应用程序可以部署到包含传统处理器以及利用事件驱动消息传递进行通信的神经形态芯片的异构系统架构中。Lava 框架包括用于深度学习、约束优化等领域的高级库，以促进高效的算法开发。此外，它还包含将这些算法映射到不同硬件架构的工具。

目前，Lava 支持传统的 CPU 和英特尔的 Loihi 架构，但其编译器和运行时环境对其他架构具有良好的扩展性。

如需了解更多关于 Lava 软件框架的信息，请参阅详细文档：http://lava-nc.org/。

Lava 框架采用宽松的 BSD 3 许可证授权，以高度鼓励社区贡献。而 Lava 中负责将算法映射到不同硬件后端的底层组件，则采用 LGPL-2.1 许可证授权，以防止商业专有分支的出现。特定的支持英特尔 Loihi 等架构的敏感组件可能仍归英特尔所有，并将以扩展形式提供给符合条件的用户。

Lava 对英特尔 Loihi 的扩展

Lava 对 Loihi 的扩展仅适用于英特尔神经形态研究社区（INRC）的成员。该扩展允许在英特尔的 Loihi 硬件平台上运行 Lava。

有意将 Lava 与 Loihi 系统结合使用的开发者需要加入 INRC。Loihi 1 和 2 的研究系统目前尚未商业化。一旦成为 INRC 成员，开发者将获得云端托管的 Loihi 系统的访问权限，或有机会以借用方式获得物理 Loihi 系统。

要加入 INRC，请访问 http://neuromorphic.intel.com 或发送邮件至 inrc_interest@intel.com。

如果您已经是 INRC 成员，请阅读如何开始使用 Lava 对 Loihi 的扩展。此页面仅对 INRC 成员开放。

快速入门

开源的 Lava 软件框架及其配套算法库托管在 http://github.com/lava-nc 上，该框架至少支持 CPU 后端。

请注意，在安装其他 Lava 库（如 lava-optimization 或 lava-dl）之前，应先安装核心 Lava 仓库 lava。

从源码安装 Lava

如果您有兴趣参与 Lava 的开发并修改其源代码，我们建议您克隆仓库，并使用 poetry 来设置 Lava 环境。您需要先安装 poetry Python 包。

打开一个 Python 3 终端，并根据您的操作系统执行以下命令：

Linux/MacOS

cd $HOME
curl -sSL https://install.python-poetry.org | python3 -
git clone git@github.com:lava-nc/lava.git
cd lava
git checkout v0.9.0
./utils/githook/install-hook.sh
poetry config virtualenvs.in-project true
poetry install
source .venv/bin/activate
pytest

## 更多信息请参阅常见问题解答：https://github.com/lava-nc/lava/wiki/Frequently-Asked-Questions-(FAQ)#install

Windows

# 使用 PowerShell 的命令
cd $HOME
git clone git@github.com:lava-nc/lava.git
cd lava
git checkout v0.9.0
python3 -m venv .venv
.venv\Scripts\activate
pip install -U pip
curl -sSL https://install.python-poetry.org | python3 -
poetry config virtualenvs.in-project true
poetry install
pytest

运行单元测试后，您应该会看到如下输出：

$ pytest
============================================== 测试会话开始 ==============================================
平台 linux -- Python 3.8.10, pytest-7.0.1, pluggy-1.0.0
根目录：/home/user/lava，配置文件：pyproject.toml，测试路径：tests
插件：cov-3.0.0
收集了 205 项

tests/lava/magma/compiler/test_channel_builder.py .                                                       [  0%]
tests/lava/magma/compiler/test_compiler.py ........................                                       [ 12%]
tests/lava/magma/compiler/test_node.py ..                                                                 [ 13%]
tests/lava/magma/compiler/builder/test_channel_builder.py .                                               [ 13%]

...... pytest 输出 ...

tests/lava/proc/sdn/test_models.py ........                                                               [ 98%]
tests/lava/proc/sdn/test_process.py ...                                                                   [100%]
=============================================== 警告摘要 ================================================

...... pytest 输出 ...

src/lava/proc/lif/process.py                                                           38      0   100%
src/lava/proc/monitor/models.py                                                        27      0   100%
src/lava/proc/monitor/process.py                                                       79      0   100%
src/lava/proc/sdn/models.py                                                           159      9    94%   199-202, 225-231
src/lava/proc/sdn/process.py                                                           59      0   100%
-----------------------------------------------------------------------------------------------------------------总计
                                                                                     4048    453    89%

已达到 85.0% 的最低测试覆盖率要求。总覆盖率为 88.81%
============================ 199 项通过，6 项跳过，2 条警告，耗时 118.17 秒（0 小时 1 分 58 秒） =============================

替代方案：通过 Conda 安装 Lava

如果您使用 Conda 包管理器，可以直接通过以下命令安装 Lava 包：

conda install lava -c conda-forge

或者使用 Intel 版本的 NumPy 和 SciPy：

conda create -n lava python=3.9 -c intel
conda activate lava
conda install -n lava -c intel numpy scipy
conda install -n lava -c conda-forge lava --freeze-installed

替代方案：从 PyPI 安装 Lava

如果您希望以用户身份安装 Lava，可以通过 PyPI 的二进制包进行安装。不过，这种方式无法运行测试。

打开 Python 终端并执行以下命令：

Windows/MacOS/Linux

python -m venv .venv
source .venv/bin/activate ## 或者在 Windows 上：.venv\Scripts\activate
pip install -U pip
pip install lava-nc

替代方案：从二进制文件安装 Lava

您也可以通过 GitHub Releases 下载发布的 Lava 版本，并以用户身份进行安装。请注意，这种方式同样无法运行测试。

打开 Python 终端并执行以下命令：

Windows/MacOS/Linux

python -m venv .venv
source .venv/bin/activate ## 或者在 Windows 上：.venv\Scripts\activate
pip install -U pip
# 请将下方的 lava-nc-<version>.tar.gz 中的版本号替换为您所需的版本
pip install lava-nc-0.9.0.tar.gz

代码检查、测试、文档和打包

# 安装 Poetry
curl -sSL https://install.python-poetry.org | python3 -
poetry config virtualenvs.in-project true
poetry install
poetry shell

# 运行代码检查
flakeheaven lint src/lava tests

# 运行单元测试
pytest

# 创建分发包
poetry build
#### 构建产物位于 dist/ 目录下

# 运行安全检查
bandit -r src/lava/.

#### 如果安全检查失败，请直接运行 bandit 并格式化输出
bandit -r src/lava/. --format custom --msg-template '{abspath}:{line}: {test_id}[bandit]: {severity}: {msg}'

有关如何编写 Lava 流程、连接它们以及执行代码的深入教程和端到端指南，请参阅 tutorials 目录。

保持联系

如需定期获取 Lava 软件框架的最新进展和发布信息，请 订阅我们的新闻通讯。

Lava 快速上手指南

Lava 是一个用于神经形态计算（Neuromorphic Computing）的开源软件框架。它支持在包含传统处理器和神经形态芯片（如 Intel Loihi）的异构系统上开发分布式、大规模并行应用。

环境准备

• 操作系统: Linux, macOS, 或 Windows (PowerShell)
• Python 版本: Python 3.8 或更高 (推荐 3.9)
• 前置依赖:
  • git: 用于克隆代码仓库
  • poetry: Python 包管理工具（源码安装必需）
  • conda (可选): 如果你偏好使用 Conda 环境

注意: 目前 Lava 核心框架主要支持 CPU 后端。若需使用 Intel Loihi 硬件，需加入 Intel 神经形态研究社区 (INRC) 获取专属扩展。

安装步骤

你可以根据需求选择以下任意一种安装方式。推荐开发者使用“源码安装”以便修改代码和运行测试。

方式一：源码安装（推荐开发者）

此方式适合需要修改 Lava 源码或参与贡献的开发者。

Linux / macOS:

cd $HOME
curl -sSL https://install.python-poetry.org | python3 -
git clone git@github.com:lava-nc/lava.git
cd lava
git checkout v0.9.0
./utils/githook/install-hook.sh
poetry config virtualenvs.in-project true
poetry install
source .venv/bin/activate
pytest

Windows (PowerShell):

cd $HOME
git clone git@github.com:lava-nc/lava.git
cd lava
git checkout v0.9.0
python3 -m venv .venv
.venv\Scripts\activate
pip install -U pip
curl -sSL https://install.python-poetry.org | python3 -
poetry config virtualenvs.in-project true
poetry install
pytest

安装成功后，pytest 将运行单元测试并显示覆盖率报告。

方式二：Conda 安装

如果你使用 Conda 包管理器，可以快速安装稳定版。

conda install lava -c conda-forge

或者配合 Intel 优化的 numpy/scipy 使用：

conda create -n lava python=3.9 -c intel
conda activate lava
conda install -n lava -c intel numpy scipy
conda install -n lava -c conda-forge lava --freeze-installed

方式三：PyPI 安装（仅用户）

如果你只需要使用 Lava 而不需要修改源码或运行测试，可直接通过 pip 安装二进制包。

python -m venv .venv
source .venv/bin/activate 
# Windows 用户请使用: .venv\Scripts\activate

pip install -U pip
pip install lava-nc

基本使用

Lava 的核心概念是 Process（处理单元）和 Connection（连接）。以下是一个最简单的示例，展示如何定义一个进程并运行它。

注：详细教程请参考项目中的 tutorials 目录。

from lava.magma.core.run_conditions import RunSteps
from lava.magma.core.run_configs import Loihi1SimCfg
from lava.proc.lif.process import LIF

# 1. 创建一个简单的神经元进程 (Leaky Integrate-and-Fire)
lif_neuron = LIF(shape=(1,), vth=10.0, du=0.0, dv=0.0)

# 2. 配置运行条件 (例如运行 10 个时间步)
run_condition = RunSteps(num_steps=10)

# 3. 在模拟器后端运行该进程
# Loihi1SimCfg 会自动选择 CPU 模拟后端
lif_neuron.run(condition=run_condition, run_cfg=Loihi1SimCfg())

# 4. 获取结果并停止运行
print("神经元状态:", lif_neuron.v.get())
lif_neuron.stop()

验证安装

如果在源码安装模式下，运行 pytest 后看到类似以下输出，说明安装成功：

============================ 199 passed, 6 skipped, 2 warnings =============================
Required test coverage of 85.0% reached. Total coverage: 88.81%