开源项目使用教程:Diet-Recommendation-System
1. 项目目录结构及介绍
Diet-Recommendation-System 项目目录结构如下:
Diet-Recommendation-System/
├── Assets/ # 存放项目相关资源文件
├── Data/ # 存放项目所需数据集
├── Docs/ # 存放项目文档
├── FastAPI_Backend/ # FastAPI 后端代码
├── Streamlit_Frontend/ # Streamlit 前端代码
├── .gitattributes
├── .gitignore
├── CITATION.cff
├── CODE_OF_CONDUCT.md # 项目行为准则
├── LICENSE # 项目许可证
├── README.md # 项目说明文件
├── docker-compose.yml # Docker Compose 配置文件
└── food-recommendation-system.ipynb # Jupyter 笔记本,用于数据探索和模型开发
Assets/
: 存放项目所需的静态资源文件,如图片、样式表等。Data/
: 存放项目所使用的数据集,如食谱数据和用户评价数据。Docs/
: 存放项目的文档资料。FastAPI_Backend/
: 包含 FastAPI 框架下的后端代码,处理 API 请求和业务逻辑。Streamlit_Frontend/
: 包含 Streamlit 框架下的前端代码,用于构建用户界面。.gitattributes
: 配置 Git 的文件属性。.gitignore
: 配置 Git 忽略文件列表。CITATION.cff
: 用于引用项目的 CITATION 文件。CODE_OF_CONDUCT.md
: 项目行为准则文件,规定了项目参与者的行为规范。LICENSE
: 项目采用的许可证文件,本项目采用 Apache-2.0 许可。README.md
: 项目说明文件,介绍了项目的相关信息和使用方法。docker-compose.yml
: Docker Compose 配置文件,用于定义和运行多容器 Docker 应用。food-recommendation-system.ipynb
: Jupyter 笔记本文件,用于数据分析和模型开发。
2. 项目的启动文件介绍
项目的启动主要通过 docker-compose
进行。在项目根目录下,执行以下命令:
docker-compose up -d --build
该命令会根据 docker-compose.yml
文件定义的服务,构建并启动整个项目。-d
参数表示以守护进程方式运行,--build
参数表示在启动前构建镜像。
启动后,可以通过浏览器访问 http://localhost:8501
来使用 Streamlit 构建的前端应用。
3. 项目的配置文件介绍
项目的配置主要通过 docker-compose.yml
文件进行。以下是配置文件的基本结构:
version: '3.8'
services:
frontend:
build: ./Streamlit_Frontend
ports:
- "8501:8501"
backend:
build: ./FastAPI_Backend
ports:
- "8000:8000"
depends_on:
- frontend
在这个配置文件中,定义了两个服务 frontend
和 backend
:
frontend
: 定义了 Streamlit 前端服务的构建路径和端口映射。backend
: 定义了 FastAPI 后端服务的构建路径和端口映射,并且指定了它依赖于frontend
服务。
通过修改这个配置文件,可以调整服务的端口、环境变量等配置,以满足不同的部署需求。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考