openTSNE 项目教程

1. 项目目录结构及介绍

openTSNE 项目的目录结构如下：

openTSNE/
├── benchmarks/
├── docs/
├── examples/
├── notes/
├── openTSNE/
├── tests/
├── .gitignore
├── CITATION.cff
├── LICENSE
├── MANIFEST.in
├── README.rst
├── azure-pipelines-release.yml
├── azure-pipelines.yml
├── pyproject.toml
├── readthedocs.yml
├── setup.py

目录介绍：

• benchmarks/: 包含性能基准测试的代码和脚本。
• docs/: 包含项目的文档文件，通常是 Markdown 或 reStructuredText 格式。
• examples/: 包含使用 openTSNE 的示例代码，帮助用户快速上手。
• notes/: 可能包含开发笔记、设计文档或其他内部文档。
• openTSNE/: 核心代码库，包含 t-SNE 算法的实现。
• tests/: 包含单元测试和集成测试的代码。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要版本控制。
• CITATION.cff: 引用文件，指导用户如何引用该项目。
• LICENSE: 项目许可证文件，这里是 BSD-3-Clause 许可证。
• MANIFEST.in: 指定在打包时需要包含的文件。
• README.rst: 项目介绍文件，通常包含项目概述、安装说明和基本使用方法。
• azure-pipelines-release.yml: Azure Pipelines 的发布配置文件。
• azure-pipelines.yml: Azure Pipelines 的 CI/CD 配置文件。
• pyproject.toml: 项目配置文件，定义了项目的构建系统和依赖。
• readthedocs.yml: Read the Docs 的配置文件，用于文档构建和部署。
• setup.py: Python 项目的安装脚本，用于安装项目的依赖和编译必要的二进制文件。

2. 项目的启动文件介绍

openTSNE 项目的启动文件是 setup.py。这个文件用于安装项目的依赖和编译必要的二进制文件。用户可以通过以下命令安装 openTSNE：

pip install .

在安装过程中，setup.py 会自动处理依赖关系并编译所需的二进制文件。

3. 项目的配置文件介绍

openTSNE 项目的主要配置文件是 pyproject.toml 和 setup.py。

pyproject.toml

pyproject.toml 是一个标准的 Python 项目配置文件，定义了项目的构建系统和依赖。以下是一个示例内容：

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "openTSNE"
version = "1.0.0"
description = "A modular Python implementation of t-Distributed Stochasitc Neighbor Embedding (t-SNE)"
authors = [
    { name="Pavlin Poličar", email="[e-mail]" }
]
license = { file="LICENSE" }
readme = "README.rst"
requires-python = ">=3.8"
dependencies = [
    "numpy",
    "scikit-learn",
    "scipy"
]

setup.py

setup.py 是 Python 项目的安装脚本，定义了项目的元数据、依赖关系和编译选项。以下是一个示例内容：

from setuptools import setup, find_packages

setup(
    name="openTSNE",
    version="1.0.0",
    description="A modular Python implementation of t-Distributed Stochasitc Neighbor Embedding (t-SNE)",
    author="Pavlin Poličar",
    author_email="[e-mail]",
    license="BSD-3-Clause",
    packages=find_packages(),
    install_requires=[
        "numpy",
        "scikit-learn",
        "scipy"
    ],
    extras_require={
        "test": ["pytest"],
    },
    include_package_data=True,
    zip_safe=False,
)

通过这些配置文件，用户可以轻松地安装和管理 openTSNE 项目的依赖，并进行必要的编译和构建。