openTSNE

|构建状态| |ReadTheDocs徽章| |许可证徽章|

openTSNE 是 t-分布随机邻域嵌入 (t-SNE) [1]_ 的模块化 Python 实现，t-SNE 是一种用于可视化高维数据集的流行降维算法。openTSNE 结合了 t-SNE 算法的最新改进，包括将新数据点添加到现有嵌入的能力 [2]、大幅的速度提升 [3] [4]_ [5]（使 t-SNE 能够扩展到数百万个数据点），以及多种用于改善结果可视化全局对齐的技巧 [6]。

.. figure:: docs/source/images/macosko_2015.png :alt: Macosko 2015 小鼠视网膜 t-SNE 嵌入 :align: center

来自小鼠视网膜的 44,808 个单细胞转录组的可视化结果 [7]_，使用多尺度核技巧进行嵌入，以更好地保持聚类的全局对齐。

• 文档 <http://opentsne.readthedocs.io>__
• 用户指南与教程 <https://opentsne.readthedocs.io/en/latest/tsne_algorithm.html>__
• 示例：基础 <https://opentsne.readthedocs.io/en/latest/examples/01_simple_usage/01_simple_usage.html>、高级 <https://opentsne.readthedocs.io/en/latest/examples/02_advanced_usage/02_advanced_usage.html>、保持全局对齐 <https://opentsne.readthedocs.io/en/latest/examples/03_preserving_global_structure/03_preserving_global_structure.html>、嵌入大型数据集 <https://opentsne.readthedocs.io/en/latest/examples/04_large_data_sets/04_large_data_sets.html>
• 速度基准测试 <https://opentsne.readthedocs.io/en/latest/benchmarks.html>__

安装

openTSNE 可以在所有 受支持的 Python 版本 <https://devguide.python.org/versions/>_ 上安装。

Conda

可以通过 ``conda-forge`` 轻松安装 openTSNE：

::

   conda install --channel conda-forge opentsne

`Conda 包 <https://anaconda.org/conda-forge/opentsne>`__

PyPi
~~~~

openTSNE 也可以通过 ``pip`` 获取，并可使用以下命令安装：

::

   pip install opentsne

`PyPI 包 <https://pypi.org/project/openTSNE>`__

从源代码安装

如果您希望从源代码安装 openTSNE，请在根目录下运行：

::

pip install .

以安装必要的依赖项并编译所需的二进制文件。

请注意，openTSNE 需要系统中可用 C/C++ 编译器。为了使 openTSNE 能够利用多线程，C/C++ 编译器必须支持 OpenMP。实际上，几乎所有编译器都实现了这一点，除了较旧版本的 OSX 系统上的 clang。

为了充分发挥 openTSNE 的性能，您还可以考虑在安装前安装 FFTW3。FFTW3 实现了快速傅里叶变换，而快速傅里叶变换在 openTSNE 中被大量使用。如果 FFTW3 不可用，openTSNE 将使用 numpy 的 FFT 实现，其速度会略慢于 FFTW。这种差异仅在包含数百万个数据点的大规模数据集中才会明显。

一个“Hello World”示例

开始使用 openTSNE 非常简单。首先，我们使用 scikit-learn 加载一些数据：

.. code:: python

from sklearn import datasets

iris = datasets.load_iris() x, y = iris["data"], iris["target"]

然后，我们导入并运行：

.. code:: python

from openTSNE import TSNE

embedding = TSNE().fit(x)

引用

如果您在工作中使用了 openTSNE，我们非常感谢您能引用以下论文：

.. code::

@article{Policar2024,
    title={openTSNE: A Modular Python Library for t-SNE Dimensionality Reduction and Embedding},
    author={Poli{\v c}ar, Pavlin G. and Stra{\v z}ar, Martin and Zupan, Bla{\v z}},
    journal={Journal of Statistical Software},
    year={2024},
    volume={109},
    number={3},
    pages={1–30},
    doi={10.18637/jss.v109.i03},
    url={https://www.jstatsoft.org/index.php/jss/article/view/v109i03}
}

openTSNE 实现了两种高效的 t-SNE 算法。请考虑引用您所使用的算法的原始作者。如果您使用 FIt-SNE（默认），则引用为 [5]；如果您使用 Barnes-Hut，则引用为 [3] 和 [4]_。

参考文献

.. [1] Van Der Maaten, Laurens, and Hinton, Geoffrey. “Visualizing data using t-SNE.” <http://www.jmlr.org/papers/volume9/vandermaaten08a/vandermaaten08a.pdf>__ Journal of Machine Learning Research 9.Nov (2008): 2579-2605。 .. [2] Poličar, Pavlin G., Martin Stražar, and Blaž Zupan. “Embedding to Reference t-SNE Space Addresses Batch Effects in Single-Cell Classification.” <https://link.springer.com/article/10.1007/s10994-021-06043-1>__ Machine Learning (2021): 1-20。 .. [3] Van Der Maaten, Laurens. “Accelerating t-SNE using tree-based algorithms.” <http://www.jmlr.org/papers/volume15/vandermaaten14a/vandermaaten14a.pdf>__ Journal of Machine Learning Research 15.1 (2014): 3221-3245。 .. [4] Yang, Zhirong, Jaakko Peltonen, and Samuel Kaski. "Scalable optimization of neighbor embedding for visualization." <https://proceedings.mlr.press/v28/yang13b.html>__ International Conference on Machine Learning. PMLR, 2013。 .. [5] Linderman, George C., et al. "Fast interpolation-based t-SNE for improved visualization of single-cell RNA-seq data." <https://www.nature.com/articles/s41592-018-0308-4>__ Nature Methods 16.3 (2019): 243。 .. [6] Kobak, Dmitry, and Berens, Philipp. “The art of using t-SNE for single-cell transcriptomics.” <https://www.nature.com/articles/s41467-019-13056-x>__ Nature Communications 10, 5416 (2019）。 .. [7] Macosko, Evan Z., et al. “Highly parallel genome-wide expression profiling of individual cells using nanoliter droplets。” <https://www.sciencedirect.com/science/article/pii/S0092867415005498>__ Cell 161.5 (2015): 1202-1214。

.. |Build Status| image:: https://dev.azure.com/pavlingp/openTSNE/_apis/build/status/Test?branchName=master :target: https://dev.azure.com/pavlingp/openTSNE/_build/latest?definitionId=1&branchName=master .. |ReadTheDocs Badge| image:: https://readthedocs.org/projects/opentsne/badge/?version=latest :target: https://opentsne.readthedocs.io/en/latest/?badge=latest :alt: 文档状态 .. |License Badge| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg :target: https://opensource.org/licenses/BSD-3-Clause

openTSNE 快速上手指南

openTSNE 是一个模块化的 Python t-SNE 实现，专为高维数据可视化设计。它集成了最新的算法改进，支持将新数据点添加到现有嵌入中，具备极高的运行速度（可处理百万级数据点），并优化了全局结构的对齐效果。

环境准备

• 操作系统：支持 Linux、macOS 和 Windows。
• Python 版本：支持所有当前受支持的 Python 版本。
• 编译依赖：
  • 系统需安装 C/C++ 编译器。
  • 编译器必须支持 OpenMP 以启用多线程加速（大多数现代编译器均支持，但 macOS 上旧版 clang 除外）。
• 可选优化：
  • 建议预先安装 FFTW3 库。openTSNE 重度依赖快速傅里叶变换（FFT），使用 FFTW3 比默认的 NumPy 实现更快，尤其在处理百万级大数据集时性能提升明显。若未安装，程序将自动回退至 NumPy 实现。

安装步骤

你可以选择通过 Conda 或 pip 进行安装。国内用户若遇到下载缓慢问题，可配置相应的国内镜像源。

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

conda install --channel conda-forge opentsne

方式二：使用 pip 安装

pip install opentsne

提示：国内用户使用 pip 时，可添加 -i https://pypi.tuna.tsinghua.edu.cn/simple 参数使用清华镜像源加速下载。

方式三：从源码安装

如需从源码构建（例如为了启用特定的编译优化），请克隆仓库后在根目录执行：

pip install .

基本使用

openTSNE 的使用非常简洁，只需几行代码即可完成降维嵌入。以下是一个基于 scikit-learn Iris 数据集的"Hello World"示例：

1. 加载数据

from sklearn import datasets

iris = datasets.load_iris()
x, y = iris["data"], iris["target"]

2. 运行 t-SNE 嵌入

from openTSNE import TSNE

embedding = TSNE().fit(x)

执行完成后，embedding 变量即为降维后的结果，可直接用于可视化绘图。