REINVENT 4

描述

REINVENT 是一款分子设计工具，适用于从头设计、骨架跃迁、R-基团替换、连接子设计、分子优化以及其他小分子设计任务。REINVENT 使用强化学习（RL）算法生成符合用户定义的多组分评分属性谱的优化分子。迁移学习（TL）可用于创建或预训练一个模型，该模型能够生成更接近一组输入分子的候选分子。

一篇介绍该软件的论文已在《化学信息学杂志》上以开放获取形式发表： Reinvent 4: 现代人工智能驱动的生成式分子设计。 有关先前论文的引用，请参阅 AUTHORS.md 文件。

要求

REINVENT 目前在 Linux 上开发，支持 GPU 和 CPU。Linux 版本已完全验证。Windows 上的 REINVENT 支持 GPU 和 CPU，而 macOSX 仅支持 CPU，但这两个平台的测试尚不充分，因此技术支持有限。

代码使用 Python 3（>= 3.10）编写。依赖项列表可在仓库中找到（另请参阅下方的安装说明）。

虽然 GPU 并非严格必要，但出于性能考虑强烈建议使用，尤其是在进行迁移学习和模型训练时。对于强化学习（RL），GPU 的重要性较低，因为大多数评分组件是在 CPU 上运行的。

请注意，如果您的计算机未安装 GPU，代码将自动在 CPU 上运行。截至撰写本文时，REINVENT 支持 NVIDIA GPU、部分 AMD GPU 和 Intel ARC 显卡。对于大多数设计任务，CPU 主内存和 GPU 显存各约 8 GiB 即可满足需求。

安装

1. 克隆此 Git 仓库。若只需最新版本，可添加 --depth 1 参数，因为仓库随着时间推移已变得相当庞大。

   git clone git@github.com:MolecularAI/REINVENT4.git  # --depth 1
   

2. 创建 Python 环境并安装兼容版本的 Python，例如使用 Conda 或其他虚拟环境。

   conda create --name reinvent4 python=3.10
   conda activate reinvent4
   

3. 切换到仓库目录以安装所有依赖项。您需要设置正确的处理器类型，详见 PyTorch 版本。Linux 支持 CUDA（如 "cu126"）、AMD ROCm（如 "rocm6.4"）、Intel XPU（"xpu"）以及 CPU。Windows 支持 CUDA、XPU 和 CPU。macOSX 仅支持 CPU（请使用 "mac" 作为处理器类型！）。此外，您可以选择依赖项 "openeye"（用于 ROCS；需自行获取许可证）、"isim" 用于 TensorBoard 中的相似性跟踪，或 "none" 跳过所有依赖项。默认会安装所有依赖项。详细信息请参阅安装脚本的帮助文本。

   python install.py --help
   python install.py cu126  # 或 rocm6.4、xpu、cpu、mac 等
   

4. 测试工具。安装程序已将脚本 reinvent 添加到您的 PATH 中。

   reinvent --help
   

先前模型

所有公开的先前模型均可在 Zenodo 上找到。

基本用法

REINVENT 是一个命令行工具，其主要工作流程如下：

reinvent -l sampling.log sampling.toml

这会将日志信息写入文件 sampling.log。如果您希望将日志输出到屏幕，则可省略 -l sampling.log 部分。sampling.toml 是配置文件。主要格式为 TOML，因为它通常更易于使用。JSON 和 YAML 也受支持。

仓库中 configs/ 目录下提供了适用于所有运行模式的 TOML 配置文件示例。这些文件中的文件路径需要根据您的本地安装进行调整。您需要根据所要解决的研究问题选择合适的模型和运行模式。configs/ 目录中还包含若干 *.md 文件，提供关于如何配置 TOML 文件的额外文档。内部先验模型可以使用点号表示法引用（参见 reinvent/prior_registry.py）。

教程 / Jupyter 笔记本

基本说明可在 configs/ 目录中配置示例的注释中找到。

笔记本位于 notebooks/ 目录中，贡献的笔记本和教程则位于 contrib/ 目录。请注意，我们以 jupytext 的“轻量脚本”格式提供笔记本。要使用这些轻量脚本，您需要安装 jupytext。此外，一些其他包也会很有用。

pip install jupytext mols2grid seaborn

然后，notebooks/ 目录中的 Python 文件可以转换为笔记本，例如：

jupytext -o Reinvent_demo.ipynb Reinvent_demo.py

评分插件

评分子系统采用简单的插件机制（Python 的 原生命名空间包）。如果您希望编写自己的插件，请按照以下说明操作。无需修改任何 REINVENT 代码。公共仓库中包含一个 contrib 目录，其中提供了一些有用的示例。

1. 在您方便的位置创建 /top/dir/somewhere/reinvent_plugins/components。
2. 请勿在 reinvent_plugins 或 components 中放置 __init__.py 文件，否则会破坏插件机制。可以在 components 内部创建普通包，只要正确导入即可。
3. 将文件名以 comp_* 开头的文件放入 reinvent_plugins/components 或其子目录中。其他名称的文件会被忽略，不会被导入。系统会递归搜索该目录，因此您可以按需组织代码结构，但目录/包名必须唯一。
4. 使用 @add_tag 装饰器标记该文件中的评分组件类。同一 comp_* 文件中可以添加多个组件类。请参考现有代码。
5. 同一文件中最多可标记一个用于参数的数据类，详情请参阅现有代码。这是可选的。
6. 将 /top/dir/somewhere 设置或添加到 PYTHONPATH 环境变量中，或使用其他方式扩展 sys.path。
7. 此时，REINVENT 应该会自动识别并加载该评分组件。

请确保组件能够正常导入。如果无法导入，日志文件会记录错误。您可以直接检查是否可以导入：

from reinvent_plugins.components import comp_myscorer

单元测试与集成测试

这主要是为开发者以及希望确保安装正常工作的管理员或用户准备的。此处的信息与 REINVENT 的实际使用无关。有关如何使用 reinvent 命令的说明，请参阅 基本用法。

REINVENT 项目使用 pytest 框架进行测试。在运行测试之前，您需要先创建一个测试配置文件。

在项目目录的 configs/ 子目录下创建一个名为 config.json 的文件。您可以以示例配置文件 example.config.json 作为基础。请确保将 MAIN_TEST_PATH 设置为一个不存在的目录，因为测试过程中生成的临时文件将会写入该目录。如果将其设置为一个已存在的目录，测试完成后该目录将会被删除。

部分测试需要专有的 OpenEye 许可证。为了使测试能够读取您的许可证，您需要进行一些配置。最简单的方法是将 OE_LICENSE 环境变量设置为包含许可证文件的路径。

完成配置并确保许可证可以被正确读取后，即可运行测试。

$ pytest tests --json /path/to/config.json --device cuda

REINVENT4 快速上手指南

REINVENT4 是一款基于强化学习（RL）和迁移学习（TL）的分子设计工具，适用于从头设计、骨架跃迁、R 基团替换、连接子设计及分子优化等任务。

环境准备

• 操作系统：
  • Linux：完全支持且经过充分验证（推荐）。
  • Windows：支持 GPU 和 CPU，但测试覆盖有限。
  • macOS：仅支持 CPU，测试覆盖有限。
• Python 版本：Python 3.10 或更高版本。
• 硬件要求：
  • GPU：非强制但强烈建议用于迁移学习和模型训练以提升性能。支持 NVIDIA、部分 AMD 及 Intel ARC 显卡。
  • 内存：CPU 主内存和 GPU 显存建议至少 8 GiB。
  • 若无 GPU，代码将自动在 CPU 上运行。
• 前置依赖管理：建议使用 Conda 创建虚拟环境。

安装步骤

1. 克隆仓库 使用 --depth 1 参数仅获取最新版本，以加快下载速度（仓库历史较大）。

   git clone git@github.com:MolecularAI/REINVENT4.git --depth 1
   cd REINVENT4
   

2. 创建 Python 环境 使用 Conda 创建名为 reinvent4 的环境并激活。

   conda create --name reinvent4 python=3.10
   conda activate reinvent4
   

3. 安装依赖 运行安装脚本，需根据硬件指定处理器类型（如 cu126 代表 CUDA 12.6，cpu 代表纯 CPU，mac 代表 macOS）。

   查看帮助信息：

   python install.py --help
   

   示例：安装支持 CUDA 12.6 的版本（Linux/Windows）

   python install.py cu126
   

   其他选项示例：rocm6.4 (AMD), xpu (Intel), cpu, mac。

   注：默认安装所有依赖。若需 OpenEye 相关功能（如 ROCS），需自行获取许可证；若需 TensorBoard 相似度追踪可添加 isim 选项。

4. 验证安装 安装完成后，reinvent 命令已加入环境变量。

   reinvent --help
   

基本使用

REINVENT4 主要通过命令行运行，核心逻辑是读取配置文件（TOML/JSON/YAML）并执行采样或训练。

1. 准备配置文件 仓库中的 configs/ 目录提供了各种运行模式的示例 TOML 文件。请复制一个示例文件并根据本地路径修改其中的模型路径和参数。

   • 主要格式推荐使用 TOML。
   • 内部预训练模型可通过点号表示法引用（参考 reinvent/prior_registry.py）。
   • 公开的历史模型可在 Zenodo 下载。

2. 运行工具 最基本的运行命令如下：

   reinvent -l sampling.log sampling.toml
   

   • sampling.toml：你的配置文件路径。
   • -l sampling.log：将日志输出到文件。若希望直接在屏幕显示日志，可省略此参数。

3. 进阶资源

   • 教程笔记：notebooks/ 目录提供 Jupytext 格式的脚本。需先安装 jupytext 将其转换为 .ipynb 文件：

     pip install jupytext mols2grid seaborn
     jupytext -o Reinvent_demo.ipynb Reinvent_demo.py
     

   • 自定义评分插件：通过创建符合规范的命名空间包（reinvent_plugins/components），无需修改源码即可扩展评分函数。