nflows

nflows 是一个基于 PyTorch 的、功能全面的 归一化流 库。

安装

从 PyPI 安装

从 PyPI 安装：

python -m pip install nflows

从 conda-forge 安装

要安装 nflows 并将其添加到使用 pixi 的项目中，请在项目目录下运行：

pixi add nflows

若要在特定的 conda 环境中安装（使用 conda），请在激活的环境中运行：

conda install --channel conda-forge nflows

使用

定义一个流：

from nflows import transforms, distributions, flows

# 定义一个可逆变换。
transform = transforms.CompositeTransform([
    transforms.MaskedAffineAutoregressiveTransform(features=2, hidden_features=4),
    transforms.RandomPermutation(features=2)
])

# 定义一个基础分布。
base_distribution = distributions.StandardNormal(shape=[2])


# 组合成一个流。
flow = flows.Flow(transform=transform, distribution=base_distribution)

评估输入的对数概率：

log_prob = flow.log_prob(inputs)

从流中采样：

samples = flow.sample(num_samples)

更多工作流程示例请参见 examples 文件夹。

开发

安装所有开发依赖项：

pip install -r requirements.txt

引用 nflows

引用该包时，可以使用以下 BibTeX 格式：

@software{nflows,
  author       = {Conor Durkan and
                  Artur Bekasov and
                  Iain Murray and
                  George Papamakarios},
  title        = {{nflows}: normalizing flows in {PyTorch}},
  month        = nov,
  year         = 2020,
  publisher    = {Zenodo},
  version      = {v0.14},
  doi          = {10.5281/zenodo.4296287},
  url          = {https://doi.org/10.5281/zenodo.4296287}
}

版本号应与 nflows/version.py 中的版本一致。年份和月份对应于发布日期。其他版本的 BibTeX 条目可在 Zenodo 上找到。

如果您特别使用基于样条的流，请考虑引用《Neural Spline Flows》论文：[BibTeX]。

参考文献

nflows 源自 bayesiains/nsf，最初发表于：

C. Durkan, A. Bekasov, I. Murray, G. Papamakarios，《Neural Spline Flows》，NeurIPS 2019。 [arXiv] [BibTeX]

nflows 曾被用于：

Conor Durkan, Iain Murray, George Papamakarios，《关于无似然推断的对比学习》，ICML 2020。 [arXiv]。

Artur Bekasov, Iain Murray，《利用嵌套丢弃归一化流对维度进行排序》。 [arXiv]。

Tim Dockhorn, James A. Ritchie, Yaoliang Yu, Iain Murray，《利用归一化流进行密度去卷积》。 [arXiv]。

nflows 被条件密度估计库 pyknos 使用，而 pyknos 又是无似然推断框架 sbi 的一部分。

nflows 快速上手指南

nflows 是一个基于 PyTorch 的归一化流（Normalizing Flows）综合工具库，提供了丰富的可逆变换和分布模型，适用于概率密度估计和生成建模。

环境准备

• 操作系统：Linux、macOS 或 Windows
• Python 版本：建议 Python 3.7+
• 核心依赖：
  • PyTorch (需预先安装)
  • numpy
• 推荐包管理器：pip 或 conda

注意：请确保已正确安装与你的 CUDA 版本匹配的 PyTorch。国内用户可使用清华源或阿里源加速 PyTorch 安装。

安装步骤

你可以选择通过 PyPI 或 conda-forge 进行安装。

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

python -m pip install nflows

国内加速建议：

python -m pip install nflows -i https://pypi.tuna.tsinghua.edu.cn/simple

方式二：使用 conda 安装

如果你使用 conda 管理环境：

conda install --channel conda-forge nflows

国内加速建议（配置清华源后）：

conda install -c conda-forge nflows

若你使用 pixi 管理项目依赖：

pixi add nflows

基本使用

以下是最小化的工作流示例，展示如何定义一个流模型、计算对数概率以及采样。

1. 定义流模型

from nflows import transforms, distributions, flows

# 定义可逆变换序列
transform = transforms.CompositeTransform([
    transforms.MaskedAffineAutoregressiveTransform(features=2, hidden_features=4),
    transforms.RandomPermutation(features=2)
])

# 定义基础分布（标准正态分布）
base_distribution = distributions.StandardNormal(shape=[2])

# 组合成流模型
flow = flows.Flow(transform=transform, distribution=base_distribution)

2. 计算对数概率

假设 inputs 是一个形状为 [batch_size, 2] 的 PyTorch Tensor：

log_prob = flow.log_prob(inputs)

3. 从模型中采样

生成指定数量的样本：

samples = flow.sample(num_samples)

更多复杂示例（如训练循环、特定架构使用）请参考官方仓库中的 examples 文件夹。