Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matsui528/sis
Simple image search engine
https://github.com/matsui528/sis
aws-ec2 flask image-retrieval image-search keras python search-engine
Last synced: about 2 months ago
JSON representation
Simple image search engine
- Host: GitHub
- URL: https://github.com/matsui528/sis
- Owner: matsui528
- License: mit
- Created: 2017-03-08T03:13:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-11-14T14:55:38.000Z (almost 3 years ago)
- Last Synced: 2024-05-27T12:08:42.268Z (4 months ago)
- Topics: aws-ec2, flask, image-retrieval, image-search, keras, python, search-engine
- Language: Python
- Homepage: http://yusukematsui.me/project/sis/sis.html
- Size: 27.3 KB
- Stars: 733
- Watchers: 21
- Forks: 238
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple Image Search Engine
## [Demo](https://www.simple-image-search.xyz/)
## Workflow
## News
- [2020.06] Updated many parts of the code for [CVPR 2020 tutorial](https://matsui528.github.io/cvpr2020_tutorial_retrieval/)
## Overview
- Simple image-based image search engine using Keras + Flask. You can launch the search engine just by running two python scripts.
- `offline.py`: This script extracts a deep-feature from each database image. Each feature is a 4096D fc6 activation from a VGG16 model with ImageNet pre-trained weights.
- `server.py`: This script runs a web-server. You can send your query image to the server via a Flask web-interface. The server finds similar images to the query by a simple linear scan.
- GPUs are not required.
- Tested on Ubuntu 18.04 and WSL2 (Ubuntu 20.04)
## Links
- [Demo](https://www.simple-image-search.xyz/)
- [Course at CVPR2020](https://matsui528.github.io/cvpr2020_tutorial_retrieval/) [[slides](https://speakerdeck.com/matsui_528/cvpr20-tutorial-live-coding-demo-to-implement-an-image-search-engine-from-scratch)] [[video](https://www.youtube.com/watch?v=M0Y9_vBmYXU)]
- [Project page](http://yusukematsui.me/project/sis/sis.html)
- [Tutorial](https://ourcodeworld.com/articles/read/981/how-to-implement-an-image-search-engine-using-keras-tensorflow-with-python-3-in-ubuntu-18-04) and [Video](https://www.youtube.com/watch?v=Htu7b8PUyRg) by [@sdkcarlos](https://github.com/sdkcarlos)
## Usage
```bash
git clone https://github.com/matsui528/sis.git
cd sis
pip install -r requirements.txt
# Put your image files (*.jpg) on static/img
# Then fc6 features are extracted and saved on static/feature
# Note that it takes time for the first time because Keras downloads the VGG weights.
python offline.py
# Now you can do the search via localhost:5000
python server.py
```
## Advanced: Launch on AWS
- You can easily launch the search engine server on AWS EC2. Please first open the port 5000 and launch an EC2 instance. Note that you need to create a security group such that the port 5000 is opened.
- A middle-level CPU instance is sufficient, e.g., m5.large.
- After you log-in to the instance by ssh, please setup the python environment (e.g., by [anaconda](https://docs.anaconda.com/anaconda/install/linux/)).
- Run `offline.py` and `server.py`.
- After you run `python server.py`, you can access the server from your browser via something like `http://ec2-XX-XX-XXX-XXX.us-west-2.compute.amazonaws.com:5000`
- (Advanced) If you'd like to deploy the system in a secure way, please consider running the search engine with the usual web server, e.g., uWSGI + nginx.
- (Advanced) If you want to deploy the system serverlessly, [AWS AppRunner](https://docs.aws.amazon.com/apprunner/latest/dg/what-is-apprunner.html) is the way to go.
## Citation
@misc{sis,
author = {Yusuke Matsui},
title = {Simple Image Search Engine},
howpublished = {\url{https://github.com/matsui528/sis}}
}