OTT文档详解：开发者必看的API接口与参数配置指南

OTT文档详解：开发者必看的API接口与参数配置指南

【免费下载链接】ottOptimal transport tools implemented with the JAX framework, to solve large scale matching problems of any flavor.项目地址: https://gitcode.com/gh_mirrors/ot/ott

Optimal Transport Tools (OTT) 是基于JAX框架实现的最优传输工具库，专为解决大规模匹配问题而设计。本文将详细解析OTT的核心API接口与参数配置方法，帮助开发者快速上手并充分利用其强大功能。

核心模块概览

OTT的架构清晰，主要包含以下核心模块，每个模块都提供了丰富的API接口：

几何模块（ott.geometry）

几何模块是OTT的基础，用于定义最优传输问题中的成本矩阵或核函数。该模块提供了多种几何类，适用于不同场景：

• Geometry：基础几何类，可通过矩形成本矩阵直接实例化
• PointCloud：点云几何类，通过输入/目标点云和成本函数定义
• Grid：网格几何类，适用于点位于笛卡尔网格上的场景
• Graph：图结构几何类，用于图上的最优传输问题
• LowRank：低秩几何类，提供高效的低秩成本矩阵表示

关键API与参数

PointCloud类是最常用的几何类之一，其构造函数参数如下：

ott.geometry.pointcloud.PointCloud( x, y=None, cost_fn=SqEuclidean(), epsilon=1.0, **kwargs )

• x/y：源/目标点云数据
• cost_fn：成本函数，默认为平方欧氏距离(SqEuclidean)
• epsilon：正则化参数，控制熵正则化强度

成本函数可从ott.geometry.costs模块选择，如欧氏距离(Euclidean)、余弦距离(Cosine)、Bures距离等。

问题模块（ott.problems）

问题模块用于描述不同类型的最优传输问题，主要包括：

• LinearProblem：线性最优传输问题（Kantorovich问题）
• QuadraticProblem：二次最优传输问题（Gromov-Wasserstein问题）
• BarycenterProblem：Wasserstein重心问题

线性问题API示例

ott.problems.linear.linear_problem.LinearProblem( geometry, a=None, b=None, tau_a=1.0, tau_b=1.0 )

• geometry：几何对象，如PointCloud
• a/b：源/目标概率分布
• tau_a/tau_b：非平衡参数，控制边际约束的松弛程度

求解器模块（ott.solvers）

求解器模块提供了多种算法来解决最优传输问题，核心求解器包括：

Sinkhorn求解器

Sinkhorn算法是解决大规模最优传输问题的高效方法，其API如下：

ott.solvers.linear.sinkhorn.Sinkhorn( threshold=1e-3, max_iter=200, epsilon=None, rank=None, acceleration=None, **kwargs )

• threshold：收敛阈值
• max_iter：最大迭代次数
• epsilon：正则化参数，若为None则使用几何对象中的epsilon
• rank：低秩近似的秩，用于大规模问题

Gromov-Wasserstein求解器

对于二次最优传输问题，可使用Gromov-Wasserstein求解器：

ott.solvers.quadratic.gromov_wasserstein.GromovWasserstein( gw_iterations=50, inner_iterations=10, sinkhorn_kwargs=None, **kwargs )

• gw_iterations：Gromov-Wasserstein迭代次数
• inner_iterations：每次GW迭代中的Sinkhorn迭代次数
• sinkhorn_kwargs：传递给内部Sinkhorn求解器的参数

快速上手示例

以下是一个简单的点云最优传输计算示例，展示了OTT API的基本使用流程：

import jax.numpy as jnp from ott.geometry import pointcloud from ott.problems.linear import linear_problem from ott.solvers.linear import sinkhorn # 生成随机点云 rng = jax.random.PRNGKey(42) x = jax.random.normal(rng, (100, 2)) y = jax.random.normal(rng, (80, 2)) # 创建几何对象 geom = pointcloud.PointCloud(x, y, epsilon=0.1) # 定义线性最优传输问题 problem = linear_problem.LinearProblem(geom) # 使用Sinkhorn求解器求解 solver = sinkhorn.Sinkhorn(max_iter=1000) result = solver(problem) # 获取最优传输矩阵 transport_matrix = result.matrix

高级参数配置

正则化参数调度

OTT支持动态调整正则化参数，通过Epsilon调度器实现：

from ott.geometry import epsilon_scheduler epsilon = epsilon_scheduler.Epsilon( target=0.01, scale=10.0, decay="exponential", num_steps=100 )

低秩优化配置

对于大规模问题，可使用低秩求解器提高效率：

solver = sinkhorn.Sinkhorn( rank=32, # 低秩近似的秩 threshold=1e-4, max_iter=500 )

神经网络传输映射（ott.neural）

OTT还提供了神经最优传输工具，可通过神经网络参数化传输映射：

• NeuralDual：使用输入凸神经网络(ICNN)近似Brenier势
• FlowMatching：通过神经ODE参数化速度场

相关实现位于ott.neural.networks和ott.neural.methods模块。

实用工具（ott.tools）

工具模块提供了多种基于最优传输的实用功能：

• SinkhornDivergence：计算Wasserstein距离的近似
• SoftSort：可微排序操作
• GaussianMixture：高斯混合模型间的最优传输

详细使用方法可参考官方文档中的工具模块说明。

总结

OTT提供了丰富的API接口和灵活的参数配置选项，能够高效解决各种最优传输问题。通过合理配置几何对象、问题定义和求解器参数，开发者可以轻松应对从简单点云匹配到复杂神经传输映射的各类应用场景。建议结合官方教程和示例代码深入学习，充分发挥OTT在大规模最优传输问题上的优势。

更多详细API文档可参考项目中的docs/目录，包括几何模块、问题模块、求解器模块等的完整接口说明。

【免费下载链接】ottOptimal transport tools implemented with the JAX framework, to solve large scale matching problems of any flavor.项目地址: https://gitcode.com/gh_mirrors/ot/ott