YuLan-OneSim项目安装与部署指南

项目概述

YuLan-OneSim是一个基于Docker容器技术的仿真系统，提供了快速部署和开发模式两种安装方式。本文将详细介绍该项目的安装流程、环境配置以及依赖管理，帮助用户快速搭建运行环境。

快速安装（Docker方式）

环境准备

在开始安装前，请确保系统已安装Docker引擎：

• Windows/macOS用户：下载并安装Docker Desktop应用程序
• Linux用户：执行以下命令安装Docker

  curl -fsSL https://get.docker.com | sh
  

安装步骤

1. 拉取Docker镜像

   docker pull ptss/yulan-onesim
   

2. 获取项目代码

   git clone 项目仓库地址
   cd YuLan-OneSim
   

3. 配置文件准备 在启动容器前，必须配置以下文件：

   • config/config.json：主配置文件
   • config/model_config.json：模型配置文件

4. 启动容器

   docker run -d --name yulan-onesim -p 8000:80 -v ./config:/app/config ptss/yulan-onesim:latest
   

   参数说明：

   • -p 8000:80：将容器80端口映射到主机8000端口
   • -v ./config:/app/config：挂载本地配置目录到容器内

5. 访问系统 启动完成后，在浏览器中访问：

   http://localhost:8000
   

开发模式安装

对于需要二次开发的用户，建议使用开发模式安装：

1. 获取项目代码

   git clone 项目仓库地址
   cd YuLan-OneSim
   

2. 可编辑模式安装

   pip install -e .
   

3. 安装调优依赖（可选）

   pip install -e .[tune]
   

依赖管理

核心依赖

项目运行所需的主要Python包包括：

• Web框架：FastAPI、Uvicorn
• 数据库：asyncpg
• 数据处理：numpy、pandas
• 可视化：matplotlib、seaborn、pyvis
• AI相关：faiss-cpu、Protobuf
• 工具类：loguru、tqdm

大模型微调依赖

如需进行大模型微调，需要额外安装：

• 深度学习框架：torch
• 模型库：transformers
• 微调工具：peft、trl
• 推理加速：vllm
• 实验管理：mlflow

常见问题

1. 容器启动失败

   • 检查Docker服务是否正常运行
   • 确认配置文件已正确设置并挂载

2. 端口冲突

   • 如8000端口被占用，可修改-p参数映射其他端口

3. 依赖冲突

   • 建议使用虚拟环境隔离项目依赖
   • 开发模式下可使用pip check验证依赖关系

最佳实践

1. 生产环境部署

   • 建议使用Docker Compose管理多容器部署
   • 配置持久化存储确保数据安全

2. 开发环境配置

   • 使用IDE（如VSCode、PyCharm）配置Python解释器
   • 设置断点调试功能便于开发

3. 性能优化

   • 根据硬件配置调整模型参数
   • 监控系统资源使用情况

通过本指南，用户应能顺利完成YuLan-OneSim项目的安装部署。如需进一步了解系统功能和使用方法，请参考项目文档中的其他章节。