利用faiss和flask提供矢量搜索服务API

需求背景

上一篇文章已经完成了对该开源库的调研，对于一些性能和使用姿势来说也有了一些基本的了解。在调研期内也通读了faiss的官方wiki，现在，准备开始动手了。有兴趣了解的同学可以戳链接faiss的一些相关调研。
动手之前还是需要再次静静，好好思考这一次任务要输出的是什么内容。emm，本打野选手在读条时已经养成了为整局游戏写剧本的习惯了。这次继续以流程图的方式来输出，流程图的好处除了能让你理清思路以外，更重要的是能让你确定你的思路是不是和leader在同一条线上，确定这次任务的分界线(这个很重要)，也是工作结果的痕迹。

上图中主要表达了一个使用faiss来进行搜索的API接口的流程，不同于以往的跟数据互动的方式(结构数据库，非结构数据库，图数据库等)，faiss只是一个比较简陋的开源库，他并没有完整的提供一套解决方案。类比的话就好像elasticsearch和solr中的lucene包一样，而我要做的就是在此基础上二次开发，提供一套可用的解决方案。考虑到faiss是一个C++的开源工具库，它只提供了python的接口，所以只能使用python来做这次接口开发。考察过后决定技术选型为flask+uwsgi+faiss来完成这个接口。

环境依赖

faiss的库
python2.7
uwsgi
pycharm

吃井不忘挖水人

专门开一个标题来感谢一下这哥们plippe faiss-web-service。他开源的这个demo满足了我百分60以上的需求，本次的开发基本就是在读懂他的代码以后才能这么胸有成竹。

过程复盘

也不想唠唠叨叨的复盘整个开发过程，就只复盘几个比较棘手的点

python的API如何开发

本身比较习惯于使用Java，对于python更多的是会用来做一些小运维的脚本，所以对于python中的web开发会比较模糊。短时间内我不太愿意再投入学习成本在flask的所有细节上，因为以后可能再次重逢的缘分并不多。那么怎么快速的用flask开发一个web接口呢，如果你是Java工程师你可以参考下我的思路，大概两部就可以完成一个简单可拓展的接口，首先是主入口

# -*- coding: UTF-8 -*-

from flask import Flask
from faiss_index import blueprint as FaissIndexBlueprint

app = Flask(__name__)


app.config.from_pyfile('config.py')

app.register_blueprint(FaissIndexBlueprint.blueprint)


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

其次是在主入口中注册的模块(Blueprint)

# -*- coding: UTF-8 -*-

from jsonschema import validate, ValidationError
from flask import Blueprint, jsonify, request
from werkzeug.exceptions import BadRequest
from faiss_index import FaissIndex
import json

try:
    import uwsgi
except ImportError:
    print('Failed to load python module uwsgi')
    print('Periodic faiss index updates isn\'t enabled')

    uwsgi = None

blueprint = Blueprint('faiss_index', __name__)

@blueprint.route('/ping')
def ping():
    return "pong"

OK直接运行app.py就可以用flask自带的wsgi服务器启动app，看到这里是否会觉得和springboot非常相似？以及包括@blueprint.route('/ping')这样的路由方式，让我觉得像极了springmvc的路由注解方式，所以几乎不需要耗费特别多的学习成本投入到这上面，节省了比较多的时间。余下的工作就是开始慢慢拓展开程序。

搜索的参数

API调用方要提供的参数是一维向量，目的是搜索距离最近的K个向量，向量具体在程序中怎么表示呢？就是一维数组。比如[1,2,3,4,5]，但是在拿到向量后不能马上进行搜索，要进行处理，如下

        vectors = [np.array(vectors, dtype=np.float32)]
        vectors = np.atleast_2d(vectors)

部署的方式-Docker

相比其他python web API来说，faiss搜索有一点特殊的地方，就是它最重要的依赖faiss本身。而faiss本身安装有两种方式

通过下载源代码进行编译非常麻烦
通过anconda进行安装一行代码完成
但是服务器上本身是可能有其他python环境在运行的。不可能专门的让我为了部署我的工程而去改动，可能还能通过env的方式解决？但是我不够熟悉python，所以选择了我擅长的隔离方式Docker。原理就是从ubunt的image开始构建，首先构建出一个faiss运行环境的image，然后在第二个image上打包自己的flask程序。附上构建运行环境的Dockerfile

ARG IMAGE
FROM ${IMAGE}

ARG FAISS_CPU_OR_GPU
ARG FAISS_VERSION

RUN apt-get update && \
    apt-get install -y curl bzip2  && \
    curl https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh > /tmp/conda.sh && \
    bash /tmp/conda.sh -b -p /opt/conda && \
    /opt/conda/bin/conda update -n base conda && \
    /opt/conda/bin/conda install -y -c pytorch faiss-${FAISS_CPU_OR_GPU}=${FAISS_VERSION} && \
    apt-get remove -y --auto-remove curl bzip2 && \
    apt-get clean && \
    rm -fr /tmp/conda.sh

ENV PATH="/opt/conda/bin:${PATH}"

以及我打包到dockerhub上的镜像faiss-docker
可以在docker中搜索我的镜像pull下来使用

docker search huangqq
docker pull huangqq/faiss-docker:1.2.1-cpu

总结

最麻烦的使用姿势其实已经在上一篇调研中理清的差不多了，本篇主要是在探讨faiss在工程化应用的一些实践，如果有需要交流的欢迎右手边微信~

利用faiss和flask提供矢量搜索服务API