快速可微排序与排名

O(n log n) 时间复杂度的可微排序与排名操作。

依赖项

• NumPy
• SciPy
• Numba
• TensorFlow（可选）
• PyTorch（可选）

TensorFlow 示例

>>> import tensorflow as tf
>>> from fast_soft_sort.tf_ops import soft_rank, soft_sort
>>> values = tf.convert_to_tensor([[5., 1., 2.], [2., 1., 5.]], dtype=tf.float64)
>>> soft_sort(values, regularization_strength=1.0)
<tf.Tensor: shape=(2, 3), dtype=float64, numpy= array([[1.66666667, 2.66666667, 3.66666667], [1.66666667, 2.66666667, 3.66666667]])>
>>> soft_sort(values, regularization_strength=0.1)
<tf.Tensor: shape=(2, 3), dtype=float64, numpy= array([[1., 2., 5.], [1., 2., 5.]])>
>>> soft_rank(values, regularization_strength=2.0)
<tf.Tensor: shape=(2, 3), dtype=float64, numpy= array([[3. , 1.25, 1.75], [1.75, 1.25, 3. ]])>
>>> soft_rank(values, regularization_strength=1.0)
<tf.Tensor: shape=(2, 3), dtype=float64, numpy= array([[3., 1., 2.], [2., 1., 3.]])>

JAX 示例

>>> import jax.numpy as jnp
>>> from fast_soft_sort.jax_ops import soft_rank, soft_sort
>>> values = jnp.array([[5., 1., 2.], [2., 1., 5.]], dtype=jnp.float64)
>>> soft_sort(values, regularization_strength=1.0)
[[1.66666667 2.66666667 3.66666667]
 [1.66666667 2.66666667 3.66666667]]
>>> soft_sort(values, regularization_strength=0.1)
[[1. 2. 5.]
 [1. 2. 5.]]
>>> soft_rank(values, regularization_strength=2.0)
[[3.   1.25 1.75]
 [1.75 1.25 3.  ]]
>>> soft_rank(values, regularization_strength=1.0)
[[3. 1. 2.]
 [2. 1. 3.]]

PyTorch 示例

>>> import torch
>>> from pytorch_ops import soft_rank, soft_sort
>>> values = fast_soft_sort.torch.tensor([[5., 1., 2.], [2., 1., 5.]], dtype=torch.float64)
>>> soft_sort(values, regularization_strength=1.0)
tensor([[1.6667, 2.6667, 3.6667]
        [1.6667, 2.6667, 3.6667]], dtype=torch.float64)
>>> soft_sort(values, regularization_strength=0.1)
tensor([[1., 2., 5.]
        [1., 2., 5.]], dtype=torch.float64)
>>> soft_rank(values, regularization_strength=2.0)
tensor([[3.0000, 1.2500, 1.7500],
        [1.7500, 1.2500, 3.0000]], dtype=torch.float64)
>>> soft_rank(values, regularization_strength=1.0)
tensor([[3., 1., 2.]
        [2., 1., 3.]], dtype=torch.float64)

安装

运行 python setup.py install 或将 fast_soft_sort/ 文件夹复制到您的项目中。

参考文献

快速可微排序与排名 Mathieu Blondel, Olivier Teboul, Quentin Berthet, Josip Djolonga ICML 2020 会议论文 arXiv:2002.08871

fast-soft-sort 快速上手指南

fast-soft-sort 是一个提供可微分排序（Differentiable Sorting）和排名操作的高效库，时间复杂度为 O(n log n)。它支持 NumPy、SciPy、Numba，并可选集成 TensorFlow、PyTorch 和 JAX。

环境准备

在开始之前，请确保您的系统已安装 Python 环境，并具备以下基础依赖：

• 必需依赖：
  • NumPy
  • SciPy
  • Numba
• 可选框架依赖（根据您的需求选择安装）：
  • TensorFlow
  • PyTorch
  • JAX

提示：国内开发者建议使用国内镜像源加速安装依赖，例如使用清华源或阿里源。 示例：pip install numpy scipy numba -i https://pypi.tuna.tsinghua.edu.cn/simple

安装步骤

您可以通过以下两种方式之一安装 fast-soft-sort：

方式一：使用 setup.py 安装（推荐）

克隆仓库或下载源码后，在项目根目录运行：

python setup.py install

方式二：直接复制源码

将 fast_soft_sort/ 文件夹直接复制到您的项目目录中即可使用。

基本使用

该库的核心功能是 soft_sort（软排序）和 soft_rank（软排名）。通过调整 regularization_strength 参数，可以控制输出结果接近硬排序的程度（值越小越接近真实排序，值越大越平滑）。

以下是基于 TensorFlow 的最简使用示例（PyTorch 和 JAX 用法类似）：

>>> import tensorflow as tf
>>> from fast_soft_sort.tf_ops import soft_rank, soft_sort
>>> values = tf.convert_to_tensor([[5., 1., 2.], [2., 1., 5.]], dtype=tf.float64)

# 执行软排序 (正则化强度=1.0，结果较平滑)
>>> soft_sort(values, regularization_strength=1.0)
<tf.Tensor: shape=(2, 3), dtype=float64, numpy= array([[1.66666667, 2.66666667, 3.66666667], [1.66666667, 2.66666667, 3.66666667]])>

# 执行软排序 (正则化强度=0.1，结果接近真实排序 [1, 2, 5])
>>> soft_sort(values, regularization_strength=0.1)
<tf.Tensor: shape=(2, 3), dtype=float64, numpy= array([[1., 2., 5.], [1., 2., 5.]])>

# 执行软排名
>>> soft_rank(values, regularization_strength=1.0)
<tf.Tensor: shape=(2, 3), dtype=float64, numpy= array([[3., 1., 2.], [2., 1., 3.]])>

框架导入路径参考：

• TensorFlow: from fast_soft_sort.tf_ops import soft_rank, soft_sort
• JAX: from fast_soft_sort.jax_ops import soft_rank, soft_sort
• PyTorch: from pytorch_ops import soft_rank, soft_sort (注意需确保 torch tensor 创建方式正确)