使用Flask通过REST API在Python中部署PyTorch

创建于：2019年7月3日 | 最后更新：2024年1月19日 | 最后验证：2024年11月5日

在本教程中，我们将使用Flask部署一个PyTorch模型，并暴露一个用于模型推理的REST API。特别是，我们将部署一个预训练的DenseNet 121模型，该模型用于检测图像。

提示

这里使用的所有代码均以MIT许可证发布，并可在Github上获取。

这代表了一系列关于在生产环境中部署PyTorch模型的教程中的第一篇。使用Flask这种方式是迄今为止开始服务你的PyTorch模型的最简单方法，但它不适用于具有高性能要求的用例。对于这种情况：

如果您已经熟悉TorchScript，可以直接跳转到我们的 Loading a TorchScript Model in C++ 教程。

如果您首先需要复习一下TorchScript，请查看我们的 Intro a TorchScript 教程。

API定义

我们将首先定义我们的API端点、请求和响应类型。我们的API端点将位于/predict，它接受带有包含图像的file参数的HTTP POST请求。响应将是包含预测的JSON响应：

{"class_id": "n02124075", "class_name": "Egyptian_cat"}

依赖项

通过运行以下命令安装所需的依赖项：

pip install Flask==2.0.1 torchvision==0.10.0

简单的Web服务器

以下是一个简单的Web服务器，取自Flask的文档

from flask import Flask
app = Flask(__name__)


@app.route('/')
def hello():
    return 'Hello World!'

我们还将更改响应类型，以便它返回包含ImageNet类ID和名称的JSON响应。更新后的app.py文件现在将是：

from flask import Flask, jsonify
app = Flask(__name__)

@app.route('/predict', methods=['POST'])
def predict():
    return jsonify({'class_id': 'IMAGE_NET_XXX', 'class_name': 'Cat'})

推理

在接下来的部分中，我们将重点编写推理代码。这将涉及两个部分，一个是我们准备图像以便可以输入到DenseNet中，接下来，我们将编写代码以从模型中获取实际的预测结果。

准备图像

DenseNet模型要求图像为224 x 224大小的3通道RGB图像。我们还将使用所需的均值和标准差值对图像张量进行归一化。您可以在这里阅读更多相关信息。

我们将使用transforms从torchvision库中构建一个转换管道，根据需要转换我们的图像。您可以在这里阅读更多关于转换的信息。

import io

import torchvision.transforms as transforms
from PIL import Image

def transform_image(image_bytes):
    my_transforms = transforms.Compose([transforms.Resize(255),
                                        transforms.CenterCrop(224),
                                        transforms.ToTensor(),
                                        transforms.Normalize(
                                            [0.485, 0.456, 0.406],
                                            [0.229, 0.224, 0.225])])
    image = Image.open(io.BytesIO(image_bytes))
    return my_transforms(image).unsqueeze(0)

上述方法以字节形式接收图像数据，应用一系列转换并返回一个张量。要测试上述方法，请以字节模式读取图像文件（首先将../_static/img/sample_file.jpeg替换为计算机上文件的实际路径），并查看是否返回了一个张量：

with open("../_static/img/sample_file.jpeg", 'rb') as f:
    image_bytes = f.read()
    tensor = transform_image(image_bytes=image_bytes)
    print(tensor)

预测

现在将使用预训练的DenseNet 121模型来预测图像类别。我们将使用torchvision库中的一个模型，加载模型并进行推理。虽然在这个例子中我们将使用预训练模型，但你可以使用相同的方法来处理你自己的模型。更多关于加载你的模型的信息，请参阅这个教程。

from torchvision import models

# Make sure to set `weights` as `'IMAGENET1K_V1'` to use the pretrained weights:
model = models.densenet121(weights='IMAGENET1K_V1')
# Since we are using our model only for inference, switch to `eval` mode:
model.eval()


def get_prediction(image_bytes):
    tensor = transform_image(image_bytes=image_bytes)
    outputs = model.forward(tensor)
    _, y_hat = outputs.max(1)
    return y_hat

张量 y_hat 将包含预测类别的索引。然而，我们需要一个人类可读的类别名称。为此，我们需要一个类别ID到名称的映射。下载这个文件作为 imagenet_class_index.json 并记住你保存它的位置（或者，如果你正在按照本教程的步骤操作，请将其保存在 tutorials/_static 中）。该文件包含ImageNet类别ID到ImageNet类别名称的映射。我们将加载这个JSON文件并获取预测索引的类别名称。

import json

imagenet_class_index = json.load(open('../_static/imagenet_class_index.json'))

def get_prediction(image_bytes):
    tensor = transform_image(image_bytes=image_bytes)
    outputs = model.forward(tensor)
    _, y_hat = outputs.max(1)
    predicted_idx = str(y_hat.item())
    return imagenet_class_index[predicted_idx]

在使用imagenet_class_index字典之前，我们首先将张量值转换为字符串值，因为imagenet_class_index字典中的键是字符串。我们将测试我们上面的方法：

with open("../_static/img/sample_file.jpeg", 'rb') as f:
    image_bytes = f.read()
    print(get_prediction(image_bytes=image_bytes))

你应该得到这样的响应：

['n02124075', 'Egyptian_cat']

数组中的第一项是ImageNet类ID，第二项是人类可读的名称。

Integrating the model in our API Server

在这最后一部分，我们将把我们的模型添加到我们的Flask API服务器中。由于我们的API服务器应该接收一个图像文件，我们将更新我们的predict方法以从请求中读取文件：

from flask import request

@app.route('/predict', methods=['POST'])
def predict():
    if request.method == 'POST':
        # we will get the file from the request
        file = request.files['file']
        # convert that to bytes
        img_bytes = file.read()
        class_id, class_name = get_prediction(image_bytes=img_bytes)
        return jsonify({'class_id': class_id, 'class_name': class_name})

import io
import json

from torchvision import models
import torchvision.transforms as transforms
from PIL import Image
from flask import Flask, jsonify, request


app = Flask(__name__)
imagenet_class_index = json.load(open('<PATH/TO/.json/FILE>/imagenet_class_index.json'))
model = models.densenet121(weights='IMAGENET1K_V1')
model.eval()


def transform_image(image_bytes):
    my_transforms = transforms.Compose([transforms.Resize(255),
                                        transforms.CenterCrop(224),
                                        transforms.ToTensor(),
                                        transforms.Normalize(
                                            [0.485, 0.456, 0.406],
                                            [0.229, 0.224, 0.225])])
    image = Image.open(io.BytesIO(image_bytes))
    return my_transforms(image).unsqueeze(0)


def get_prediction(image_bytes):
    tensor = transform_image(image_bytes=image_bytes)
    outputs = model.forward(tensor)
    _, y_hat = outputs.max(1)
    predicted_idx = str(y_hat.item())
    return imagenet_class_index[predicted_idx]


@app.route('/predict', methods=['POST'])
def predict():
    if request.method == 'POST':
        file = request.files['file']
        img_bytes = file.read()
        class_id, class_name = get_prediction(image_bytes=img_bytes)
        return jsonify({'class_id': class_id, 'class_name': class_name})


if __name__ == '__main__':
    app.run()

FLASK_ENV=development FLASK_APP=app.py flask run

库向我们的应用程序发送POST请求：

import requests

resp = requests.post("http://localhost:5000/predict",
                     files={"file": open('<PATH/TO/.jpg/FILE>/cat.jpg','rb')})

打印 resp.json() 现在将显示以下内容：

{"class_id": "n02124075", "class_name": "Egyptian_cat"}

我们编写的服务器非常简单，可能无法满足您生产应用程序的所有需求。因此，这里有一些您可以做的事情来使其更好：

端点 /predict 假设请求中始终会有一个图像文件。这可能并不适用于所有请求。我们的用户可能会使用不同的参数发送图像，或者根本不发送图像。

用户也可能发送非图像类型的文件。由于我们没有处理错误，这将会破坏我们的服务器。添加一个明确的错误处理路径，该路径将抛出异常，这将使我们能够更好地处理不良输入。

尽管模型可以识别大量类别的图像，但它可能无法识别所有图像。增强实现以处理模型无法识别图像中任何内容的情况。

我们在开发模式下运行Flask服务器，这不适合在生产环境中部署。你可以查看这个教程来了解如何在生产环境中部署Flask服务器。

您还可以通过创建一个带有表单的页面来添加UI，该表单接收图像并显示预测。查看类似项目的演示及其源代码。

在本教程中，我们只展示了如何构建一个可以一次返回单个图像预测的服务。我们可以修改我们的服务，使其能够一次返回多个图像的预测。此外，service-streamer库会自动将请求排队到您的服务中，并将它们采样成可以输入到您的模型中的小批量。您可以查看本教程。

最后，我们鼓励您查看我们在页面顶部链接的其他关于部署PyTorch模型的教程。

脚本总运行时间： ( 0 分钟 0.000 秒)

Gallery generated by Sphinx-Gallery