首页
/ scGPT开源项目安装与使用指南

scGPT开源项目安装与使用指南

2024-09-27 13:28:08作者:柯茵沙

1. 目录结构及介绍

scGPT是一个基于Generative AI的单细胞多组学基础模型。以下是其主要的目录结构及其简介:

scGPT/
├── data            # 数据相关文件夹,可能包括预处理数据或示例数据集
├── docs             # 文档资料,可能包含API文档和用户手册
├── examples        # 示例代码,提供如何使用scGPT的基本示例,如finetune_integration.py用于细调模型
├── tests           # 测试文件,用于开发过程中的单元测试
├── tutorials       # 教程文件,详细指导用户进行特定任务操作
├── .gitignore      # 忽略特定文件的配置文件
├── readthedocs.yaml # ReadTheDocs的构建配置文件
├── LICENSE         # 许可证文件,本项目遵循MIT许可证
├── README.md       # 项目介绍和快速入门指南
├── poetry.lock     # 使用Poetry管理依赖时的锁定文件
└── pyproject.toml   # 项目配置文件,定义依赖等信息

2. 项目的启动文件介绍

scGPT中,并没有明确指出一个单一的“启动”文件,因为它的使用取决于具体的应用场景。然而,开发者通常会从examples目录下的脚本开始,比如examples/finetune_integration.py,这是一个用于模型细调的示例。用户应该参照这些示例来启动他们的任务。

3. 项目的配置文件介绍

配置主要是通过环境变量和pyproject.toml以及潜在的数据加载配置(例如,在数据处理相关的脚本中)。pyproject.toml是现代Python项目用来声明元数据和依赖的地方。对于更具体的配置选项,比如模型参数、运行环境设置等,可能会散见于各个示例脚本或者特定的配置文件中,用户需根据实际应用调整这些脚本内的参数或查阅文档了解更详细的配置说明。

安装与初步使用

安装scGPT,可以使用pip命令,考虑到兼容性和依赖版本控制,推荐使用以下命令:

pip install scgpt "flash-attn<1.0.5"

如果遇到与orbax包不兼容的问题,可以尝试添加额外的限制条件:

pip install scgpt "flash-attn<1.0.5" "orbax<0.1.8"

开发环境下,建议使用Poetry作为包管理器:

$ git clone https://github.com/bowang-lab/scGPT.git
$ cd scGPT
$ poetry install

请注意,某些依赖项如flash-attn可能需要特定版本的GPU和CUDA,推荐使用的版本是CUDA 11.7和flash-attn<1.0.5以避免已知的安装问题。

为了更好的实验管理和可视化,推荐安装wandb库。

遵循以上步骤,您就可以开始探索并使用scGPT的强大功能了。记得查阅官方文档和提供的教程以获取更多细节和最佳实践。

登录后查看全文
热门项目推荐
相关项目推荐