vearch

README

   

Overview

Vearch is a scalable distributed system for efficient similarity search of deep learning vectors.

Architecture

• Data Model

  space, documents, vectors, scalars

• Components

  Master, Router and PartitionServer

• Master

  Responsible for schema mananagement, cluster-level metadata, and resource coordination.

• Router

  Provides RESTful API: create , delete search and update ; request routing, and result merging.

• PartitionServer (PS)

  Hosts document partitions with raft-based replication.

  Gamma is the core vector search engine implemented based on faiss. It provides the ability of storing, indexing and retrieving the vectors and scalars.

Quick start

• Quickly build a distributed vector search system with RESTful API, please see docs/Deploy.md.

• Vearch can be leveraged to build a complete visual search system to index billions of images. The image retrieval plugin for object detection and feature extraction is also required. For more information, please refer to docs/Quickstart.md.

• Vearch Python SDK enables vearch to use locally. Vearch python sdk can be installed easily by pip install vearch. For more information, please refer to docs/APIPythonSDK.md.

APIs and Use Cases

LowLevelAPI

• docs/APILowLevel.md
• For GPU docs/APILowLevel.md

VisualSearchAPI

• docs/APIVisualSearch.md

PythonSDKAPI

• docs/APIPythonSDK.md

Document

• https://vearch.readthedocs.io/en/latest
• https://vearch.readthedocs.io/zh_CN/latest

Benchmarks

• benchmarks

Publication

Jie Li, Haifeng Liu, Chuanghua Gui, Jianyu chen, Zhenyun Ni, Ning Wang, Yuan Chen. The Design and Implementation of a Real Time Visual Search System on JD E-commerce Platform. In the 19th International ACM Middleware Conference, December 10–14, 2018, Rennes, France. https://arxiv.org/abs/1908.07389

Community

You can report bugs or ask questions in the issues page of the repository.

For public discussion of Vearch or for questions, you can also send email to vearch-maintainers@groups.io.

Our slack : https://vearchwrokspace.slack.com

License

Licensed under the Apache License, Version 2.0. For detail see LICENSE and NOTICE.

Documentation

Overview

Copyright 2019 The Vearch Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.