2020-05-12 15:46:11 +08:00
```html
< p align = "center" >
< img src = './teaser_image/logo.jpg' >
< / p >
```
2020-05-12 15:36:33 +08:00
2020-04-28 11:04:20 +08:00
# PyRetri
2020-04-02 14:00:49 +08:00
2020-04-29 14:05:05 +08:00
Benyi Hu, Ren-Jie Song, Xiu-Shen Wei*, Yazhou Yao, Xian-Sheng Hua, Yuehu Liu
2020-05-07 12:08:03 +08:00
Corresponding author: [Xiu-Shen Wei ](http://www.weixiushen.com/ )
2020-05-07 11:45:09 +08:00
2020-04-02 14:00:49 +08:00
## Introduction
2020-05-07 11:45:09 +08:00
PyRetri (pronounced as [ˈ ɪ ˈ ː
2020-04-02 14:00:49 +08:00
2020-04-26 12:58:28 +08:00
2020-04-17 20:36:30 +08:00
2020-04-02 14:23:31 +08:00
### Major Features
2020-04-02 14:00:49 +08:00
2020-05-03 10:33:59 +08:00
PyRetri is a versatile deep learning based unsupervised image retrieval toolbox designed with simplicity and flexibility in mind.
2020-04-17 21:09:57 +08:00
2020-05-03 10:33:59 +08:00
- **Modular Design**: We decompose the deep learning based unsupervised image retrieval into several stages and users can easily construct an image retrieval pipeline by selecting and combining different modules.
2020-04-17 21:02:11 +08:00
- **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.
2020-05-03 10:33:59 +08:00
- **Support of Multiple Methods**: The toolbox directly supports several popluar methods designed for deep learning based unsupervised image retrieval, which is also suitable for person re-identification.
2020-04-28 15:00:41 +08:00
- **Configuration Search Tool**: We provide the configuration search tool to help users to find the optimal retrieval configuration with various hyper-parameters.
2020-04-02 14:00:49 +08:00
### Supported Methods
2020-05-03 10:33:59 +08:00
The toolbox supports popluar and prominent methods of unsupervised image retrieval and users can also design and add their own modules.
2020-04-17 22:37:22 +08:00
2020-04-02 14:00:49 +08:00
- **Pre-processing**
2020-04-28 17:57:45 +08:00
- DirectResize, PadResize, ShorterResize
2020-04-02 14:00:49 +08:00
- CenterCrop, TenCrop
- TwoFlip
- ToTensor, ToCaffeTensor
- Normalize
- **Feature Representation**
2020-04-21 22:06:43 +08:00
- Global Average Pooling (GAP), Global Max Pooling (GMP)
2020-04-21 22:18:38 +08:00
- [R-MAC ](https://arxiv.org/pdf/1511.05879.pdf ), [SPoC ](https://arxiv.org/pdf/1510.07493.pdf ), [CroW ](https://arxiv.org/pdf/1512.04065.pdf ), [GeM ](https://arxiv.org/pdf/1711.02512.pdf ), [SCDA ](http://www.weixiushen.com/publication/tip17SCDA.pdf ), [PWA ](https://arxiv.org/abs/1705.01247 )
2020-04-02 14:00:49 +08:00
- [PCB ](http://openaccess.thecvf.com/content_ECCV_2018/papers/Yifan_Sun_Beyond_Part_Models_ECCV_2018_paper.pdf )
- **Post-processing**
2020-04-17 21:00:30 +08:00
- [SVD ](https://link.springer.com/chapter/10.1007%2F978-3-662-39778-7_10 ), [PCA ](http://pzs.dstu.dp.ua/DataMining/pca/bibl/Principal%20components%20analysis.pdf )
2020-04-02 14:00:49 +08:00
- [DBA ](https://www.robots.ox.ac.uk/~vgg/publications/2012/Arandjelovic12/arandjelovic12.pdf )
2020-04-17 21:00:30 +08:00
- [QE ](https://www.robots.ox.ac.uk/~vgg/publications/papers/chum07b.pdf ), [K-reciprocal ](https://arxiv.org/pdf/1701.08398.pdf )
2020-04-02 14:00:49 +08:00
2020-05-07 11:45:09 +08:00
## Updates
2020-05-06 14:42:51 +08:00
**06 May 2020:** Our paper is online, you are welcomed to download the paper at [here ](https://128.84.21.199/abs/2005.02154 ).
2020-05-07 11:45:09 +08:00
**29 April 2020:** Our PyRetri is launched!
2020-04-02 14:00:49 +08:00
## Installation
2020-04-17 21:51:28 +08:00
Please refer to [INSTALL.md ](docs/INSTALL.md ) for installation and dataset preparation.
2020-04-02 14:00:49 +08:00
## Get Started
2020-04-17 21:51:28 +08:00
Please see [GETTING_STARTED.md ](docs/GETTING_STARTED.md ) for the basic usage of PyRetri.
2020-04-02 14:00:49 +08:00
## Model Zoo
2020-04-17 21:51:28 +08:00
Results and models are available in [MODEL_ZOO.md ](docs/MODEL_ZOO.md ).
2020-04-02 14:00:49 +08:00
2020-05-07 11:45:09 +08:00
## License
This project is released under the [Apache 2.0 license ](LICENSE ).
2020-04-02 14:00:49 +08:00
## Citation
2020-05-07 11:45:09 +08:00
If you use this toolbox in your research, please cite this paper.
2020-04-02 14:00:49 +08:00
2020-04-27 22:49:54 +08:00
```
2020-04-27 22:44:25 +08:00
@article {PyRetri,
2020-05-03 10:33:59 +08:00
title = {PyRetri: A PyTorch-based Library for Unsupervised Image Retrieval by Deep Convolutional Neural Networks},
2020-04-27 22:51:21 +08:00
author = {Hu, Benyi and Song, Ren-Jie and Wei, Xiu-Shen and Yao, Yazhou and Hua, Xian-Sheng and Liu, Yuehu},
2020-05-06 12:46:18 +08:00
journal= {arXiv preprint arXiv:2005.02154},
2020-04-27 22:51:21 +08:00
year = {2020}
2020-04-27 22:44:25 +08:00
}
2020-04-02 14:00:49 +08:00
```
2020-04-15 14:44:22 +08:00
## Contacts
2020-04-17 22:52:56 +08:00
If you have any questions about our work, please do not hesitate to contact us by emails.
Xiu-Shen Wei: [weixs.gm@gmail.com ](mailto:weixs.gm@gmail.com )
2020-04-17 22:53:48 +08:00
Benyi Hu: [hby0906@stu.xjtu.edu.cn ](mailto:hby0906@stu.xjtu.edu.cn )
2020-04-17 22:52:56 +08:00
2020-04-17 23:23:47 +08:00
Renjie Song: [songrenjie@megvii.com ](mailto:songrenjie@megvii.com )
2020-04-17 23:05:06 +08:00
