# https://github.com/noahgolmant/pytorch-hessian-eigenthings 项目说明书

生成时间：2026-05-16 15:01:33 UTC

## 目录

- [项目简介](#page-project-intro)
- [Hessian 矩阵基础概念](#page-hessian-basics)
- [核心架构设计](#page-core-architecture)
- [曲率算子详解](#page-operators)
- [特征分解算法](#page-algorithms)
- [参数工具模块](#page-param-utils)
- [损失函数模块](#page-loss-functions)
- [HuggingFace 模型集成](#page-huggingface-integration)
- [分布式训练支持 (DDP)](#page-distributed-ddp)
- [安装与配置](#page-installation)

<a id='page-project-intro'></a>

## 项目简介

### 相关页面

相关主题：[Hessian 矩阵基础概念](#page-hessian-basics), [安装与配置](#page-installation)

<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [README.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/README.md)
- [CONTRIBUTING.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/CONTRIBUTING.md)
- [mkdocs.yml](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/mkdocs.yml)
- [hessian_eigenthings/algorithms/lanczos.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/lanczos.py)
- [hessian_eigenthings/operators/hessian.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/hessian.py)
- [hessian_eigenthings/operators/ggn.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/ggn.py)
- [hessian_eigenthings/algorithms/trace.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/trace.py)
- [examples/huggingface_tiny_gpt2.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/examples/huggingface_tiny_gpt2.py)
</details>

# 项目简介

## 概述

pytorch-hessian-eigenthings 是一个专为 PyTorch 模型设计的**Hessian 特征分解高效计算库**。该项目由 UC Berkeley 的 RISELab 开发，旨在为大语言模型（LLM）和深度神经网络的曲率分析提供生产级工具。

资料来源：[README.md:1]()

## 核心定位

该库的核心价值在于解决以下关键问题：

- **Hessian 特征值计算**：在传统方法中，直接计算 Hessian 矩阵的特征分解需要 O(n²) 的存储和 O(n³) 的计算复杂度，对于拥有数十亿参数的现代深度学习模型而言完全不可行
- **曲率算子抽象**：通过定义统一的 `CurvatureOperator` 接口，允许用户在不显式构造 Hessian 矩阵的情况下进行曲率分析
- **多种曲率算子支持**：支持 Hessian、广义 Gauss-Newton（GGN）等多种曲率矩阵的特征分解和迹估计

资料来源：[hessian_eigenthings/operators/hessian.py:1-20]()

## 技术架构

### 模块层次结构

```
hessian_eigenthings/
├── algorithms/          # 特征分解和迹估计算法
│   ├── lanczos.py       # Lanczos 算法（特征值计算）
│   └── trace.py         # Hutchinson / Hutch++ 算法（迹估计）
├── operators/           # 曲率算子实现
│   ├── hessian.py       # Hessian 算子
│   └── ggn.py           # 广义 Gauss-Newton 算子
├── loss_fns/           # 损失函数模块
│   ├── standard.py      # 标准损失函数
│   ├── huggingface.py  # HuggingFace 模型支持
│   └── _fused_ce_hvp.py # 融合的交叉熵 HVP
└── backends/           # 线性代数后端
```

资料来源：[mkdocs.yml:1-20]()

### 设计模式

该项目采用**算子-算法分离**的设计模式：

| 组件 | 职责 | 关键类/函数 |
|------|------|-------------|
| **CurvatureOperator** | 定义曲率矩阵接口，实现 matvec 操作 | `HessianOperator`, `GGNOperator` |
| **LinAlgBackend** | 封装底层向量运算，确保数值稳定性 | `SingleDeviceBackend` |
| **Algorithm** | 纯算法实现，仅依赖算子接口 | `lanczos()`, `hutchinson()`, `hutch_plus_plus()` |

资料来源：[CONTRIBUTING.md:20-30]()

### 工作流程图

```mermaid
graph TD
    A[用户模型 + 数据] --> B[CurvatureOperator]
    B --> C[matvec 操作]
    C --> D{Lanczos 算法 / Hutch++ 算法}
    D --> E[特征值 & 特征向量]
    D --> F[矩阵迹估计]
    
    B --> G[HessianOperator]
    B --> H[GGNOperator]
    
    G --> I[autograd 双反向传播]
    G --> J[有限差分法]
    
    H --> K[分析路径]
    H --> L[autograd 路径]
```

## 核心算子

### HessianOperator

`HessianOperator` 是最基础的曲率算子，直接计算损失函数关于参数的 Hessian 矩阵与向量的乘积（Hessian-Vector Product, HVP）。

**支持的 HVP 计算方法**：

| 方法 | 描述 | 适用场景 |
|------|------|----------|
| `autograd` | 通过 `torch.autograd.grad` 实现精确双反向传播 | 参数规模 ≤ 7B 的单设备分析 |
| `finite_difference` | 中心差分 `(∇L(θ+εv) − ∇L(θ−εv)) / 2ε` | FSDP/HSDP/TP 等分布式训练场景 |

资料来源：[hessian_eigenthings/operators/hessian.py:10-30]()

### GGNOperator

广义 Gauss-Newton（GGN）算子是一种 **Hessian 的正向近似**，计算量更低且数值更稳定。

**两种 matvec 实现路径**：

| 路径 | 原理 | 内存开销 | 支持场景 |
|------|------|----------|----------|
| `analytical`（默认）| 有限差分 JVP + 分析损失 HVP + 单次反向传播 | 匹配单次训练步 | LLM 规模应用 |
| `autograd` | `torch.func.jvp` + 自动双反向 + `torch.func.vjp` | 随输出规模增长 | 任意损失函数 |

资料来源：[hessian_eigenthings/operators/ggn.py:40-60]()

### 融合 CE HVP 优化

针对大词表语言模型的交叉熵损失，库中实现了高度优化的 HVP 核：

| 后端 | 特点 | 性能提升 |
|------|------|----------|
| `triton`（CUDA） | 零中间张量，仅输出缓冲区 | ~3.4x 加速，2x 内存降低 |
| `torch.compile` | Inductor 核融合 | ~2.6x 加速，2x 内存降低 |
| `eager` | 朴素 PyTorch 实现 | 基准参考 |

资料来源：[hessian_eigenthings/loss_fns/_fused_ce_hvp.py:1-50]()

## 核心算法

### Lanczos 算法

Lanczos 算法是计算 **k 个极端特征值**的标准选方法，特别适合稀疏或结构化矩阵。通过 `lanczos_tridiagonal` 生成三对角矩阵，然后通过特征分解恢复目标特征值。

**支持的特征值选择模式**：

| 模式 | 含义 | 典型用途 |
|------|------|----------|
| `LM` | Largest Magnitude | 寻找最大曲率方向 |
| `LA` | Largest Algebraic | 最大特征值 |
| `SA` | Smallest Algebraic | 最小特征值（接近零区域） |

资料来源：[hessian_eigenthings/algorithms/lanczos.py:20-40]()

### 迹估计算法

Hutchinson 和 Hutch++ 算法通过随机投影估计矩阵迹，适用于计算 **Hessian 矩阵的谱范数/条件数**。

```mermaid
graph LR
    A[随机向量 v] --> B[计算 Av]
    B --> C[v^T A v]
    C --> D{重复 m 次}
    D --> E[迹 ≈ (1/m) Σ v_i^T A v_i]
```

资料来源：[hessian_eigenthings/algorithms/trace.py:10-50]()

## 使用示例

### 基本用法（HuggingFace 模型）

```python
from hessian_eigenthings import HessianOperator, lanczos
from hessian_eigenthings.loss_fns import hf_lm_loss

full_op = HessianOperator(model=model, dataloader=dataloader, loss_fn=hf_lm_loss())
eig_full = lanczos(full_op, k=3, max_iter=20, tol=1e-3, seed=0)
```

资料来源：[examples/huggingface_tiny_gpt2.py:40-50]()

### 仅分析注意力层

```python
attn_op = HessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=hf_lm_loss(),
    param_filter=match_names("transformer.h.*.attn.*"),
)
eig_attn = lanczos(attn_op, k=3, max_iter=20, tol=1e-3, seed=0)
```

资料来源：[examples/huggingface_tiny_gpt2.py:55-65]()

## 依赖与环境

### 项目依赖

| 依赖类型 | 核心依赖 | 可选依赖 |
|----------|----------|----------|
| 必须 | `torch`, `curvlinops` | `transformers`, `transformer-lens` |
| 开发 | `pytest`, `ruff`, `black`, `mypy` | `triton` (CUDA) |

资料来源：[CONTRIBUTING.md:8-15]()

### 开发环境配置

```bash
git clone https://github.com/noahgolmant/pytorch-hessian-eigenthings
cd pytorch-hessian-eigenthings
uv sync --group dev --group docs --extra transformers --extra transformer-lens --extra curvlinops
```

## 致谢与引用

该项目由 Noah Golmant、Zhewei Yao、Amir Gholami、Michael Mahoney 和 Joseph Gonzalez 在 UC Berkeley 的 RISELab 开发完成。

**去膨胀功率迭代**基于 [HessianFlow](https://github.com/amirgholami/HessianFlow)（Z. Yao et al., NeurIPS 2018）实现。**加速随机功率迭代**来自 C. De Sa et al. 的研究成果。

引用格式：

```bibtex
@misc{hessian-eigenthings,
    author       = {Noah Golmant and Zhewei Yao and Amir Gholami and Michael Mahoney and Joseph Gonzalez},
    title        = {pytorch-hessian-eigenthings: efficient PyTorch Hessian eigendecomposition},
    month        = oct,
    year         = 2018,
    version      = {1.0},
    url          = {https://github.com/noahgolmant/pytorch-hessian-eigenthings}
}
```

资料来源：[README.md:10-25]()

## 质量保证

项目在 CI 中运行以下检查确保代码质量：

| 检查项 | 命令 | 说明 |
|--------|------|------|
| 代码格式 | `ruff check .` | Python linting |
| 代码风格 | `black --check .` | PEP 8 格式化 |
| 类型检查 | `mypy` | 静态类型验证 |
| 单元测试 | `pytest` | 回归测试 |
| 文档构建 | `mkdocs build --strict` | 文档验证 |

资料来源：[CONTRIBUTING.md:15-25]()

## 适用场景总结

| 场景 | 推荐算子 | 推荐算法 |
|------|----------|----------|
| 小型模型特征分析 | `HessianOperator` | `lanczos()` |
| LLM 曲率分析 | `GGNOperator` (analytical) | `lanczos()` |
| 谱范数估计 | 任意算子 | `hutch_plus_plus()` |
| 分布式训练环境 | `HessianOperator` (finite_difference) | `lanczos()` |
| HuggingFace 模型 | `GGNOperator` + `hf_lm_loss()` | `lanczos()` + `trace()` |

---

<a id='page-hessian-basics'></a>

## Hessian 矩阵基础概念

### 相关页面

相关主题：[项目简介](#page-project-intro), [曲率算子详解](#page-operators), [特征分解算法](#page-algorithms)

<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [hessian_eigenthings/operators/hessian.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/hessian.py)
- [hessian_eigenthings/operators/ggn.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/ggn.py)
- [hessian_eigenthings/algorithms/lanczos.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/lanczos.py)
- [hessian_eigenthings/algorithms/trace.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/trace.py)
- [hessian_eigenthings/loss_fns/huggingface.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/loss_fns/huggingface.py)
- [hessian_eigenthings/loss_fns/_fused_ce_hvp.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/loss_fns/_fused_ce_hvp.py)
- [README.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/README.md)
</details>

# Hessian 矩阵基础概念

## 概述

Hessian 矩阵（海森矩阵）是损失函数的二阶偏导数矩阵，定义为：

$$H_{ij} = \frac{\partial^2 \mathcal{L}}{\partial \theta_i \partial \theta_j}$$

在深度学习中，Hessian 矩阵的**特征值和特征向量**与以下关键问题密切相关：

- **泛化特性**：特征值分布可以揭示模型的收敛状态和泛化能力
- **平坦最小值**：小特征值对应平坦方向，与良好泛化相关
- **曲率信息**：帮助理解损失函数的局部几何结构

资料来源：[README.md:1-20]()

## Hessian 矩阵的核心性质

### 正定与负定

| 性质 | 条件 | 物理意义 |
|------|------|----------|
| 正定 (PSD) | 所有特征值 ≥ 0 | 局部最小值点 |
| 负定 | 所有特征值 ≤ 0 | 局部最大值点 |
| 不定 | 特征值有正有负 | 鞍点 |

资料来源：[hessian_eigenthings/operators/ggn.py:1-30]()

### Hessian 与广义高斯-牛顿 (GGN) 的关系

对于机器学习中的损失函数，广义高斯-牛顿矩阵 G 是 Hessian 的良好近似：

$$G = J^T H_{loss} J$$

其中 $J$ 是模型输出的雅可比矩阵。GGN 矩阵具有以下特性：

- **计算效率更高**：避免了 Hessian 的直接计算
- **始终正定**：Hessian 的近似版本，可用于曲率分析
- **Fisher 信息矩阵等价性**：对于交叉熵损失 + softmax，GGN 等于 Fisher 信息矩阵

资料来源：[hessian_eigenthings/operators/ggn.py:1-35]()

## 为什么使用 HVP 而非完整 Hessian

### 计算复杂度对比

| 方法 | 空间复杂度 | 时间复杂度 | 适用场景 |
|------|------------|------------|----------|
| 完整 Hessian | O(n²) | O(n²) | 小模型 (< 1M 参数) |
| Hessian 向量积 (HVP) | O(n) | O(k×n) | 大规模模型 |

其中 n 是参数数量，k 是向量积调用次数。

资料来源：[CONTRIBUTING.md:1-30]()

### 两种 HVP 计算方法

```python
class HessianOperator:
    """支持两种 HVP 计算方法"""
    
    def __init__(self, ..., method: HvpMethod = "autograd"):
```

| 方法 | 描述 | 精度 | 内存占用 | 适用场景 |
|------|------|------|----------|----------|
| `autograd` | 通过 `torch.autograd.grad` 的精确双重反向传播 | 数值精确（舍入精度） | 较高 | 单设备分析至 ~7B 参数 |
| `finite_difference` | 中心差分 `(∇L(θ+εv) − ∇L(θ−εv)) / 2ε` | O(ε²) 截断误差 | 低 | FSDP/HSDP/TP 分布式训练 |

资料来源：[hessian_eigenthings/operators/hessian.py:1-40]()

## 架构设计

### 核心组件关系

```mermaid
graph TD
    A[用户代码] --> B[CurvatureOperator 基类]
    B --> C[HessianOperator]
    B --> D[GGNOperator]
    B --> E[EmpiricalFisherOperator]
    
    F[LinAlgBackend] --> C
    F --> D
    F --> E
    
    G[Lanczos 算法] --> H[特征值分解]
    G --> I[Ritz 向量]
    
    J[Trace 估计] --> K[Hutchinson]
    J --> L[Hutch++]
    
    C --> G
    D --> G
    E --> G
```

资料来源：[CONTRIBUTING.md:1-25]()

### 算子-算法分离设计

```
┌─────────────────────────────────────────────────────────┐
│                      算法层                              │
│  ┌─────────────┐  ┌─────────────┐  ┌─────────────────┐ │
│  │  Lanczos    │  │ Trace 估计   │  │ 谱密度估计      │ │
│  └──────┬──────┘  └──────┬──────┘  └────────┬────────┘ │
└─────────┼────────────────┼──────────────────┼──────────┘
          │                │                  │
          ▼                ▼                  ▼
┌─────────────────────────────────────────────────────────┐
│                    CurvatureOperator                     │
│              (抽象基类 - 所有曲率算子的接口)                │
└─────────────────────────────────────────────────────────┘
          │
          ▼
┌─────────────────────────────────────────────────────────┐
│                      后端层                              │
│  ┌─────────────────────────────────────────────────────┐│
│  │                   LinAlgBackend                      ││
│  │         (统一的向量运算接口)                          ││
│  └─────────────────────────────────────────────────────┘│
└─────────────────────────────────────────────────────────┘
```

资料来源：[hessian_eigenthings/algorithms/lanczos.py:1-30]()

## Hessian 特征值分解的计算流程

```mermaid
graph LR
    A[初始化向量 v₀] --> B[Lanczos 迭代]
    B --> C{收敛判断}
    C -->|未收敛| D[正交化 v]
    D --> B
    C -->|收敛| E[构建三对角矩阵 T]
    E --> F[特征值分解: T = QΛQᵀ]
    F --> G[Ritz 值 ≈ 真实特征值]
    G --> H[Ritz 向量 = VQ]
```

资料来源：[hessian_eigenthings/algorithms/lanczos.py:1-60]()

## 交叉熵损失 HVP 的融合实现

### 数学推导

对于 softmax 输出的交叉熵损失，Hessian 向量积具有闭式解：

$$H_{loss} @ u = \left( p \cdot u - p \cdot \langle p, u \rangle \right) \cdot \frac{mask}{n_{valid}}$$

其中 $p = softmax(logits)$ 是预测概率分布。

资料来源：[hessian_eigenthings/loss_fns/_fused_ce_hvp.py:1-35]()

### 融合策略对比

| 实现方式 | 中间张量数量 | 内存占用 (N=16384, V=50304, fp32) | 加速比 |
|----------|--------------|-----------------------------------|--------|
| Eager | ~6 个 (N,V) 张量 | ~19.6 GB | 1x |
| torch.compile | ~1 个 (N,V) 张量 | ~3.3 GB | ~2.6x |
| Triton | 0 个中间张量 | ~1.6 GB | ~3.4x |

资料来源：[hessian_eigenthings/loss_fns/huggingface.py:1-50]()

## 主要 API 接口

### HessianOperator

```python
class HessianOperator:
    def __init__(
        self,
        model: nn.Module,
        dataloader: Iterable[Any],
        loss_fn: LossFn,
        *,
        param_filter: ParamFilter | None = None,
        full_dataset: bool = True,
        num_batches: int | None = None,
        method: HvpMethod = "autograd",
        fd_eps: float | None = None,
        backend: LinAlgBackend[torch.Tensor] | None = None,
    ) -> None:
```

| 参数 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| `model` | nn.Module | 必需 | PyTorch 模型 |
| `dataloader` | Iterable | 必需 | 数据加载器 |
| `loss_fn` | LossFn | 必需 | 损失函数 |
| `param_filter` | ParamFilter | None | 参数过滤函数 |
| `method` | HvpMethod | "autograd" | HVP 计算方法 |
| `full_dataset` | bool | True | 是否使用完整数据集 |

资料来源：[hessian_eigenthings/operators/hessian.py:1-35]()

### GGNOperator

```python
class GGNOperator:
    def __init__(
        self,
        model: nn.Module,
        dataloader: Iterable[Any],
        forward_fn: ForwardFn,
        loss_of_output_fn: LossOfOutputFn,
        *,
        loss_hvp: GgnHvpMethod = "analytical",
    ):
```

| 参数 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| `loss_hvp` | GgnHvpMethod | "analytical" | GGN HVP 计算方法 |

资料来源：[hessian_eigenthings/operators/ggn.py:1-45]()

## 特征值选择模式

Lanczos 算法支持多种特征值选择策略：

| 模式 | 含义 | 用途 |
|------|------|------|
| `"LM"` | Largest Magnitude | 寻找最大特征值（最尖锐方向） |
| `"LA"` | Largest Algebraic | 寻找最大代数特征值 |
| `"SA"` | Smallest Algebraic | 寻找最小特征值（最平坦方向） |

```python
eig_result = lanczos(operator, k=10, which="LM", max_iter=100)
```

资料来源：[hessian_eigenthings/algorithms/lanczos.py:1-70]()

## Trace 估计方法

### Hutchinson 方法

通过蒙特卡洛采样估计矩阵的迹：

$$\text{tr}(A) \approx \frac{1}{m} \sum_{i=1}^{m} v_i^T A v_i$$

其中 $v_i$ 是随机向量（Rademacher 或 Gaussian 分布）。

资料来源：[hessian_eigenthings/algorithms/trace.py:1-40]()

### Hutch++ 方法

改进的采样策略，提供更低的方差估计：

$$\text{tr}(A) = \mathbb{E}[v^T A v] - \mathbb{E}[g^T A g] + \mathbb{E}[w^T A w]$$

其中 $g$ 和 $w$ 是特殊的偏向采样向量。

| 方法 | 采样数量 | 方差 | 适用场景 |
|------|----------|------|----------|
| Hutchinson | O(m) | 较高 | 快速估计 |
| Hutch++ | O(2m) | 较低 | 精确估计 |

## 使用示例

### 基本特征值计算

```python
from hessian_eigenthings import HessianOperator, lanczos

# 定义模型和数据
model = MyModel()
dataloader = DataLoader(dataset, batch_size=32)

# 创建 Hessian 算子
hessian_op = HessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=loss_fn,
)

# 计算 top-k 特征值
eig_result = lanczos(hessian_op, k=10, max_iter=100, seed=42)

print(f"Top eigenvalues: {eig_result.eigenvalues}")
```

### 注意力机制子空间分析

```python
# 只计算注意力参数的 Hessian
attn_op = HessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=loss_fn,
    param_filter=match_names("blocks.*.attn.*"),
)

eig_attn = lanczos(attn_op, k=3, max_iter=20)
```

资料来源：[examples/transformer_lens_attention_only.py:1-45]()

## 与其他工具的集成

| 外部库 | 集成方式 | 用途 |
|--------|----------|------|
| FSDP/HSDP | `method="finite_difference"` | 分布式训练中的 Hessian 分析 |
| DeepSpeed | 通过参数过滤 | 特定参数组的曲率分析 |
| Transformer-Lens | 自定义 dataloader | Attention-only 分析 |
| HuggingFace Transformers | `hf_lm_loss()` | 语言模型 Hessian |

资料来源：[hessian_eigenthings/loss_fns/huggingface.py:1-60]()

## 扩展阅读

- **概念页面**：算法原理、适用场景
- **操作指南**：具体用户工作流程
- **参考页面**：自动生成的 API 文档

资料来源：[CONTRIBUTING.md:1-35]()

---

<a id='page-core-architecture'></a>

## 核心架构设计

### 相关页面

相关主题：[曲率算子详解](#page-operators), [特征分解算法](#page-algorithms), [参数工具模块](#page-param-utils)

<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [hessian_eigenthings/__init__.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/__init__.py)
- [hessian_eigenthings/operators/base.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/base.py)
- [hessian_eigenthings/operators/hessian.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/hessian.py)
- [hessian_eigenthings/operators/ggn.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/ggn.py)
- [hessian_eigenthings/algorithms/lanczos.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/lanczos.py)
- [hessian_eigenthings/algorithms/trace.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/trace.py)
- [hessian_eigenthings/linalg/backend.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/linalg/backend.py)
- [hessian_eigenthings/batching.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/batching.py)
</details>

# 核心架构设计

## 概述

`pytorch-hessian-eigenthings` 是一个用于计算 PyTorch 模型 Hessian 矩阵特征分解的高效可扩展库。该项目的核心架构遵循**算子-算法分离**设计模式，通过抽象的曲率算子（Curvature Operator）接口连接不同的曲率矩阵实现与特征分解算法。

架构的核心设计理念：

- **模块化**：曲率矩阵（Hessian、GGN、Fisher）通过统一接口暴露
- **可扩展性**：新增曲率矩阵只需实现 `CurvatureOperator` 基类
- **算法无关性**：特征分解算法（Lanczos、Hutchinson、Hutch++）可作用于任意曲率算子
- **硬件适配**：通过 `LinAlgBackend` 抽象支持多设备（CPU/GPU/MPS）

资料来源：[CONTRIBUTING.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/CONTRIBUTING.md)

## 架构总览

### 系统组件图

```mermaid
graph TB
    subgraph "用户层"
        U[用户代码]
    end
    
    subgraph "算法层"
        LZ[Lanczos 算法]
        HC[Hutchinson 算法]
        HP[Hutch++ 算法]
        SLQ[Stochastic Lanczos Quadrature]
    end
    
    subgraph "算子层"
        HO[HessianOperator]
        GGN[GGNOperator]
        EF[EmpiricalFisherOperator]
    end
    
    subgraph "后端层"
        BE[LinAlgBackend]
        SD[SingleDeviceBackend]
        MD[MultiDeviceBackend]
    end
    
    U --> LZ
    U --> HC
    U --> HP
    U --> SLQ
    
    LZ --> HO
    HC --> HO
    HP --> HO
    SLQ --> HO
    
    LZ --> GGN
    LZ --> EF
    
    HO --> BE
    GGN --> BE
    EF --> BE
    
    BE --> SD
    BE --> MD
```

### 核心接口契约

| 组件 | 职责 | 关键方法 |
|------|------|----------|
| `CurvatureOperator` | 定义曲率矩阵算子接口 | `matvec(v)` |
| `LinAlgBackend` | 封装向量运算 | `dot()`, `norm()`, `axpy()` |
| 算法函数 | 执行特征分解 | `lanczos()`, `hutchinson()`, `hutch_plus_plus()` |

资料来源：[hessian_eigenthings/operators/base.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/base.py)

## CurvatureOperator 基类

### 抽象接口定义

`CurvatureOperator` 是整个库的核心抽象，所有曲率矩阵（Hessian、广义 Gauss-Newton、Fisher 等）都必须继承此类并实现 `matvec(v)` 方法。

```python
class CurvatureOperator(ABC):
    @property
    @abstractmethod
    def dtype(self) -> torch.dtype: ...
    
    @property
    @abstractmethod
    def device(self) -> torch.device: ...
    
    @property
    @abstractmethod
    def size(self) -> int: ...
    
    @abstractmethod
    def matvec(self, v: torch.Tensor) -> torch.Tensor: ...
```

核心方法说明：

| 方法 | 输入 | 输出 | 说明 |
|------|------|------|------|
| `matvec(v)` | 维度为 `size` 的向量 | 维度为 `size` 的向量 | 计算曲率矩阵与向量的乘积（矩阵-向量乘积） |
| `dtype` | - | `torch.dtype` | 算子的数据类型 |
| `device` | - | `torch.device` | 算子所在设备 |
| `size` | - | `int` | 参数空间的维度（即模型参数总数） |

### 向量展开与重塑机制

算子内部维护参数列表及其形状信息，用于在扁平向量与原始参数结构之间转换：

```python
class CurvatureOperator:
    def _unflatten(self, v: torch.Tensor) -> dict[str, torch.Tensor]:
        offset = 0
        out = {}
        for n, p, sz in zip(self._param_names, self._param_list, self._sizes, strict=True):
            out[n] = v[offset : offset + sz].reshape_as(p)
            offset += sz
        return out
```

此机制确保算法层始终操作扁平的 1-D 向量，而算子层负责与模型的原始参数结构交互。

资料来源：[hessian_eigenthings/operators/base.py:1-100](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/base.py)

## LinAlgBackend 线性代数后端

### 后端抽象层

`LinAlgBackend` 是一个泛型抽象类，封装了所有向量运算操作。这种设计使得：

1. 单设备场景使用标准 PyTorch 操作
2. 多设备/分布式场景可注入自定义实现
3. 测试时可注入模拟后端进行单元测试

```python
class LinAlgBackend(ABC, Generic[V]):
    @abstractmethod
    def dot(self, a: V, b: V) -> torch.Tensor: ...
    
    @abstractmethod
    def norm(self, a: V) -> torch.Tensor: ...
    
    @abstractmethod
    def axpy(self, a: torch.Tensor, x: V, y: V) -> V: ...
    
    @abstractmethod
    def zero(self, shape: int) -> V: ...
```

### 单设备后端实现

`SingleDeviceBackend` 是默认后端实现，直接委托给 PyTorch 张量操作：

| 方法 | 实现 | 说明 |
|------|------|------|
| `dot(a, b)` | `torch.dot(a.flatten(), b.flatten())` | 向量点积 |
| `norm(a)` | `torch.linalg.vector_norm(a)` | L2 范数 |
| `axpy(a, x, y)` | `a * x + y` | 标量-向量乘加 |
| `zero(shape)` | `torch.zeros(shape, ...) ` | 创建零向量 |

资料来源：[hessian_eigenthings/linalg/backend.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/linalg/backend.py)

## HessianOperator 实现

### 架构设计

`HessianOperator` 是 Hessian 矩阵的算子实现，支持两种 HVP（Hamiltonian-Vector Product）计算方法：

```mermaid
graph LR
    A[输入向量 v] --> B{method 参数}
    B -->|"autograd"| C[双反向传播]
    B -->|"finite_difference"| D[有限差分]
    
    C --> E[create_graph=True]
    C --> F[梯度 → 二阶导]
    E --> G[H_loss · v]
    
    D --> H[L θ+εv]
    D --> I[L θ-εv]
    H --> J[(∇L₊ - ∇L₋) / 2ε]
    I --> J
    J --> G
```

### 两种方法的对比

| 特性 | `autograd` | `finite_difference` |
|------|------------|---------------------|
| 数值精度 | 精确（浮点舍入内） | O(ε²) 截断误差 |
| 内存占用 | 较大（需构建反向图） | 较小（仅两次前反向） |
| FSDP/HSDP/TP 兼容性 | 需特殊处理 | 原生支持 |
| 适用场景 | 7B 参数以下单机分析 | 大规模分布式训练 |

资料来源：[hessian_eigenthings/operators/hessian.py:1-80](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/hessian.py)

## GGNOperator 实现

### Generalized Gauss-Newton 近似

GGN（广义 Gauss-Newton）矩阵是 Hessian 的正向定矩阵近似，其定义为：

```
G = J^T · H_loss · J
```

其中 `J` 是损失函数相对于模型输出的雅可比矩阵，`H_loss` 是损失函数的 Hessian。

### 双路径 HVP 计算

GGNOperator 支持两种 HVP 计算路径：

```python
if loss_hvp == "analytical":
    # 分析路径：有限差分 JVP + 解析 H_loss HVP + 单次反向
    # 内存占用匹配一次正常训练步
else:
    # autograd 路径：torch.func.jvp + 双反向 + vjp
    # 数值精确但内存随输出维度扩展
```

| 路径 | `loss_hvp` 参数 | 内存特性 | 精度 |
|------|----------------|----------|------|
| 分析路径 | `"analytical"` | 与训练步相同 | 有限差分精度 |
| 自动微分路径 | `"autograd"` | O(vocab_size) | 精确 |

资料来源：[hessian_eigenthings/operators/ggn.py:1-60](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/ggn.py)

## 批处理机制

### Microbatch 支持

对于大数据集场景，算子支持将数据分成多个 microbatch 分别计算后聚合：

```python
class HessianOperator:
    def __init__(
        self,
        model: nn.Module,
        dataloader: Iterable[Any],
        loss_fn: LossFn,
        *,
        microbatch_size: int | None = None,
        num_batches: int | None = None,
    ): ...
```

批处理流程：

```mermaid
graph TD
    A[完整数据集] --> B{microbatch_size?}
    B -->|是| C[分割为 N 个 microbatch]
    B -->|否| D[使用完整 dataloader]
    
    C --> E[对每个 microbatch 计算 HVP]
    D --> F[计算 HVP]
    
    E --> G[加权求和]
    F --> G
```

### 参数过滤

通过 `param_filter` 函数可以选择性地只对模型的部分参数构造算子：

```python
# 示例：只对注意力层参数构造 Hessian
attn_op = HessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=loss_fn,
    param_filter=match_names("transformer.h.*.attn.*"),
)
```

资料来源：[hessian_eigenthings/batching.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/batching.py)

## Lanczos 算法实现

### 算法核心流程

Lanczos 算法是计算 Hessian 特征分解的核心算法，该实现具有以下特性：

```mermaid
graph LR
    A[初始向量 v₀] --> B[Lanczos 迭代]
    B --> C[生成三对角矩阵 T]
    C --> D[特征分解 T]
    D --> E[Ritz 值 = 特征值近似]
    D --> F[Ritz 向量 = 特征向量近似]
```

### 特征向量累积优化

代码使用 rank-1 外积更新直接累积 Ritz 向量，避免了临时的大矩阵分配：

```python
# 直接累积到最终 (k, n) 布局，避免 (n, m) 基底矩阵和转置拷贝
eigenvectors = torch.zeros(sel.shape[0], n, dtype=operator.dtype, device=operator.device)
for j, basis_vec in enumerate(td.basis):
    eigenvectors.addr_(s_sel[j], basis_vec)
```

### 关键参数

| 参数 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| `k` | int | - | 返回的特征值数量 |
| `max_iter` | int | - | 最大迭代次数 |
| `tol` | float | 1e-5 | 收敛阈值 |
| `which` | str | "LM" | 选择策略（LM/LA/SA） |
| `seed` | int | None | 随机种子 |

`which` 参数说明：
- `"LM"`: Largest Magnitude（绝对值最大）
- `"LA"`: Largest Algebraic（代数最大）
- `"SA"`: Smallest Algebraic（代数最小）

资料来源：[hessian_eigenthings/algorithms/lanczos.py:1-80](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/lanczos.py)

## 追踪估计算法

### Hutchinson 估计器

Hutchinson 方法通过随机采样估计矩阵迹：

```
tr(A) ≈ (1/m) Σ vᵢᵀ A vᵢ
```

其中 `vᵢ` 是 Rademacher 或 Gaussian 分布的随机向量。

### Hutch++ 改进算法

Hutch++ 通过更智能的采样策略降低方差：

| 算法 | 采样数量 | 方差特性 | 适用场景 |
|------|----------|----------|----------|
| Hutchinson | m | O(1/√m) | 通用 |
| Hutch++ | ⌈3m/2⌉ | O(1/m) | 高精度需求 |

资料来源：[hessian_eigenthings/algorithms/trace.py:1-60](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/trace.py)

## 完整调用流程

### 端到端工作流

```mermaid
sequenceDiagram
    participant User as 用户代码
    participant Op as CurvatureOperator
    participant Algo as 算法函数
    participant Backend as LinAlgBackend
    
    User->>Op: 创建算子实例
    Op->>Backend: 注册后端
    User->>Algo: 调用 lanczos/trac e
    Algo->>Op: 调用 matvec(v)
    Op->>Backend: 执行向量运算
    Backend-->>Op: 返回结果
    Op-->>Algo: 返回 HVP
    Algo-->>User: 返回特征值/向量
```

### 典型使用示例

```python
# 1. 创建 Hessian 算子
hessian_op = HessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=loss_fn,
)

# 2. 调用 Lanczos 算法
result = lanczos(hessian_op, k=10, max_iter=50)

# 3. 获取特征值和特征向量
eigenvalues = result.eigenvalues
eigenvectors = result.eigenvectors
```

资料来源：[examples/huggingface_tiny_gpt2.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/examples/huggingface_tiny_gpt2.py)

## 扩展机制

### 新增曲率算子

要添加新的曲率矩阵（如 Fisher 信息矩阵），只需继承 `CurvatureOperator` 并实现 `matvec` 方法：

```python
class MyCurvatureOperator(CurvatureOperator):
    def __init__(self, model, dataloader, ...):
        super().__init__()
        # 初始化参数列表等
        
    @property
    def dtype(self) -> torch.dtype:
        return self._param_list[0].dtype
    
    def matvec(self, v: torch.Tensor) -> torch.Tensor:
        # 实现矩阵-向量乘积
        return ...
```

### 新增算法

算法通过 `CurvatureOperator` 接口与所有算子兼容，无需修改：

```python
def my_algorithm(operator: CurvatureOperator, **kwargs) -> MyResult:
    # operator.matvec(v) 可用于任意曲率算子
    ...
```

资料来源：[CONTRIBUTING.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/CONTRIBUTING.md)

## 总结

`pytorch-hessian-eigenthings` 的核心架构以**算子-算法分离**为核心设计原则，通过抽象的 `CurvatureOperator` 接口连接曲率矩阵实现与特征分解算法。这种设计使得：

1. **代码复用**：不同算法可作用于同一算子
2. **易于扩展**：新增曲率矩阵或算法无需修改现有代码
3. **硬件适配**：通过后端抽象支持多设备场景
4. **内存优化**：不同实现路径（autograd vs analytical）可权衡精度与内存

整个库的架构简洁而高效，核心文件仅包含算子基类、算法实现和后端抽象三个主要层次，配合专门的损失函数模块完成特定任务的优化。

---

<a id='page-operators'></a>

## 曲率算子详解

### 相关页面

相关主题：[核心架构设计](#page-core-architecture), [特征分解算法](#page-algorithms), [分布式训练支持 (DDP)](#page-distributed-ddp)

<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [hessian_eigenthings/operators/__init__.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/__init__.py)
- [hessian_eigenthings/operators/hessian.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/hessian.py)
- [hessian_eigenthings/operators/ggn.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/ggn.py)
- [hessian_eigenthings/operators/fisher.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/fisher.py)
- [hessian_eigenthings/operators/distributed/ddp.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/distributed/ddp.py)
- [docs/reference/operators.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/docs/reference/operators.md)
</details>

# 曲率算子详解

曲率算子（Curvature Operator）是 pytorch-hessian-eigenthings 项目的核心抽象，封装了对任意 PyTorch 模型进行曲率矩阵（如 Hessian、广义 Gauss-Newton 矩阵、Fisher 信息矩阵）矩阵-向量乘积（matvec）的计算逻辑。通过将曲率矩阵的操作抽象为统一的算子接口，该项目得以支持多种高效的算法（如 Lanczos、随机幂迭代、Hutchinson/Hutch++ 迹估计），而无需关心底层曲率矩阵的具体实现细节。

## 1. 架构概述

曲率算子系统采用**算子模式**（Operator Pattern）设计，所有曲率算子均继承自 `CurvatureOperator` 基类，暴露统一的 `matvec(v)` 接口。算法模块仅依赖此接口，从而实现曲率矩阵计算与特征值分解、迹估计等操作的解耦。

```mermaid
graph TD
    subgraph "用户层"
        A["HessianOperator"] --> B["GGNOperator"]
        A --> C["FisherOperator"]
        C --> D["EmpiricalFisherOperator"]
    end
    
    subgraph "抽象基类"
        E["CurvatureOperator<br/>size: int<br/>dtype: dtype<br/>device: device<br/>matvec(v) → Av"]
    end
    
    subgraph "算法层"
        F["lanczos()"]
        G["power_iteration()"]
        H["trace()"]
        I["spectral_density()"]
    end
    
    subgraph "后端层"
        J["LinAlgBackend<br/>SingleDeviceBackend<br/>DistributedBackend"]
    end
    
    A --> E
    B --> E
    C --> E
    D --> E
    E --> J
    F --> E
    G --> E
    H --> E
    I --> E
```

## 2. 基类设计：CurvatureOperator

`CurvatureOperator` 是所有曲率算子的抽象基类，定义了算子的通用接口和属性。

### 2.1 核心属性

| 属性 | 类型 | 说明 |
|------|------|------|
| `size` | `int` | 模型中被纳入计算的参数总数 |
| `dtype` | `torch.dtype` | 算子的数据类型 |
| `device` | `torch.device` | 算子所在的设备 |

### 2.2 核心方法

```python
class CurvatureOperator(ABC):
    @abstractmethod
    def matvec(self, v: torch.Tensor) -> torch.Tensor:
        """计算曲率矩阵与向量 v 的乘积 Av，返回形状与 v 相同"""
        ...
```

`matvec` 方法接收一个展平后的参数向量 `v`（形状为 `(size,)`），返回曲率矩阵与 `v` 的乘积结果。该方法内部处理参数重排、梯度计算、重塑等逻辑，对外保持一致的接口。

资料来源：[hessian_eigenthings/operators/__init__.py]()

## 3. HessianOperator

`HessianOperator` 用于计算损失函数关于模型参数的 Hessian 矩阵与向量的乘积。

### 3.1 数学背景

Hessian 矩阵定义为损失函数对参数的二阶导数矩阵：

$$H = \nabla_\theta^2 \mathcal{L}(\theta)$$

对于神经网络，直接构建完整的 Hessian 矩阵成本高昂（参数可达数十亿），因此 `HessianOperator` 仅实现矩阵-向量乘积 `Hv`，支持后续的特征值分解等分析操作。

### 3.2 初始化参数

| 参数 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| `model` | `nn.Module` | 必选 | 待分析的 PyTorch 模型 |
| `dataloader` | `Iterable[Any]` | 必选 | 数据加载器，用于迭代数据批次 |
| `loss_fn` | `LossFn` | 必选 | 损失函数，签名 `Callable[[Tensor, Any], Tensor]` |
| `param_filter` | `ParamFilter \| None` | `None` | 参数过滤器，仅对匹配参数计算曲率 |
| `full_dataset` | `bool` | `True` | 是否对整个数据集求平均 |
| `num_batches` | `int \| None` | `None` | 使用的批次数，`None` 表示全部 |
| `microbatch_size` | `int \| None` | `None` | 微批次大小 |
| `microbatch_unsafe` | `bool` | `False` | 是否跳过微批次安全检查 |
| `method` | `HvpMethod` | `"autograd"` | HVP 计算方法 |
| `fd_eps` | `float \| None` | `None` | 有限差分方法的步长 |
| `backend` | `LinAlgBackend \| None` | `None` | 线性代数后端 |

资料来源：[hessian_eigenthings/operators/hessian.py:19-43]()

### 3.3 HVP 计算方法

`HessianOperator` 支持两种 Hessian 向量积（HVP）的计算方式：

#### 3.3.1 autograd 方法（默认）

通过 `torch.autograd.grad` 进行精确的双反向传播计算：

```python
# 伪代码实现
grad_params = grad(loss, params, create_graph=True)
hvp = grad(grad_params, params, grad_outputs=v)
```

该方法数值精确，适合单设备分析场景，参数规模上限约为 70 亿。资料来源：[hessian_eigenthings/operators/hessian.py:20-23]()

#### 3.3.2 finite_difference 方法

采用中心差分公式近似 HVP：

$$\text{Hv} \approx \frac{\nabla\mathcal{L}(\theta + \epsilon v) - \nabla\mathcal{L}(\theta - \epsilon v)}{2\epsilon}$$

该方法每个 HVP 需要两次正常的前向和反向传播，**不涉及任何二阶反向传播图**，天然支持 FSDP/HSDP/张量并行等分布式训练框架。代价是存在 $O(\epsilon^2)$ 的截断误差。资料来源：[hessian_eigenthings/operators/hessian.py:23-25]()

## 4. GGNOperator（广义 Gauss-Newton 矩阵）

`GGNOperator` 计算广义 Gauss-Newton（GGN）矩阵与向量的乘积。GGN 是 Hessian 的 PSD（半正定）近似，常用于大规模神经网络的曲率分析。

### 4.1 数学背景

GGN 矩阵定义为：

$$G = J^T H_{loss} J$$

其中 $J$ 是模型输出对参数的雅可比矩阵，$H_{loss}$ 是损失函数对模型输出的 Hessian。由于 $H_{loss}$ 被替换为近似 PSD 矩阵，$G$ 必然是 PSD 矩阵。

对于交叉熵损失 + Softmax 分类，GGN 矩阵恰好等于 Fisher 信息矩阵。资料来源：[hessian_eigenthings/operators/ggn.py:45-50]()

### 4.2 两函数 API 设计

`GGNOperator` 采用解耦的双函数接口：

| 函数 | 签名 | 说明 |
|------|------|------|
| `forward_fn` | `Callable[..., Tensor]` | 返回模型输出 |
| `loss_of_output_fn` | `Callable[[Tensor, Any], Tensor]` | 将模型输出和批次转换为标量损失 |

这种设计使得 `GGNOperator` 可以独立计算 $Jv$（雅可比-向量积）、$H_{loss} \cdot (Jv)$ 和 $J^T \cdot (H_{loss} \cdot Jv)$，而不依赖于损失函数的内部实现细节。资料来源：[hessian_eigenthings/operators/ggn.py:52-54]()

### 4.3 matvec 实现方式

| 方式 | 默认 | 说明 |
|------|------|------|
| `analytical` | ✅ | 有限差分 JVP + 解析 loss-Hessian-向量积 + 一次正常反向传播应用 $J^T$。内存占用与单次训练步相当，是 LLM 规模使用的首选方案 |
| `autograd` | - | `torch.func.jvp` + 自动微分双反向传播 + `torch.func.vjp` 路径。数值精确但内存随输出规模快速膨胀，适用于没有解析 `.hvp` 的损失函数 |

资料来源：[hessian_eigenthings/operators/ggn.py:56-66]()

### 4.4 内部结构

```mermaid
graph LR
    A["参数字典<br/>{name: Tensor}"] --> B["模型前向<br/>forward_fn"]
    B --> C["模型输出<br/>Tensor"]
    C --> D["损失计算<br/>loss_of_output_fn"]
    D --> E["标量损失<br/>loss"]
    
    F["向量 v<br/>(参数空间)"] --> G["JVP<br/>Jv"]
    G --> H["H_loss @ Jv<br/>解析或 autograd"]
    H --> I["VJP<br/>J^T @ (H_loss @ Jv)"]
    I --> J["结果<br/>Av = Gv"]
```

GGN matvec 的完整流程包括：

1. 从参数字典中提取参数值和梯度
2. 计算雅可比-向量积 $u = Jv$
3. 计算损失 Hessian 对 $u$ 的作用 $w = H_{loss} \cdot u$
4. 通过反向传播计算 $J^T \cdot w$ 资料来源：[hessian_eigenthings/operators/ggn.py:60-62]()

## 5. FisherOperator 与 EmpiricalFisherOperator

Fisher 信息矩阵是 GGN 的一个特例，在特定条件下（损失函数为负对数似然）两者数学上等价。项目提供两种 Fisher 算子实现。

### 5.1 FisherOperator

计算真实的 Fisher 信息矩阵，需要模型输出对应于正确的概率分布。对于语言模型，通常需要采样生成过程。

### 5.2 EmpiricalFisherOperator

计算经验 Fisher 信息矩阵，使用梯度的外积近似：

$$\hat{F} = \frac{1}{N} \sum_{i=1}^{N} \nabla \log p(y|x;\theta) \nabla \log p(y|x;\theta)^T$$

## 6. 分布式支持：DDP 包装器

对于使用 `torch.nn.parallel.DistributedDataParallel`（DDP）包装的模型，曲率算子需要额外处理参数同步和梯度聚合逻辑。

### 6.1 同步机制

```mermaid
graph TD
    subgraph "单设备算子"
        A["HessianOperator/GGNOperator"]
    end
    
    subgraph "DDP 包装层"
        B["DDPWrappedCurvatureOperator"]
    end
    
    subgraph "分布式后端"
        C["DistributedLinAlgBackend"]
    end
    
    A --> B
    B --> C
```

`DDPWrappedCurvatureOperator` 负责：

- 在每个 matvec 调用前同步模型参数（若使用分片参数）
- 在梯度计算后聚合所有 rank 的梯度
- 将梯度展平为与 `v` 相同形状的向量

资料来源：[hessian_eigenthings/operators/distributed/ddp.py]()

### 6.2 参数过滤与 DDP

在使用 `param_filter` 进行参数子集选择时，DDP 包装器需要确保：

1. 过滤后的参数在各 rank 间一致
2. 梯度同步仅发生在选中的参数子集上

## 7. 预置损失函数

项目在 `hessian_eigenthings/loss_fns` 模块中提供了常用损失函数的 HVP 实现，可直接与 `GGNOperator` 配合使用。

### 7.1 标准损失函数

| 函数 | 说明 | 适用场景 |
|------|------|----------|
| `cross_entropy_loss_of_output()` | 交叉熵损失的 `loss_of_output_fn`，返回闭式 HVP | 分类模型 |
| `make_loss_of_output_fn(criterion)` | 从任意损失函数创建适配器 | 自定义损失 |

闭式 HVP 计算公式（以交叉熵为例）：

对于形状为 `(N, C)` 的 logits，`H_loss @ u` 的第 $i$ 行计算为：

$$(\text{diag}(p_i) - p_i p_i^T) \cdot u_i / N$$

其中 $p_i = \text{softmax}(\text{logits}_i)$。

资料来源：[hessian_eigenthings/loss_fns/standard.py:27-37]()

### 7.2 HuggingFace 损失函数

针对 HuggingFace Transformers 库的语言模型，提供了优化的融合 CE HVP 实现：

| 后端 | 说明 | 性能特征 |
|------|------|----------|
| `auto` | 自动选择最快可用后端 | Triton > compile > eager |
| `triton` | 手写 CUDA Triton 内核，零中间张量 | 约 3.4x 加速，2x 内存减少 |
| `compile` | `torch.compile` 融合，CPU/CUDA/MPS 通用 | 约 2.6x 加速，2x 内存减少 |
| `eager` | 朴素 PyTorch 实现 | 便于调试，V≥50k 时易 OOM |

资料来源：[hessian_eigenthings/loss_fns/huggingface.py:1-40]()

融合内核的核心计算公式：

```python
p = softmax(logits)
dot = (p * u).sum(dim=-1, keepdim=True)
out = (p * u - p * dot) * mask / n_valid
```

## 8. 参数过滤机制

参数过滤允许用户仅对模型参数子集计算曲率矩阵，这对于分析特定层或模块的曲率特性非常有用。

### 8.1 过滤函数类型

```python
ParamFilter = Callable[[str, nn.Parameter], bool]
```

过滤函数接收参数名称和参数张量，返回布尔值表示是否纳入计算。

### 8.2 使用示例

```python
from fnmatch import fnmatch

# 匹配所有注意力层参数
param_filter = lambda name, _: fnmatch(name, "transformer.h.*.attn.*")

op = HessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=loss_fn,
    param_filter=param_filter
)
```

资料来源：[examples/huggingface_tiny_gpt2.py:42-46]()

### 8.3 过滤后的参数重映射

过滤后的算子 `size` 属性反映的是被选中参数的总数，`matvec` 接收和返回的向量形状均为 `(size,)`。算子内部维护参数名到参数张量的映射，确保向量索引与参数顺序正确对应。

## 9. 线性代数后端

`LinAlgBackend` 抽象了向量运算（点积、范数、归约等）的实现，支持不同硬件和分布式场景。

### 9.1 后端类型

| 后端 | 场景 |
|------|------|
| `SingleDeviceBackend` | 单设备 CPU/GPU 计算 |
| `DistributedBackend` | 多设备/多节点分布式计算 |

所有后端提供统一的向量运算接口，算子和算法代码通过后端进行所有线性代数操作。

## 10. 使用流程总结

```mermaid
graph LR
    A["定义模型<br/>nn.Module"] --> B["准备数据加载器<br/>DataLoader"]
    B --> C["选择/实现损失函数<br/>LossFn / loss_of_output_fn"]
    C --> D["创建曲率算子<br/>HessianOperator / GGNOperator"]
    D --> E["可选：参数过滤<br/>param_filter"]
    E --> F["调用算法<br/>lanczos / trace / ... "]
    F --> G["获取结果<br/>特征值/特征向量/迹估计"]
```

1. **模型准备**：创建待分析的 PyTorch 模型
2. **数据准备**：准备与训练一致的数据加载器
3. **损失函数**：选择合适的损失函数，对于 GGNOperator 需要提供 `loss_of_output_fn`
4. **算子创建**：实例化曲率算子，可选配置参数过滤、计算方法等
5. **算法调用**：使用 Lanczos 分解获取特征值/特征向量，或使用 Hutch++ 估计迹
6. **结果解析**：分析返回的特征值分布、收敛性等信息

## 11. 设计原则

曲率算子系统的设计遵循以下核心原则：

| 原则 | 说明 | 实现方式 |
|------|------|----------|
| **算子抽象** | 曲率矩阵计算与特征分解算法解耦 | 所有算子继承 `CurvatureOperator`，实现统一 `matvec` 接口 |
| **内存效率** | 支持大规模模型的曲率分析 | 融合内核、流式计算、解析路径避免中间张量 |
| **分布式友好** | 天然支持 DDP/FSDP/HSDP 等并行策略 | `finite_difference` 方法无二阶图；DDP 包装器处理梯度同步 |
| **数值稳定性** | 提供多种精度/速度权衡选项 | autograd（精确）vs finite_difference；analytical vs autograd for GGN |

---

<a id='page-algorithms'></a>

## 特征分解算法

### 相关页面

相关主题：[核心架构设计](#page-core-architecture), [曲率算子详解](#page-operators)

<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [hessian_eigenthings/algorithms/__init__.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/__init__.py)
- [hessian_eigenthings/algorithms/lanczos.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/lanczos.py)
- [hessian_eigenthings/algorithms/trace.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/trace.py)
- [hessian_eigenthings/algorithms/spectral_density.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/spectral_density.py)
- [hessian_eigenthings/algorithms/power_iteration.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/power_iteration.py)
- [docs/concepts/top-k-eigenvalues.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/docs/concepts/top-k-eigenvalues.md)
- [docs/concepts/trace-estimation.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/docs/concepts/trace-estimation.md)
- [docs/concepts/spectral-density.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/docs/concepts/spectral-density.md)
- [docs/reference/algorithms.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/docs/reference/algorithms.md)
</details>

# 特征分解算法

本页面详细介绍 `pytorch-hessian-eigenthings` 库中实现的特征分解算法。该库提供了一套完整的曲率矩阵特征分解工具，包括 Lanczos 算法、幂迭代法、迹估计和谱密度估计。

## 算法概述

特征分解算法在神经网络的 Hessian 分析中扮演核心角色。Hessian 矩阵的特征值和特征向量与神经网络的泛化特性密切相关，研究者假设"平坦最小值"具有更好的泛化能力。 资料来源：[README.md]()

该库实现了多种迭代特征分解算法，均基于 `CurvatureOperator` 接口构建，与底层线性代数后端解耦。 资料来源：[CONTRIBUTING.md](CONTRIBUTING.md)

## 核心算法架构

```mermaid
graph TD
    subgraph "特征分解算法模块"
        A[Lanczos 算法] --> D[特征值/向量计算]
        B[幂迭代法] --> D
        C[迹估计] --> E[矩阵迹计算]
        F[谱密度估计] --> G[Stochastic Lanczos Quadrature]
    end
    
    subgraph "底层接口"
        D --> H[CurvatureOperator]
        E --> H
        G --> H
        H --> I[LinAlgBackend]
    end
```

## Lanczos 算法

Lanczos 算法是该库计算 top-k 特征值和特征向量的主要方法。它通过三对角化过程将大型稀疏特征问题转化为小型稠密特征问题。

### 算法原理

Lanczos 算法是一种迭代方法，用于计算矩阵的极端特征值。对于 n×n 矩阵 A 和初始向量 v₀，算法生成三对角矩阵 T，其特征值逼近 A 的 Ritz 值。 资料来源：[hessian_eigenthings/algorithms/lanczos.py](hessian_eigenthings/algorithms/lanczos.py)

### API 接口

```python
def lanczos(
    operator: CurvatureOperator,
    k: int = 20,
    max_iter: int = 100,
    *,
    tol: float = 1e-8,
    which: Literal["LM", "LA", "SA"] = "LM",
    seed: int | None = None,
    reorthogonalize: bool = False,
    backend: LinAlgBackend[torch.Tensor] | None = None,
) -> LanczosResult
```

### 参数说明

| 参数 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| `operator` | CurvatureOperator | 必需 | 曲率算子，提供 matvec 操作 |
| `k` | int | 20 | 要计算的特征值数量 |
| `max_iter` | int | 100 | 最大迭代次数 |
| `tol` | float | 1e-8 | 收敛阈值，基于残差范数 |
| `which` | str | "LM" | 特征值选择策略 |
| `seed` | int | None | 随机种子 |
| `reorthogonalize` | bool | False | 是否使用重正交化 |

### 特征值选择策略

| 策略 | 含义 | 使用场景 |
|------|------|----------|
| `"LM"` | Largest Magnitude | 默认选项，查找最大模特征值 |
| `"LA"` | Largest Algebraic | 查找最大代数特征值 |
| `"SA"` | Smallest Algebraic | 查找最小代数特征值 |

特征值排序逻辑：

```python
if which == "LM":
    order = torch.argsort(theta.abs(), descending=True)
elif which == "LA":
    order = torch.argsort(theta, descending=True)
elif which == "SA":
    order = torch.argsort(theta, descending=False)
```

资料来源：[hessian_eigenthings/algorithms/lanczos.py:47-57](hessian_eigenthings/algorithms/lanczos.py)

### Ritz 向量计算优化

该实现使用秩-1外积更新直接累积 Ritz 向量到最终 (k, n) 布局，避免了 (n, m) 基矩阵和瞬态 (n, k) → (k, n) 转置复制。在 LLM 规模下，两者合计峰值可达特征向量大小的 2 倍以上。 资料来源：[hessian_eigenthings/algorithms/lanczos.py:63-71](hessian_eigenthings/algorithms/lanczos.py)

```python
# 优化后的累积方式
for j, basis_vec in enumerate(td.basis):
    eigenvectors.addr_(s_sel[j], basis_vec)
```

### 收敛判定

残差计算基于最后分量：

```python
last_components = s[-1, sel]
residuals = last_components.abs() * td.last_beta
converged = residuals < tol * eigenvalues.abs().clamp(min=_EPS)
```

资料来源：[hessian_eigenthings/algorithms/lanczos.py:73-76](hessian_eigenthings/algorithms/lanczos.py)

## 幂迭代法

幂迭代法是计算矩阵主导特征值的经典方法，该库提供了带deflation的幂迭代和加速随机幂迭代两种变体。

### 标准幂迭代

标准幂迭代通过反复应用矩阵并归一化来收敛到最大特征值对应的特征向量。 资料来源：[docs/concepts/top-k-eigenvalues.md](docs/concepts/top-k-eigenvalues.md)

### Deflated 幂迭代

Deflated 幂迭代基于 [HessianFlow](https://github.com/amirgholami/HessianFlow) 实现，用于计算多个特征值。在找到第一个特征值后，通过投影去除其影响，可以继续计算次大特征值。 资料来源：[README.md](README.md)

### 加速随机幂迭代

加速随机幂迭代来自 C. De Sa 等人的工作，通过随机化技术加速收敛。该方法在保持统计效率的同时显著减少迭代次数。 资料来源：[README.md](README.md)

## 迹估计

迹估计用于计算矩阵的迹 `tr(A)`，无需完整矩阵分解。这对于大型 Hessian 矩阵尤其重要，因为完整分解在计算上不可行。

### Hutchinson 估计器

Hutchinson 估计器使用随机向量样本：

```
tr(A) ≈ (1/m) Σ vᵢᵀ A vᵢ
```

其中 vᵢ 是从特定分布独立采样的随机向量。Rademacher 分布提供比 Gaussian 更低的方差。 资料来源：[hessian_eigenthings/algorithms/trace.py](hessian_eigenthings/algorithms/trace.py)

### Hutch++ 估计器

Hutch++ 是 Hutchinson 估计器的改进版本，通过结构性随机化实现更快的收敛。 资料来源：[docs/concepts/trace-estimation.md](docs/concepts/trace-estimation.md)

### API 接口

```python
def trace(
    operator: CurvatureOperator,
    num_matvecs: int = 100,
    *,
    method: Literal["hutchinson", "hutch++"] = "hutchinson",
    seed: int | None = None,
    distribution: Distribution = "rademacher",
    backend: LinAlgBackend[torch.Tensor] | None = None,
) -> TraceResult
```

### 参数说明

| 参数 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| `operator` | CurvatureOperator | 必需 | 曲率算子 |
| `num_matvecs` | int | 100 | 矩阵-向量积样本数量 |
| `method` | str | "hutchinson" | 估计方法 |
| `seed` | int | None | 随机种子 |
| `distribution` | str | "rademacher" | 随机向量分布 |

### 实现细节

```python
def hutchinson(
    operator: CurvatureOperator,
    num_samples: int = 100,
    distribution: Distribution = "rademacher",
    seed: int | None = None,
    backend: LinAlgBackend[torch.Tensor] | None = None,
) -> TraceResult:
    """Hutchinson's estimator. Rademacher gives lower variance for trace."""
    probe = torch.empty(operator.size, dtype=operator.dtype, device=operator.device)
    samples = torch.empty(num_samples, dtype=operator.dtype, device=operator.device)
    for i in range(num_samples):
        v = _draw(distribution, probe, gen, backend)
        av = operator.matvec(v)
        samples[i] = backend.dot(v, av)
    
    estimate = samples.mean().item()
    if num_samples > 1:
        stderr = (samples.std(unbiased=True) / (num_samples) ** 0.5).item()
```

资料来源：[hessian_eigenthings/algorithms/trace.py:54-74](hessian_eigenthings/algorithms/trace.py)

## 谱密度估计

谱密度（spectral density）描述了特征值在整个谱上的分布情况，使用 Stochastic Lanczos Quadrature (SLQ) 方法计算。

### Stochastic Lanczos Quadrature

SLQ 结合了 Lanczos 算法和蒙特卡洛积分，通过少量 Lanczos 迭代来估计谱密度函数。 资料来源：[docs/concepts/spectral-density.md](docs/concepts/spectral-density.md)

### 核心思想

对于对称矩阵 A，谱密度定义为：

```
ρ(λ) = (1/n) Σ δ(λ - λᵢ)
```

其中 δ 是 Dirac delta 函数。SLQ 通过随机起始向量和 Lanczos 迭代来近似这一分布。

### 应用场景

| 场景 | 说明 |
|------|------|
| 特征值分布可视化 | 绘制谱密度曲线观察特征值聚集情况 |
| 批量大小选择 | 根据谱的宽度判断最优批量大小 |
| 收敛性分析 | 观察 Hessian 谱结构判断优化器收敛速度 |

## 算法选择指南

```mermaid
graph TD
    A[分析目标] --> B{需要什么结果?}
    B --> C[Top-k 特征值/向量]
    B --> D[矩阵迹]
    B --> E[谱密度分布]
    B --> F[仅主导特征值]
    
    C --> G[Lanczos 算法]
    D --> H{精度要求}
    H --> I[高精度]
    H --> J[一般精度]
    F --> K[幂迭代法]
    
    I --> L[Hutch++]
    J --> M[Hutchinson]
    E --> N[SLQ]
    
    G --> O[结果: 特征值 + 特征向量]
    L --> P[结果: 迹估计值 + 标准误差]
    M --> P
    K --> Q[结果: 主导特征值]
    N --> R[结果: 密度采样点]
```

### 选择建议

| 目标 | 推荐算法 | 理由 |
|------|----------|------|
| 计算 top-k 特征对 | Lanczos | 数值稳定，效率高 |
| 估计矩阵迹 | Hutch++ | 更快收敛，更少 matvec |
| 谱密度可视化 | SLQ | 一次运行多点估计 |
| 简单主导特征值 | 幂迭代 | 实现简单，内存低 |

## 并行化与后端支持

所有算法均通过 `LinAlgBackend` 接口支持不同的计算后端：

| 后端 | 适用场景 |
|------|----------|
| SingleDeviceBackend | 单 GPU/CPU 计算 |
| 分布式后端 | 多 GPU 分布式计算 |

算法与后端完全解耦，可以无缝切换设备或分布式策略。 资料来源：[hessian_eigenthings/algorithms/__init__.py](hessian_eigenthings/algorithms/__init__.py)

## 使用示例

### Lanczos 计算 Top-3 特征值

```python
from hessian_eigenthings import HessianOperator, lanczos

# 创建 Hessian 算子
hessian_op = HessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=loss_fn,
)

# 计算 top-3 特征值和特征向量
result = lanczos(hessian_op, k=3, max_iter=20, tol=1e-3, seed=0)

print("Top-3 eigenvalues:")
for i, val in enumerate(result.eigenvalues):
    print(f"  λ_{i+1} = {val.item():.4e}")
```

### 迹估计

```python
from hessian_eigenthings import trace

trace_result = trace(
    hessian_op,
    num_matvecs=30,
    method="hutch++",
    seed=0
)

print(f"Hutch++ trace estimate: {trace_result.estimate:.4e}")
```

## 算法模块结构

```
hessian_eigenthings/algorithms/
├── __init__.py          # 公共 API 导出
├── lanczos.py           # Lanczos 特征分解
├── trace.py             # 迹估计 (Hutchinson/Hutch++)
├── spectral_density.py  # Stochastic Lanczos Quadrature
└── power_iteration.py  # 幂迭代法
```

资料来源：[docs/reference/algorithms.md](docs/reference/algorithms.md)

## 性能考量

| 算法 | 每次迭代复杂度 | 内存需求 | 收敛速度 |
|------|----------------|----------|----------|
| Lanczos | O(n²) per matvec | O(n·k) | 快（对极端特征值） |
| 幂迭代 | O(n²) per matvec | O(n) | 慢（仅主导特征值） |
| Hutchinson | O(n²) per matvec | O(n) | O(1/√m) |
| Hutch++ | O(n²) per matvec | O(n) | 比 Hutchinson 快 |

其中 n 是参数数量，k 是目标特征值数量，m 是随机样本数。

---

<a id='page-param-utils'></a>

## 参数工具模块

### 相关页面

相关主题：[核心架构设计](#page-core-architecture), [曲率算子详解](#page-operators)

<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [hessian_eigenthings/param_utils.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/param_utils.py)
- [docs/reference/param_utils.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/docs/reference/param_utils.md)
- [docs/how-to/per-layer-hessian.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/docs/how-to/per-layer-hessian.md)
</details>

# 参数工具模块

参数工具模块（`param_utils`）是 `hessian-eigenthings` 库中用于参数选择、过滤和批量操作的实用工具集合。该模块提供了灵活的模式匹配机制，允许用户对 PyTorch 模型中的特定参数或参数组进行曲率分析，如 Hessian 矩阵的特征分解。

## 模块概述

在神经网络的曲率分析中，通常不需要对整个模型的所有参数进行计算。参数工具模块提供了基于名称模式的参数过滤功能，使得用户可以针对性地分析：

- 模型中特定层的 Hessian 矩阵
- 注意力机制的曲率特性
- 全连接层或卷积层的参数
- 任意自定义的参数子集

资料来源：[hessian_eigenthings/param_utils.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/param_utils.py)

## 核心功能

### `match_names` 函数

`match_names` 是该模块的核心函数，用于创建一个参数过滤器（`ParamFilter`），基于参数名称的模式匹配来选择特定参数。

**函数签名：**

```python
def match_names(*patterns: str) -> ParamFilter
```

**参数说明：**

| 参数 | 类型 | 说明 |
|------|------|------|
| `patterns` | `str` | 逗号分隔的名称模式，支持通配符 `*` 匹配任意字符序列 |

**返回值：**

返回一个 `ParamFilter` 类型的函数，该函数接受模型参数名称列表，返回匹配模式的所有参数名称集合。

资料来源：[hessian_eigenthings/param_utils.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/param_utils.py)

### `ParamFilter` 类型

`ParamFilter` 是模块中定义的核心类型别名：

```python
ParamFilter = Callable[[list[str]], set[str]]
```

它表示一个函数，接收参数名称列表，返回匹配的参数名称集合。这种设计使得参数过滤逻辑与具体算子解耦，提高了模块的可复用性。

资料来源：[docs/reference/param_utils.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/docs/reference/param_utils.md)

## 使用模式

### 单层参数过滤

选择模型中所有与 "attention" 相关的参数：

```python
from hessian_eigenthings import HessianOperator
from hessian_eigenthings.param_utils import match_names

attn_op = HessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=loss_fn,
    param_filter=match_names("*attn*"),
)
```

资料来源：[examples/transformer_lens_attention_only.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/examples/transformer_lens_attention_only.py)

### 多层参数过滤

使用多个模式匹配不同层级的参数：

```python
from hessian_eigenthings import HessianOperator
from hessian_eigenthings.param_utils import match_names

# 匹配 transformer.h.*.attn.* 模式的参数
attn_op = HessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=loss_fn,
    param_filter=match_names("transformer.h.*.attn.*"),
)

# 匹配 MLP 相关参数
mlp_op = HessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=loss_fn,
    param_filter=match_names("blocks.*.mlp.*"),
)
```

资料来源：[examples/huggingface_tiny_gpt2.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/examples/huggingface_tiny_gpt2.py)

### 与曲率算子集成

参数过滤器与 `HessianOperator`、`GGNOperator` 等曲率算子无缝集成。当 `param_filter` 被指定时，算子仅对过滤后的参数子集进行操作：

```python
from hessian_eigenthings import HessianOperator, lanczos
from hessian_eigenthings.param_utils import match_names

# 创建仅包含注意力层参数的 Hessian 算子
hessian_op = HessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=loss_fn,
    param_filter=match_names("*attention*", "*attn*"),
)

# 计算该子集的 top-k 特征值
eigenvalues, eigenvectors = lanczos(hessian_op, k=5, max_iter=50)
```

资料来源：[docs/how-to/per-layer-hessian.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/docs/how-to/per-layer-hessian.md)

## 参数过滤流程

以下流程图展示了参数过滤在曲率分析中的完整流程：

```mermaid
graph TD
    A[PyTorch 模型] --> B[获取所有参数名称]
    B --> C[应用 param_filter]
    C --> D{匹配检查}
    D -->|匹配成功| E[包含在曲率计算中]
    D -->|匹配失败| F[排除在外]
    E --> G[创建 CurvatureOperator 子集]
    G --> H[执行 Lanczos 算法]
    H --> I[返回特征值/特征向量]
    F --> J[跳过该参数]
```

## 模式匹配语法

| 模式示例 | 匹配内容 | 示例 |
|----------|----------|------|
| `*attn*` | 包含 "attn" 的任意参数名 | `blocks.0.attn.weight`, `model.attn_bias` |
| `*.weight` | 以 ".weight" 结尾的参数 | `layer1.weight`, `fc2.weight` |
| `blocks.*.mlp.*` | blocks 下任意深度的 mlp 参数 | `blocks.0.mlp.linear1.weight` |
| `*bias*` | 包含 "bias" 的参数 | `fc.bias`, `layer_norm.bias` |

## 最佳实践

### 1. 精确匹配优先

为避免意外匹配无关参数，使用更精确的模式：

```python
# 较优：精确匹配 attention 层
param_filter=match_names("transformer.h.*.attn.*")

# 较粗：可能匹配到不相关的参数
param_filter=match_names("*attn*")
```

### 2. 组合使用多个模式

当需要选择多个非连续区域的参数时：

```python
# 同时选择 attention 和 embedding 层
param_filter=match_names("*attn*", "*embed*", "*embedding*")
```

### 3. 验证过滤结果

在实际计算前验证过滤是否正确：

```python
from hessian_eigenthings.param_utils import match_names

param_filter = match_names("blocks.*.attn.*")
all_params = list(model.named_parameters())
matched = param_filter([n for n, _ in all_params])

print(f"匹配到的参数数量: {len(matched)}")
for name in matched:
    print(f"  - {name}")
```

资料来源：[docs/how-to/per-layer-hessian.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/docs/how-to/per-layer-hessian.md)

## API 参考

### `hessian_eigenthings.param_utils`

| 函数/类型 | 说明 |
|-----------|------|
| `match_names(*patterns: str) -> ParamFilter` | 创建基于模式的参数过滤器 |
| `ParamFilter` | 类型别名，表示参数过滤函数类型 |

### 导出列表

模块默认导出：

```python
from hessian_eigenthings.param_utils import match_names, ParamFilter
```

资料来源：[docs/reference/param_utils.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/docs/reference/param_utils.md)

## 与其他模块的关系

参数工具模块在整体架构中扮演基础工具角色，为曲率算子提供参数选择能力：

```mermaid
graph LR
    A[param_utils] -->|提供 ParamFilter| B[HessianOperator]
    A -->|提供 ParamFilter| C[GGNOperator]
    A -->|提供 ParamFilter| D[EmpiricalFisher]
    B --> E[lanczos 算法]
    C --> E
    D --> E
    E --> F[特征值/特征向量结果]
```

这种设计确保了参数过滤逻辑的统一实现，避免了在各个算子中重复定义相同的过滤机制。

---

<a id='page-loss-functions'></a>

## 损失函数模块

### 相关页面

相关主题：[曲率算子详解](#page-operators)

<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [hessian_eigenthings/loss_fns/__init__.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/loss_fns/__init__.py)
- [hessian_eigenthings/loss_fns/standard.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/loss_fns/standard.py)
- [hessian_eigenthings/loss_fns/_fused_ce_hvp.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/loss_fns/_fused_ce_hvp.py)
- [hessian_eigenthings/loss_fns/huggingface.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/loss_fns/huggingface.py)
- [hessian_eigenthings/operators/ggn.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/ggn.py)
</details>

# 损失函数模块

## 概述

损失函数模块（`hessian_eigenthings/loss_fns/`）是 pytorch-hessian-eigenthings 项目中连接用户模型输出与曲率算子（CurvatureOperator）的桥梁。该模块的核心职责是将各种损失函数的计算过程适配为统一的函数签名，使 HessianOperator 和 GGNOperator 能够正确计算损失相对于模型输出的 Hessian 向量积（HVP）。

资料来源：[hessian_eigenthings/loss_fns/__init__.py]()

```mermaid
graph TD
    subgraph 用户模型
        A[模型前向传播] --> B[logits 输出]
    end
    
    subgraph 损失函数模块
        C[forward_fn] --> D[loss_of_output_fn]
        B --> C
        B --> D
    end
    
    subgraph 曲率算子
        E[HessianOperator / GGNOperator]
        D --> E
    end
    
    E --> F[matvec 计算]
    F --> G[Hessian / GGN 向量积]
```

## 模块架构

### 文件结构

| 文件 | 用途 |
|------|------|
| `__init__.py` | 模块导出接口 |
| `standard.py` | 标准分类/回归损失函数封装 |
| `huggingface.py` | HuggingFace Transformers 模型专用损失封装 |
| `_fused_ce_hvp.py` | 融合交叉熵 HVP 核心实现 |

资料来源：[hessian_eigenthings/loss_fns/__init__.py](), [hessian_eigenthings/loss_fns/standard.py](), [hessian_eigenthings/loss_fns/huggingface.py]()

### 核心函数签名

损失函数模块定义了两类关键函数签名，供曲率算子调用：

```python
# 类型1: forward_fn - 模型前向传播函数
ForwardFn = Callable[[nn.Module, Any], torch.Tensor]

# 类型2: loss_of_output_fn - 从模型输出计算损失的函数
LossOfOutputFn = Callable[[torch.Tensor, Any], torch.Tensor]

# 类型3: 可选的 HVP 函数 (用于 GGNOperator)
HvpFn = Callable[[torch.Tensor, Any, torch.Tensor], torch.Tensor]
```

资料来源：[hessian_eigenthings/operators/ggn.py]()

## 标准损失函数

`standard.py` 模块提供了基于标准 PyTorch 损失函数的封装实现。

资料来源：[hessian_eigenthings/loss_fns/standard.py]()

### 分类损失

对于多分类任务，模块实现了交叉熵损失的闭式 HVP 计算。对于 mean-reduced softmax + cross-entropy，损失函数为：

```python
H_row = (diag(p) - p p^T) / N
```

其中 `p = softmax(output)` 是模型输出的概率分布。

```python
def _ce_hvp(
    output: torch.Tensor, 
    batch: tuple[torch.Tensor, torch.Tensor], 
    u: torch.Tensor
) -> torch.Tensor:
    """闭式 H @ u for mean-reduced softmax + cross-entropy."""
    flat_output = output.reshape(-1, output.size(-1))
    flat_u = u.reshape(-1, u.size(-1))
    n = float(flat_output.size(0))
    p = torch.softmax(flat_output, dim=-1)
    dot = (p * flat_u).sum(dim=-1, keepdim=True)
    return ((p * flat_u - p * dot) / n).view_as(u)
```

资料来源：[hessian_eigenthings/loss_fns/standard.py:32-45]()

### GGNOperator 兼容封装

```python
def _make_loss_of_output_fn(
    criterion: Callable[[torch.Tensor, torch.Tensor], torch.Tensor]
) -> Callable[[torch.Tensor, tuple[torch.Tensor, torch.Tensor]], torch.Tensor]:
    """为 GGNOperator 从 (output, target) 损失构造 loss_of_output_fn."""
    
    def _fn(output: torch.Tensor, batch: tuple[torch.Tensor, torch.Tensor]) -> torch.Tensor:
        _, y = batch
        return criterion(output, y)
    
    return _fn
```

资料来源：[hessian_eigenthings/loss_fns/standard.py:10-19]()

## HuggingFace Transformers 损失函数

`huggingface.py` 模块专为 HuggingFace Transformers 库设计的预训练模型提供损失函数封装。

资料来源：[hessian_eigenthings/loss_fns/huggingface.py]()

### API 设计

HuggingFace 模型在提供 `labels` 时会内部计算损失，返回包含 `.loss` 和 `.logits` 的 `ModelOutput`。模块将这些适配为算子期望的函数签名：

```python
def hf_lm_loss(
    fused: FusedCEHvpBackend = "auto"
) -> tuple[ForwardFn, LossOfOutputFn, HvpFn]:
    """返回 HuggingFace LM 的 forward_fn, loss_of_output_fn 和 HVP 函数."""
```

### Shifted Cross-Entropy 损失

对于因果语言模型（Causal LM），输入 token 序列需要向右移动一位作为标签（shifted CE）：

```python
def _hf_lm_shifted_ce(
    logits: torch.Tensor, 
    batch: dict[str, Any]
) -> torch.Tensor:
    """Shifted cross-entropy loss for causal language models."""
    labels = batch["labels"]
    # logits: (B, T, V), labels: (B, T)
    logits = logits[:, :-1, :].contiguous()
    labels = labels[:, 1:].contiguous()
    return torch.nn.functional.cross_entropy(
        logits.view(-1, logits.size(-1)), 
        labels.view(-1),
        ignore_index=-100
    )
```

资料来源：[hessian_eigenthings/loss_fns/huggingface.py]()

### 闭式 H_loss @ u

对于 shifted CE loss，`H_loss` 在 `(B, T-1)` 上是块对角矩阵，每个块的形状为：

```
H_block = (diag(p_t) - p_t p_t^T) / n
```

其中 `p_t = softmax(shift_logits_t)`，`n` 是非忽略位置的数量。

资料来源：[hessian_eigenthings/loss_fns/huggingface.py]()

## 融合 CE HVP 实现

`_fused_ce_hvp.py` 提供了交叉熵 Hessian 向量积的高性能融合实现。

资料来源：[hessian_eigenthings/loss_fns/_fused_ce_hvp.py]()

### 计算公式

融合实现计算：

```
out_flat = (p * u - p * <p, u>) * mask / n_valid
```

输出形状为 `(N, V)`，其中 `N` 是 batch 中的 token 数量，`V` 是词表大小。

### 后端选项

| 后端 | 描述 | 优势 |
|------|------|------|
| `"auto"` | 自动选择最快可用后端 | 智能适配 |
| `"eager"` | 普通 PyTorch 实现 | 易调试、兼容性最好 |
| `"compile"` | `torch.compile` 融合 | 约 2.6x 加速，2x 内存减少 |
| `"triton"` | Triton CUDA kernel | 约 3.4x 加速，零中间内存 |

资料来源：[hessian_eigenthings/loss_fns/_fused_ce_hvp.py](), [hessian_eigenthings/loss_fns/huggingface.py]()

### 后端自动选择逻辑

```python
def _resolve_backend(
    backend: FusedCEHvpBackend, 
    logits: torch.Tensor | None = None
) -> FusedCEHvpBackend:
    """Resolve ``"auto"`` to the fastest available concrete backend."""
    if backend != "auto":
        return backend
    
    # 优先级: triton (CUDA + Triton可用) → compile → eager
    if _triton_available and logits is not None and logits.is_cuda:
        return "triton"
    return "compile"
```

资料来源：[hessian_eigenthings/loss_fns/huggingface.py]()

### 参考实现

```python
def _ce_hvp_reference(
    flat_logits: torch.Tensor,
    flat_u: torch.Tensor,
    valid: torch.Tensor,
    n: torch.Tensor,
) -> torch.Tensor:
    """Eager reference implementation."""
    p = torch.softmax(flat_logits, dim=-1)
    dot = (p * flat_u).sum(dim=-1, keepdim=True)
    return (p * flat_u - p * dot) * valid.unsqueeze(-1) / n
```

资料来源：[hessian_eigenthings/loss_fns/_fused_ce_hvp.py]()

## GGNOperator 中的损失函数集成

GGNOperator 支持两种 matvec 实现路径，通过 `loss_hvp` 参数控制：

资料来源：[hessian_eigenthings/operators/ggn.py]()

### Analytical 路径（默认）

```python
# 有限差分 JVP + 解析 loss-Hessian-向量积
loss_hvp = loss_of_output_fn.hvp  # 必须存在
```

内存占用匹配一次正常训练步骤，适用于 LM 规模的使用场景。

### Autograd 路径（备用）

```python
# torch.func.jvp + autograd 双重反向 + torch.func.vjp
```

数值精确、支持任意损失函数，但对大词表分类头内存消耗严重。

## 使用示例

### 标准分类任务

```python
from hessian_eigenthings.operators import HessianOperator
from hessian_eigenthings.loss_fns.standard import cross_entropy_loss_of_output

loss_fn = cross_entropy_loss_of_output()

hessian_op = HessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=hf_lm_loss(),
)
```

### HuggingFace 模型

```python
from hessian_eigenthings.loss_fns.huggingface import hf_lm_loss

forward_fn, loss_of_output_fn, hvp_fn = hf_lm_loss(fused="auto")
```

## 性能对比

| 实现方式 | 内存峰值 (V=50304) | 速度 |
|----------|-------------------|------|
| eager | ~19.6 GB | 1x |
| compile | ~3.3 GB | ~2.6x |
| triton | 最小 | ~3.4x |

资料来源：[scripts/bench_fused_ce_hvp.py]()

## 扩展指南

添加新的损失函数封装需要：

1. 实现 `loss_of_output_fn(output, batch)` 接口
2. 可选实现 `.hvp(output, batch, u)` 属性用于 GGNOperator
3. 保持与 `CurvatureOperator` 的兼容性

资料来源：[CONTRIBUTING.md]()

---

<a id='page-huggingface-integration'></a>

## HuggingFace 模型集成

### 相关页面

相关主题：[损失函数模块](#page-loss-functions)

<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [hessian_eigenthings/loss_fns/huggingface.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/loss_fns/huggingface.py)
- [examples/huggingface_tiny_gpt2.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/examples/huggingface_tiny_gpt2.py)
- [hessian_eigenthings/operators/ggn.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/ggn.py)
- [hessian_eigenthings/loss_fns/_fused_ce_hvp.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/loss_fns/_fused_ce_hvp.py)
- [hessian_eigenthings/algorithms/lanczos.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/lanczos.py)
</details>

# HuggingFace 模型集成

## 概述

HuggingFace 模型集成是 `hessian-eigenthings` 库为 HuggingFace Transformer 模型提供的专用损失函数和优化计算路径。该模块位于 `hessian_eigenthings/loss_fns/huggingface.py`，专门针对因果语言模型（Causal Language Model）的交叉熵损失实现了闭合形式的 Hessian-向量乘积（Hessian-Vector Product, HVP）计算。

主要功能包括：

- **移位交叉熵损失**：适配因果语言建模任务的特殊损失计算
- **闭合形式 HVP**：避免 autograd 双反向传播的内存开销
- **多后端支持**：支持 Triton、torch.compile 和 eager 模式
- **GGNOperator 集成**：与广义 Gauss-Newton 算子无缝配合

资料来源：[hessian_eigenthings/loss_fns/huggingface.py:1-100]()

## 架构设计

### 模块依赖关系

```mermaid
graph TD
    subgraph "用户代码"
        A["用户模型<br/>(如 GPT-2)"]
        B["DataLoader"]
    end
    
    subgraph "huggingface.py"
        C["huggingface_lm_loss()"]
        D["_hf_lm_shifted_ce"]
        E["_hf_lm_ce_hvp"]
    end
    
    subgraph "GGNOperator"
        F["loss_of_output_fn"]
        G["loss_hvp='analytical'"]
    end
    
    subgraph "后端实现"
        H["Triton 内核"]
        I["torch.compile"]
        J["Eager PyTorch"]
    end
    
    A --> C
    B --> C
    C --> D
    C --> E
    D --> F
    E --> G
    G --> H
    G --> I
    G --> J
```

### 闭合形式 Hessian 计算原理

对于均规约的 softmax + 交叉熵损失，Hessian 在 `(B, T-1)` 上呈块对角结构。每个时间步 `t` 的块为：

$$H_{loss}[t] = \frac{1}{n}(\text{diag}(p_t) - p_t p_t^T)$$

其中：
- $p_t = \text{softmax}(\text{shift\_logits}_t)$ 是 softmax 概率分布
- $n$ 是非忽略位置的计数

这使得 Hessian-向量乘积可以闭合计算，无需构建完整的 Hessian 矩阵：

$$H_{loss} \cdot u = \frac{p \cdot u - p \cdot \langle p, u \rangle}{n}$$

资料来源：[hessian_eigenthings/loss_fns/huggingface.py:28-40]()

## 核心 API

### `huggingface_lm_loss()`

创建适用于 HuggingFace 因果语言模型的损失函数，包含闭合形式 HVP。

```python
def huggingface_lm_loss(fused: str = "auto") -> _LossOfOutputWithHvp:
```

#### 参数说明

| 参数 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| `fused` | `str` | `"auto"` | CE HVP 核选择策略 |

#### `fused` 选项

| 值 | 说明 | 性能特性 |
|----|------|----------|
| `"auto"` | 自动选择（CUDA+Triton 可用时优先 Triton） | 最优性能 |
| `"eager"` | 纯 PyTorch eager 模式 | 易调试，但 V≥50k 时易 OOM |
| `"compile"` | `torch.compile` 融合 | CPU/CUDA/MPS 通用 |
| `"triton"` | 手写 Triton CUDA 内核 | 峰值内存最小 |

资料来源：[hessian_eigenthings/loss_fns/huggingface.py:80-95]()

### 返回值

返回 `_LossOfOutputWithHvp` 对象，包含：

- `__call__(logits, batch)` → `torch.Tensor`：损失标量
- `.hvp(logits, batch, u)` → `torch.Tensor`：闭合形式 HVP

## 计算后端

### 后端选择流程

```mermaid
graph TD
    A["fused='auto'"] --> B{"CUDA + Triton 可用?"}
    B -->|是| C["使用 Triton 内核"]
    B -->|否| D["使用 torch.compile"]
    
    E["fused='eager'"] --> F["纯 PyTorch Eager"]
    G["fused='compile'"] --> H["torch.compile 融合"]
    I["fused='triton'"] --> J{"Triton/CUDA 可用?"}
    J -->|否| K["回退到 compile"]
    J -->|是| C
```

### 融合计算数学

核心计算在 `(N, V)` 形状的张量上进行：

```python
p = softmax(logits)          # (N, V) 概率分布
dot = (p * u).sum(dim=-1)    # (N,) 点积
hvp = (p * u - p * dot) * mask / n  # (N, V) 结果
```

资料来源：[hessian_eigenthings/loss_fns/_fused_ce_hvp.py:1-50]()

### 内存优化

不同后端的内存占用对比（B=64, T=256, V=50304, fp32）：

| 后端 | 内存估算 | (N,V) 张量数量 |
|------|----------|----------------|
| eager | ~19.6 GB | ~6 个中间张量 |
| compile | ~3.3 GB | ~1 个（输出缓冲） |
| triton | 最小 | 0 个中间张量 |

资料来源：[scripts/bench_fused_ce_hvp.py:1-30]()

## 与 GGNOperator 的集成

### 工作流程

```mermaid
graph LR
    A["模型 + DataLoader"] --> B["GGNOperator"]
    B --> C{"loss_hvp 参数?"}
    C -->|"有 .hvp 方法"| D["analytical 路径<br/>有限差分 JVP + 解析 HVP"]
    C -->|"无 .hvp 方法"| E["autograd 路径<br/>torch.func.jvp + 双反向传播"]
    
    D --> F["内存占用 = 单步训练"]
    E --> G["内存随输出规模增长"]
```

### analytical 路径优势

当使用 `huggingface_lm_loss()` 返回的损失函数时：

1. **有限差分 JVP**：单次前向通过计算雅可比向量乘积
2. **解析 HVP**：使用闭合形式公式计算损失 Hessian-向量乘积
3. **单次反向传播**：应用 $J^T$ 矩阵

整体内存占用与单次训练步骤相当，适合 LLM 规模分析。

资料来源：[hessian_eigenthings/operators/ggn.py:1-80]()

## 使用示例

### 完整分析流程

```python
import torch
from transformers import AutoTokenizer, AutoModelForCausalLM
from hessian_eigenthings.operators import HessianOperator, GGNOperator
from hessian_eigenthings.loss_fns.huggingface import huggingface_lm_loss
from hessian_eigenthings.algorithms import lanczos, trace

# 1. 加载模型
model = AutoModelForCausalLM.from_pretrained("openai-community/gpt2")
tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")

# 2. 准备数据
texts = ["the quick brown fox jumps over"]
encoded = tokenizer(texts, padding=True, return_tensors="pt")
encoded["labels"] = encoded["input_ids"].clone()
dataloader = [dict(encoded)]

# 3. 创建损失函数（带闭合形式 HVP）
hf_loss = huggingface_lm_loss(fused="auto")

# 4. 创建 GGN 算子
ggn_op = GGNOperator(
    model=model,
    dataloader=dataloader,
    forward_fn=lambda m, b: m(**b).logits,
    loss_of_output_fn=hf_loss,
)

# 5. 计算 top-k 特征值
eig_result = lanczos(ggn_op, k=3, max_iter=20, tol=1e-3, seed=0)
print(f"Top-3 特征值: {eig_result.eigenvalues}")

# 6. 估计迹
trace_result = trace(ggn_op, num_matvecs=30, method="hutch++", seed=0)
print(f"Hutch++ 迹估计: {trace_result.estimate}")
```

资料来源：[examples/huggingface_tiny_gpt2.py:1-60]()

### 注意力层子空间分析

```python
from hessian_eigenthings.operators import HessianOperator

# 仅分析注意力参数
attn_op = HessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=hf_loss,
    param_filter=lambda n, p: "attn" in n,  # 参数过滤器
)

eig_attn = lanczos(attn_op, k=3, max_iter=20, tol=1e-3, seed=0)
print(f"注意力层 top-3 特征值: {eig_attn.eigenvalues}")
```

## 参数过滤器

参数过滤器用于限制 Hessian 分析的子空间：

| 过滤器模式 | 说明 | 示例 |
|-----------|------|------|
| `lambda n, p: "attn" in n` | 按名称包含 | 提取注意力参数 |
| `lambda n, p: "mlp" in n` | 按名称包含 | 提取 MLP 参数 |
| `lambda n, p: p.numel() > 1000` | 按大小过滤 | 排除偏置和小型参数 |

## 与 TransformerLens 的对比

| 特性 | HuggingFace 集成 | TransformerLens 集成 |
|------|------------------|---------------------|
| 模型支持 | GPT-2, LLaMA 等主流模型 | HookedTransformer |
| 损失函数 | 因果语言模型交叉熵 | 可自定义 |
| 示例文件 | `huggingface_tiny_gpt2.py` | `transformer_lens_attention_only.py` |
| API | `huggingface_lm_loss()` | `tlens_loss()` |

资料来源：[examples/transformer_lens_attention_only.py:1-50]()

## 常见问题与限制

### 内存溢出 (OOM) 处理

若在 LLM 上遇到 OOM：

1. **使用 analytical 路径**：确保使用 `huggingface_lm_loss()` 而非通用损失
2. **切换到 finite_difference**：对 HessianOperator 使用 `method="finite_difference"`
3. **减小批量大小**：减少 dataloader 中的样本数
4. **使用 bf16**：对大模型使用 bfloat16 精度

资料来源：[scripts/repro_ggn_oom.py:1-50]()

### 数值精度

- **autograd 路径**：数值精确（至浮点精度）
- **finite_difference 路径**：存在 $O(\varepsilon^2)$ 截断偏差
- **analytical 路径**：闭合形式，数值精确

## 扩展阅读

- [自定义曲率算子](../how-to/custom-curvature-operators.md)
- [Lanczos 算法详解](../concepts/lanczos-algorithm.md)
- [迹估计方法](../concepts/trace-estimation.md)

---

<a id='page-distributed-ddp'></a>

## 分布式训练支持 (DDP)

### 相关页面

相关主题：[曲率算子详解](#page-operators), [HuggingFace 模型集成](#page-huggingface-integration)

<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [hessian_eigenthings/operators/distributed/__init__.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/distributed/__init__.py)
- [hessian_eigenthings/operators/distributed/ddp.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/distributed/ddp.py)
- [hessian_eigenthings/operators/hessian.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/operators/hessian.py)
- [hessian_eigenthings/algorithms/lanczos.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/lanczos.py)
- [hessian_eigenthings/algorithms/trace.py](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/hessian_eigenthings/algorithms/trace.py)
</details>

# 分布式训练支持 (DDP)

## 概述

`hessian-eigenthings` 库通过 `DDPHessianOperator` 提供对 PyTorch 分布式数据并行（DistributedDataParallel, DDP）训练的原生支持。这一功能允许用户在多 GPU 或多节点分布式训练环境下计算 Hessian 矩阵的特征值分解，而无需修改现有的 DDP 训练代码。

在分布式训练场景中，Hessian 分析面临独特的挑战：由于模型参数分布在多个进程上，梯度计算和损失聚合需要在进程间同步。`DDPHessianOperator` 封装了这些复杂性，提供了与单机 `HessianOperator` 一致的接口，使得分布式 Hessian 分析可以像单机使用一样简单。

## 模块结构

分布式模块位于 `hessian_eigenthings/operators/distributed/` 目录下，通过统一的导出接口供外部使用：

```python
from hessian_eigenthings.operators.distributed import DDPHessianOperator
```

资料来源：[hessian_eigenthings/operators/distributed/__init__.py:1]()

## DDPHessianOperator 核心设计

### 类继承关系

`DDPHessianOperator` 继承自 `CurvatureOperator` 基类，遵循库中统一的曲率算子架构。这使得它可以与现有的 Lanczos 算法、trace 估计等工具无缝配合工作。

### 主要功能特性

| 特性 | 说明 |
|------|------|
| 自动梯度同步 | 在 `no_grad` 上下文中执行模型前向传播，确保梯度计算的一致性 |
| 进程间通信优化 | 复用 DDP 的梯度桶机制，减少额外通信开销 |
| 参数过滤支持 | 可通过 `param_filter` 参数选择性地分析特定参数子集的 Hessian |
| 与 DDP 兼容 | 直接接收包装后的 DDP 模型，无需特殊处理 |

### 构造函数参数

`DDPHessianOperator` 的初始化签名与 `HessianOperator` 保持高度一致，降低了用户的学习成本：

| 参数 | 类型 | 说明 |
|------|------|------|
| `model` | `nn.Module` | DDP 包装后的模型实例 |
| `dataloader` | `Iterable[Any]` | 数据加载器，提供批次数数据 |
| `loss_fn` | `LossFn` | 损失函数，签名 `loss_fn(model_output, target) -> scalar` |
| `param_filter` | `ParamFilter \| None` | 可选参数过滤器，用于选择分析的参数子集 |
| `full_dataset` | `bool` | 是否使用完整数据集（默认 `True`） |
| `num_batches` | `int \| None` | 使用的批次数，优先于 `full_dataset` |
| `method` | `HvpMethod` | HVP 计算方法：`"autograd"` 或 `"finite_difference"` |

## 使用工作流

### 基础使用模式

```python
import torch
import torch.distributed as dist
from torch.nn.parallel import DistributedDataParallel as DDP
from hessian_eigenthings.operators.distributed import DDPHessianOperator
from hessian_eigenthings.algorithms.lanczos import lanczos

# 初始化分布式环境（本地示例）
dist.init_process_group(backend="nccl")

# 创建和包装模型
model = MyModel().cuda(rank)
model = DDP(model, device_ids=[local_rank])

# 准备数据
dataloader = distributed_data_loader()

# 创建分布式 Hessian 算子
hessian_op = DDPHessianOperator(
    model=model,
    dataloader=dataloader,
    loss_fn=my_loss_fn,
)

# 计算特征值分解
eigenvalues, eigenvectors = lanczos(hessian_op, k=10, max_iter=50)
```

### 与 Lanczos 算法集成

`DDPHessianOperator` 可直接作为 `lanczos()` 函数的输入，用于计算分布式模型 Hessian 的 top-k 特征值和特征向量：

```python
from hessian_eigenthings.algorithms.lanczos import lanczos

result = lanczos(
    operator=hessian_op,
    k=5,
    max_iter=100,
    tol=1e-6,
    seed=42,
    backend=SingleDeviceBackend()
)

print(f"Top eigenvalues: {result.eigenvalues}")
```

### 与 Trace 估计集成

同样支持 `hutchinson()` 和 `hutch_plus_plus()` 方法进行 Hessian 迹估计：

```python
from hessian_eigenthings.algorithms.trace import hutch_plus_plus

trace_result = hutch_plus_plus(
    operator=hessian_op,
    num_matvecs=100,
    seed=0
)

print(f"Hessian trace estimate: {trace_result.estimate:.4e}")
```

## 架构设计

### 分布式 Hessian 计算流程

```mermaid
graph TD
    A[初始化 DDP 模型] --> B[创建 DDPHessianOperator]
    B --> C[分布式数据加载]
    C --> D{每个 Rank 执行}
    D --> E[本地前向传播]
    E --> F[本地损失计算]
    F --> G[梯度同步 DDP]
    G --> H[本地 HVP 计算]
    H --> I[进程间结果聚合]
    I --> J[返回全局曲率信息]
```

### 与单机 HessianOperator 的差异

| 方面 | HessianOperator | DDPHessianOperator |
|------|-----------------|-------------------|
| 模型输入 | 普通 `nn.Module` | DDP 包装后的模型 |
| 梯度计算 | 单机梯度 | 聚合后的分布式梯度 |
| 设备管理 | 单设备 | 多设备（每 Rank 一个） |
| 通信开销 | 无 | DDP 梯度同步开销 |
| 使用场景 | 单机实验 | 大规模分布式训练 |

## 实现注意事项

### 1. 分布式环境初始化

使用 `DDPHessianOperator` 前必须确保分布式环境已正确初始化。库依赖 PyTorch 的 `torch.distributed` 模块进行进程间通信。

### 2. 数据分发

数据加载器应为分布式版本，确保每个 Rank 处理不同的数据分片。推荐使用 `DistributedSampler`：

```python
from torch.utils.data.distributed import DistributedSampler

sampler = DistributedSampler(dataset, num_replicas=world_size, rank=rank)
dataloader = DataLoader(dataset, sampler=sampler, batch_size=batch_size)
```

### 3. 同步点处理

`DDPHessianOperator` 在计算过程中会自动处理必要的进程间同步，确保所有 Rank 在关键步骤上保持同步，避免不一致的梯度状态。

## 性能考虑

### 通信开销

由于 Hessian 向量乘积计算需要梯度信息，`DDPHessianOperator` 会引入额外的梯度同步开销。优化建议：

- 使用足够大的批量大小以分摊通信成本
- 在需要分析的特定层使用参数过滤，减少计算范围
- 考虑在训练间隙进行 Hessian 分析，而非实时计算

### 内存效率

分布式 Hessian 分析的内存需求随 Rank 数量增加而增加，因为每个进程需要保存本地激活和梯度副本。库通过 `no_grad` 上下文和适当的张量管理来优化内存使用。

## 相关模块

### CurvatureOperator 基类

`DDPHessianOperator` 继承自 `CurvatureOperator`，这是库中所有曲率算子的抽象基类。它定义了统一的 `matvec()` 接口，所有算法（Lanczos、trace 估计等）都通过这一接口与算子交互。

### 曲率算子家族

| 算子 | 用途 |
|------|------|
| `HessianOperator` | 标准 Hessian 矩阵 |
| `GGNOperator` | Generalized Gauss-Newton 近似 |
| `DDPHessianOperator` | 分布式 DDP 环境下的 Hessian |
| `KFACHessianOperator` | Kronecker-Factored Approximate Curvature |

## 总结

`DDPHessianOperator` 为 `hessian-eigenthings` 库提供了关键的分布式训练支持能力。通过继承统一的 `CurvatureOperator` 接口，它保持了与现有分析工具的兼容性，同时封装了 DDP 特有的分布式计算复杂性。这使得在大规模分布式训练环境中进行 Hessian 分析成为可能，为研究神经网络的收敛性、平坦性和泛化能力提供了有力工具。

---

<a id='page-installation'></a>

## 安装与配置

### 相关页面

相关主题：[项目简介](#page-project-intro)

<details>
<summary>相关源码文件</summary>

以下源码文件用于生成本页说明：

- [pyproject.toml](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/pyproject.toml)
- [CONTRIBUTING.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/CONTRIBUTING.md)
- [README.md](https://github.com/noahgolmant/pytorch-hessian-eigenthings/blob/main/README.md)
</details>

# 安装与配置

## 概述

`pytorch-hessian-eigenthings` 是一个用于计算 Hessian 矩阵特征分解的 PyTorch 库，支持 Lanczos 算法、随机幂迭代、Hutch++ trace 估计和随机 Lanczos quadrature 等高效算法。本节详细说明该库的安装方式、环境配置方法以及开发环境设置流程。

## 系统要求

### 依赖环境

| 组件 | 要求 | 说明 |
|------|------|------|
| Python | ≥ 3.9 | 项目支持的最低 Python 版本 |
| PyTorch | 兼容版本 | 核心依赖，提供自动微分和神经网络支持 |
| uv | 最新版本 | 项目推荐的包管理工具 |

资料来源：[CONTRIBUTING.md:1-5]()

### 可选依赖

| 额外功能 | 包名 | 用途 |
|----------|------|------|
| Transformers 支持 | `transformers` | 与 HuggingFace 模型集成 |
| TransformerLens 支持 | `transformer-lens` | 分析 Transformer 架构 |
| CurvLinOps 支持 | `curvlinops` | 外部对照库，用于测试验证 |
| Triton | `triton` | CUDA 加速的 CE HVP 计算 |
| mkdocs | - | 文档构建工具 |

资料来源：[CONTRIBUTING.md:8]()

## 安装方式

### 方式一：从 PyPI 安装（稳定版）

通过 pip 安装最新稳定版本：

```bash
pip install hessian-eigenthings
```

> **注意**：当前版本为 v1.0.0a1（alpha 版本）。如需使用 0.x 版本的旧 API，请安装 `hessian-eigenthings==0.0.2`。

资料来源：[README.md:16-18]()

### 方式二：从源码安装（开发版）

适合需要使用最新功能或进行二次开发的用户：

```bash
git clone https://github.com/noahgolmant/pytorch-hessian-eigenthings
cd pytorch-hessian-eigenthings
uv sync --group dev --group docs --extra transformers --extra transformer-lens --extra curvlinops
```

#### 安装步骤详解

```mermaid
graph TD
    A[克隆仓库] --> B[进入项目目录]
    B --> C[执行 uv sync]
    C --> D{检查额外依赖}
    D -->|需要 Transformers| E[安装 transformers 组]
    D -->|需要 TransformerLens| F[安装 transformer-lens 组]
    D -->|需要 CurvLinOps| G[安装 curvlinops 组]
    E --> H[环境就绪]
    F --> H
    G --> H
```

1. **克隆仓库**：使用 git 获取最新源码
2. **进入目录**：切换到项目根目录
3. **同步依赖**：uv 自动解析 `pyproject.toml` 并安装所有依赖

资料来源：[CONTRIBUTING.md:1-9]()

## 开发环境配置

### 代码质量检查工具

项目使用以下工具确保代码质量：

| 工具 | 用途 | 命令 |
|------|------|------|
| ruff | 代码检查与格式化 | `uv run ruff check .` |
| black | 代码格式化检查 | `uv run black --check .` |
| mypy | 类型检查 | `uv run mypy` |
| pytest | 单元测试 | `uv run pytest` |
| mkdocs | 文档构建 | `uv run mkdocs build --strict` |

### 提交前检查流程

在提交 Pull Request 之前，必须运行以下检查确保代码符合项目规范：

```mermaid
graph LR
    A[修改代码] --> B[运行 ruff check]
    B --> C[运行 black]
    C --> D[运行 mypy]
    D --> E[运行 pytest]
    E --> F[构建文档]
    F --> G{所有检查通过}
    G -->|是| H[提交 PR]
    G -->|否| I[修复问题]
    I --> B
```

具体执行命令：

```bash
# 代码风格检查
uv run ruff check .

# 代码格式化验证
uv run black --check .

# 类型检查
uv run mypy

# 运行测试套件
uv run pytest

# 构建文档
uv run mkdocs build --strict
```

> **提示**：如果本地调试，lint 任务（ruff 和 black）的成本最低，建议优先运行这些检查。

资料来源：[CONTRIBUTING.md:11-17]()

## CUDA 加速配置（可选）

### Triton 加速

对于需要处理大规模语言模型的场景，建议安装 Triton 以获得更好的性能：

```bash
pip install triton
```

启用后的性能提升：
- **速度提升**：约 3.4 倍
- **峰值内存减少**：约 50%

Triton kernel 在 CUDA 环境下自动检测并使用，无需手动配置。

### torch.compile 备选方案

如果 Triton 不可用，库会自动回退到 `torch.compile` 模式：

- **速度提升**：约 2.6 倍
- **峰值内存减少**：约 50%

支持 CPU/CUDA/MPS 平台。

资料来源：[hessian_eigenthings/loss_fns/huggingface.py:10-15]()

## 验证安装

安装完成后，可通过以下方式验证：

```python
import torch
from hessian_eigenthings import HessianOperator, lanczos

# 创建简单模型
model = torch.nn.Linear(10, 2)

# 创建测试数据
x = torch.randn(5, 10)
y = torch.tensor([0, 1, 0, 1, 0])

# 定义损失函数
loss_fn = torch.nn.functional.cross_entropy

# 创建 Hessian 算子
hessian_op = HessianOperator(
    model=model,
    dataloader=[(x, y)],
    loss_fn=loss_fn
)

# 计算 top-3 特征值
eigenvals = lanczos(hessian_op, k=3, max_iter=20)
print(f"Top eigenvalues: {eigenvals.eigenvalues}")
```

如果输出正确的特征值，说明安装成功。

## 常见问题

### 问题一：uv 命令未找到

**解决方案**：先安装 uv

```bash
pip install uv
```

### 问题二：torch 版本不兼容

**解决方案**：确保 PyTorch 版本 ≥ 1.12.0，建议使用最新稳定版：

```bash
pip install --upgrade torch
```

### 问题三：CUDA 内存不足

**解决方案**：
1. 减小 batch size
2. 使用 `method="finite_difference"` 替代 `"autograd"`
3. 考虑使用 GGNOperator 替代 HessianOperator

资料来源：[hessian_eigenthings/operators/hessian.py:10-20]()

## 快速开始清单

| 步骤 | 任务 | 状态 |
|------|------|------|
| 1 | 安装 Python ≥ 3.9 | ☐ |
| 2 | 安装 uv 包管理器 | ☐ |
| 3 | 克隆或安装 hessian-eigenthings | ☐ |
| 4 | （可选）安装额外依赖 | ☐ |
| 5 | 验证安装（运行示例代码） | ☐ |
| 6 | （开发者）配置 pre-commit 钩子 | ☐ |

## 相关文档

- [快速开始指南](./quickstart.md)
- [Hessian 算子 API 参考](../api/operators/hessian.md)
- [Lanczos 算法文档](../concepts/lanczos-algorithm.md)
- [贡献指南](../community/contributing.md)

---

---

## Doramagic 踩坑日志

项目：noahgolmant/pytorch-hessian-eigenthings

摘要：发现 15 个潜在踩坑项，其中 0 个为 high/blocking；最高优先级：身份坑 - 仓库名和安装名不一致。

## 1. 身份坑 · 仓库名和安装名不一致

- 严重度：medium
- 证据强度：runtime_trace
- 发现：仓库名 `pytorch-hessian-eigenthings` 与安装入口 `hessian-eigenthings` 不完全一致。
- 对用户的影响：用户照着仓库名搜索包或照着包名找仓库时容易走错入口。
- 建议检查：在 npm/PyPI/GitHub 上确认包名映射和官方 README 说明。
- 复现命令：`pip install hessian-eigenthings`
- 防护动作：页面必须同时展示 repo 名和真实安装入口，避免用户搜索错包。
- 证据：identity.distribution | hn_item:48132232 | https://news.ycombinator.com/item?id=48132232 | repo=pytorch-hessian-eigenthings; install=hessian-eigenthings

## 2. 安装坑 · 来源证据：Python Error: the following arguments are required: experimentname

- 严重度：medium
- 证据强度：source_linked
- 发现：GitHub 社区证据显示该项目存在一个安装相关的待验证问题：Python Error: the following arguments are required: experimentname
- 对用户的影响：可能增加新用户试用和生产接入成本。
- 建议检查：来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。
- 防护动作：不得脱离来源链接放大为确定性结论；需要标注适用版本和复核状态。
- 证据：community_evidence:github | cevd_24f46464d79f4ae3830f046c077a2574 | https://github.com/noahgolmant/pytorch-hessian-eigenthings/issues/39 | 来源讨论提到 python 相关条件，需在安装/试用前复核。

## 3. 安装坑 · 来源证据：v1.0.0a2 — packaging fix

- 严重度：medium
- 证据强度：source_linked
- 发现：GitHub 社区证据显示该项目存在一个安装相关的待验证问题：v1.0.0a2 — packaging fix
- 对用户的影响：可能增加新用户试用和生产接入成本。
- 建议检查：来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。
- 防护动作：不得脱离来源链接放大为确定性结论；需要标注适用版本和复核状态。
- 证据：community_evidence:github | cevd_7540a696b30c46cdba07c12f33388567 | https://github.com/noahgolmant/pytorch-hessian-eigenthings/releases/tag/v1.0.0a2 | 来源类型 github_release 暴露的待验证使用条件。

## 4. 安装坑 · 来源证据：v1.0.0a3 — fix lanczos OOM

- 严重度：medium
- 证据强度：source_linked
- 发现：GitHub 社区证据显示该项目存在一个安装相关的待验证问题：v1.0.0a3 — fix lanczos OOM
- 对用户的影响：可能增加新用户试用和生产接入成本。
- 建议检查：来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。
- 防护动作：不得脱离来源链接放大为确定性结论；需要标注适用版本和复核状态。
- 证据：community_evidence:github | cevd_e5e68e2f24e1436cb8f3c2f11cefe326 | https://github.com/noahgolmant/pytorch-hessian-eigenthings/releases/tag/v1.0.0a3 | 来源类型 github_release 暴露的待验证使用条件。

## 5. 安装坑 · 来源证据：v1.0.0a4 — backend handles CPU-generator + CUDA-tensor combo

- 严重度：medium
- 证据强度：source_linked
- 发现：GitHub 社区证据显示该项目存在一个安装相关的待验证问题：v1.0.0a4 — backend handles CPU-generator + CUDA-tensor combo
- 对用户的影响：可能增加新用户试用和生产接入成本。
- 建议检查：来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。
- 防护动作：不得脱离来源链接放大为确定性结论；需要标注适用版本和复核状态。
- 证据：community_evidence:github | cevd_914b7653aa8b4ef2844a2b4690fab2ad | https://github.com/noahgolmant/pytorch-hessian-eigenthings/releases/tag/v1.0.0a4 | 来源类型 github_release 暴露的待验证使用条件。

## 6. 安装坑 · 来源证据：v1.0.0a5 — comprehensive LLM-scale memory fixes + regression tests

- 严重度：medium
- 证据强度：source_linked
- 发现：GitHub 社区证据显示该项目存在一个安装相关的待验证问题：v1.0.0a5 — comprehensive LLM-scale memory fixes + regression tests
- 对用户的影响：可能增加新用户试用和生产接入成本。
- 建议检查：来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。
- 防护动作：不得脱离来源链接放大为确定性结论；需要标注适用版本和复核状态。
- 证据：community_evidence:github | cevd_509356ab9b68434992d7237219952ba6 | https://github.com/noahgolmant/pytorch-hessian-eigenthings/releases/tag/v1.0.0a5 | 来源讨论提到 python 相关条件，需在安装/试用前复核。

## 7. 配置坑 · 来源证据：RuntimeError: One of the differentiated Tensors appears to not have been used in the graph.

- 严重度：medium
- 证据强度：source_linked
- 发现：GitHub 社区证据显示该项目存在一个配置相关的待验证问题：RuntimeError: One of the differentiated Tensors appears to not have been used in the graph.
- 对用户的影响：可能增加新用户试用和生产接入成本。
- 建议检查：来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。
- 防护动作：不得脱离来源链接放大为确定性结论；需要标注适用版本和复核状态。
- 证据：community_evidence:github | cevd_f79a3a34cbab435cb3730b7ae17cf492 | https://github.com/noahgolmant/pytorch-hessian-eigenthings/issues/30 | 来源讨论提到 python 相关条件，需在安装/试用前复核。

## 8. 配置坑 · 来源证据：ValueError: PENet on the Kitti benchmark suite

- 严重度：medium
- 证据强度：source_linked
- 发现：GitHub 社区证据显示该项目存在一个配置相关的待验证问题：ValueError: PENet on the Kitti benchmark suite
- 对用户的影响：可能增加新用户试用和生产接入成本。
- 建议检查：来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。
- 防护动作：不得脱离来源链接放大为确定性结论；需要标注适用版本和复核状态。
- 证据：community_evidence:github | cevd_850f8cf0010c4d269ab71d864610097a | https://github.com/noahgolmant/pytorch-hessian-eigenthings/issues/41 | 来源讨论提到 python 相关条件，需在安装/试用前复核。

## 9. 能力坑 · 能力判断依赖假设

- 严重度：medium
- 证据强度：source_linked
- 发现：README/documentation is current enough for a first validation pass.
- 对用户的影响：假设不成立时，用户拿不到承诺的能力。
- 建议检查：将假设转成下游验证清单。
- 防护动作：假设必须转成验证项；没有验证结果前不能写成事实。
- 证据：capability.assumptions | hn_item:48132232 | https://news.ycombinator.com/item?id=48132232 | README/documentation is current enough for a first validation pass.

## 10. 运行坑 · 来源证据：AttributeError: 'HVPOperator' object has no attribute 'zero_grad'

- 严重度：medium
- 证据强度：source_linked
- 发现：GitHub 社区证据显示该项目存在一个运行相关的待验证问题：AttributeError: 'HVPOperator' object has no attribute 'zero_grad'
- 对用户的影响：可能增加新用户试用和生产接入成本。
- 建议检查：来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。
- 防护动作：不得脱离来源链接放大为确定性结论；需要标注适用版本和复核状态。
- 证据：community_evidence:github | cevd_b515f5c06a5744b19b667bcbc8123348 | https://github.com/noahgolmant/pytorch-hessian-eigenthings/issues/38 | 来源类型 github_issue 暴露的待验证使用条件。

## 11. 维护坑 · 维护活跃度未知

- 严重度：medium
- 证据强度：source_linked
- 发现：未记录 last_activity_observed。
- 对用户的影响：新项目、停更项目和活跃项目会被混在一起，推荐信任度下降。
- 建议检查：补 GitHub 最近 commit、release、issue/PR 响应信号。
- 防护动作：维护活跃度未知时，推荐强度不能标为高信任。
- 证据：evidence.maintainer_signals | hn_item:48132232 | https://news.ycombinator.com/item?id=48132232 | last_activity_observed missing

## 12. 安全/权限坑 · 下游验证发现风险项

- 严重度：medium
- 证据强度：source_linked
- 发现：no_demo
- 对用户的影响：下游已经要求复核，不能在页面中弱化。
- 建议检查：进入安全/权限治理复核队列。
- 防护动作：下游风险存在时必须保持 review/recommendation 降级。
- 证据：downstream_validation.risk_items | hn_item:48132232 | https://news.ycombinator.com/item?id=48132232 | no_demo; severity=medium

## 13. 安全/权限坑 · 存在评分风险

- 严重度：medium
- 证据强度：source_linked
- 发现：no_demo
- 对用户的影响：风险会影响是否适合普通用户安装。
- 建议检查：把风险写入边界卡，并确认是否需要人工复核。
- 防护动作：评分风险必须进入边界卡，不能只作为内部分数。
- 证据：risks.scoring_risks | hn_item:48132232 | https://news.ycombinator.com/item?id=48132232 | no_demo; severity=medium

## 14. 维护坑 · issue/PR 响应质量未知

- 严重度：low
- 证据强度：source_linked
- 发现：issue_or_pr_quality=unknown。
- 对用户的影响：用户无法判断遇到问题后是否有人维护。
- 建议检查：抽样最近 issue/PR，判断是否长期无人处理。
- 防护动作：issue/PR 响应未知时，必须提示维护风险。
- 证据：evidence.maintainer_signals | hn_item:48132232 | https://news.ycombinator.com/item?id=48132232 | issue_or_pr_quality=unknown

## 15. 维护坑 · 发布节奏不明确

- 严重度：low
- 证据强度：source_linked
- 发现：release_recency=unknown。
- 对用户的影响：安装命令和文档可能落后于代码，用户踩坑概率升高。
- 建议检查：确认最近 release/tag 和 README 安装命令是否一致。
- 防护动作：发布节奏未知或过期时，安装说明必须标注可能漂移。
- 证据：evidence.maintainer_signals | hn_item:48132232 | https://news.ycombinator.com/item?id=48132232 | release_recency=unknown

<!-- canonical_name: noahgolmant/pytorch-hessian-eigenthings; human_manual_source: deepwiki_human_wiki -->
