PyRetri/README.md

PyRetri

Introduction

PyRetri is an open source deep learning-based image retrieval toolbox based on PyTorch.

Major features

• Modular Design

  We decompose the deep learning-based image retrieval into several stages and one can easily construct a image retrieval pipeline by combining different modules.

• Flexible Loading

  The toolbox is able to adapt to load several types of model parameters, including parameters with the same keys and shape, parameters with different keys, and parameters with the same keys but different shapes.

• Support of Multiple Methods

  The toolbox directly supports popluar methods designed fot deep learning-based image retrieval.

• Combinations Search Tool

  We provide the pipeline combinations search scripts to help users to find possible combinations of approaches with various hyper-parameters.

Supported Methods

• Pre-processing
  • DirectReszie, PadResize, ShorterResize
  • CenterCrop, TenCrop
  • TwoFlip
  • ToTensor, ToCaffeTensor
  • Normalize
• Feature Representation
  • GAP
  • GMP
  • R-MAC
  • SPoC
  • CroW
  • SCDA
  • GeM
  • PWA
  • PCB
• Post-processing
  • SVD
  • PCA
  • DBA
  • QE
  • K-reciprocal

License

This project is released under the Apache 2.0 license.

Installation

Please refer to INSTALL.md for installation and dataset preparation.

Get Started

Please see GETTING_STARTED.md for the basic usage of PyRetri.

Model Zoo

Results and models are available in MODEL_ZOO.md.

Citation

If you use this toolbox in your research, please cite this project.