ActuosusAI 项目使用教程

1. 项目目录结构及介绍

ActuosusAI 项目的目录结构如下：

ActuosusAI/
├── .github/              # 存放 GitHub Actions 工作流文件
│   └── workflows/
├── docker-compose-cpu.yml # Docker Compose 配置文件，用于 CPU 环境
├── docker-compose-gpu.yml # Docker Compose 配置文件，用于 GPU 环境
├── .env                  # 环境变量配置文件
├── .gitignore            # Git 忽略文件
├── Dockerfile.cpu        # Docker 构建文件，用于 CPU 环境
├── Dockerfile.gpu        # Docker 构建文件，用于 GPU 环境
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── frontend/             # 前端代码目录
├── backend/              # 后端代码目录

详细介绍：

• .github/workflows/: 存放自动化流程（如 CI/CD）的配置文件。
• docker-compose-cpu.yml 和 docker-compose-gpu.yml: 使用 Docker Compose 定义的多容器应用的配置文件，分别为 CPU 和 GPU 环境准备。
• .env: 存储环境变量，如 API 密钥等敏感信息。
• .gitignore: 指定 Git 忽略跟踪的文件和目录。
• Dockerfile.cpu 和 Dockerfile.gpu: 用于构建 Docker 容器的文件，分别针对 CPU 和 GPU 环境。
• LICENSE: 项目使用的 Apache-2.0 许可证。
• README.md: 项目说明文件，介绍项目的相关信息和使用方法。
• frontend/: 项目的前端代码目录，通常包含 HTML、CSS 和 JavaScript 文件。
• backend/: 项目的后端代码目录，包含服务端的逻辑和数据库相关文件。

2. 项目的启动文件介绍

项目的启动主要依赖于 Docker Compose，通过执行以下命令来启动应用：

• 对于 CPU 环境：

docker-compose -f docker-compose-cpu.yml up --build

• 对于 GPU 环境：

docker-compose -f docker-compose-gpu.yml up --build

--build 参数会在启动容器前构建镜像。

启动后，可以通过浏览器访问 http://localhost:3000 来与应用交互。

3. 项目的配置文件介绍

项目的配置主要通过 .env 文件进行。以下是一些可能的配置项：

• huggingface_token: Hugging Face 的访问令牌，用于下载需要认证的模型。

在开始使用项目前，需要创建一个 .env 文件（如果尚未存在），并在其中添加所需的配置项。例如：

huggingface_token=your_token_here

确保所有敏感信息都存储在 .env 文件中，并在 .gitignore 文件中忽略它，以防止敏感信息泄露。

以上就是 ActuosusAI 项目的目录结构、启动文件和配置文件的介绍。通过这些信息，您可以更好地理解项目结构，并顺利地启动和运行项目。