FastAPI 模型服务器骨架

使用 Sebastián Ramírez 开发的强大 FastAPI 框架，以生产就绪、快速、简单且安全的方式部署机器学习模型。此仓库包含一个骨架应用，可用于加速您的下一个机器学习项目。代码经过全面测试，并提供预配置的 tox 工具，方便您快速扩展示例代码。

为了帮助您体验和了解如何使用此骨架，项目中包含了一个用于房价预测的回归模型示例。请按照安装和设置说明运行该示例模型，并将其作为 RESTful API 提供服务。

要求

• Python 3.11+
• Poetry

安装

在本地环境中安装所需依赖包（建议使用 virtualenv、conda 等虚拟环境工具）。

poetry install

设置

1. 复制 .env.example 文件并重命名为 .env。

2. 在 .env 文件中配置 API_KEY 条目。该密钥用于 API 的身份验证。
   可以使用 Python REPL 生成一个示例 API 密钥：

import uuid
print(str(uuid.uuid4()))

运行

1. 启动应用：

set -a
source .env
set +a
uvicorn fastapi_skeleton.main:app

2. 打开 http://localhost:8000/docs。
3. 点击“Authorize”，输入在设置步骤中创建的 API 密钥。
4. 您可以使用 docs/sample_payload.json 文件中的示例负载，在 API 中尝试房价预测模型。

代码检查

此骨架代码使用 isort、mypy、flake8、black 和 bandit 进行代码检查、格式化和静态分析。

运行代码检查：

./scripts/linting.sh

运行测试

运行测试：

./scripts/test.sh

此命令将针对 Python 3.11 和 Flake8、Autopep8、Bandit 运行测试及覆盖率检查。

更改日志

v.1.0.0 - 初始版本

• 使用 FastAPI 部署机器学习模型的基础功能。
• 全面的测试覆盖。

v.1.1.0 - 更新至 Python 3.11 和 FastAPI 0.108.0

• 升级到 Python 3.11。
• 添加代码检查脚本。
• 更新至 pydantic 2.x。
• 引入 Poetry 作为包管理工具。

fastapi-ml-skeleton 快速上手指南

fastapi-ml-skeleton 是一个基于 FastAPI 的生产级机器学习模型服务骨架项目。它提供了预配置的测试、代码规范和安全认证机制，帮助开发者快速构建用于部署 ML 模型的 RESTful API。本项目内置了一个房价预测回归模型示例。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows (WSL 推荐)
• Python 版本：3.11 或更高版本
• 包管理工具：Poetry

国内加速建议： 如果安装 Poetry 或下载依赖较慢，建议配置国内镜像源。

• Poetry 源配置：

  poetry config repositories.tsinghua https://pypi.tuna.tsinghua.edu.cn/simple/
  poetry config pypi-url https://pypi.tuna.tsinghua.edu.cn/simple/
  

安装步骤

1. 克隆项目（如果尚未获取代码）：

   git clone <repository_url>
   cd fastapi-ml-skeleton
   

2. 安装依赖： 使用 Poetry 安装项目所需的所有依赖包：

   poetry install
   

3. 配置环境变量： 复制示例配置文件并重命名为 .env：

   cp .env.example .env
   

4. 生成并设置 API 密钥： 打开 .env 文件，您需要配置 API_KEY 用于接口认证。可以使用 Python 生成一个随机 UUID：

   import uuid
   print(str(uuid.uuid4()))
   

   将生成的 UUID 填入 .env 文件中的 API_KEY 字段。

基本使用

完成安装和配置后，即可启动服务并测试内置的房价预测模型。

1. 启动服务： 加载环境变量并运行 Uvicorn 服务器：

   set -a
   source .env
   set +a
   uvicorn fastapi_skeleton.main:app
   

2. 访问文档界面： 在浏览器中打开 Swagger UI 文档地址： http://localhost:8000/docs

3. 身份认证：

   • 点击页面右上角的 Authorize 按钮。
   • 在弹出的对话框中输入您在 .env 文件中配置的 API_KEY。
   • 点击 Authorize 确认。

4. 调用预测接口：

   • 找到房价预测相关的接口（通常标记为 POST）。
   • 点击 Try it out。
   • 您可以参考项目目录下的 docs/sample_payload.json 文件构造请求体，或直接使用默认示例数据。
   • 点击 Execute 发送请求，即可查看模型返回的预测结果。