https://github.com/oke-aditya/image_similarity

PyTorch Blog Post On Image Similarity Search
https://github.com/oke-aditya/image_similarity

auto-encoders autoencoder image-retrieval image-similarity pytorch unsupervised-learning

Last synced: 18 days ago
JSON representation

PyTorch Blog Post On Image Similarity Search

• Host: GitHub
• URL: https://github.com/oke-aditya/image_similarity
• Owner: oke-aditya
• License: apache-2.0
• Created: 2020-08-19T13:51:44.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-06-24T18:01:41.000Z (over 2 years ago)
• Last Synced: 2024-10-12T11:06:43.862Z (about 1 month ago)
• Topics: auto-encoders, autoencoder, image-retrieval, image-similarity, pytorch, unsupervised-learning
• Language: Python
• Homepage: https://oke-aditya.github.io/image_similarity/
• Size: 7.16 MB
• Stars: 249
• Watchers: 6
• Forks: 59
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Image Similarity using PyTorch

![CI Tests](https://github.com/oke-aditya/image_similarity/workflows/CI%20Tests/badge.svg)

![Check Formatting](https://github.com/oke-aditya/image_similarity/workflows/Check%20Formatting/badge.svg)

![Deploy mkdocs](https://github.com/oke-aditya/image_similarity/workflows/Deploy%20mkdocs/badge.svg)

![PyPi Release](https://github.com/oke-aditya/image_similarity/workflows/PyPi%20Release/badge.svg)

![Install Package](https://github.com/oke-aditya/image_similarity/workflows/Install%20Package/badge.svg)

## Auto-encoder based Image-Similarity Engine

Blog Post is [here](https://medium.com/pytorch/image-similarity-search-in-pytorch-1a744cf3469)

Dataset is available over [Kaggle](https://www.kaggle.com/datasets/okeaditya/animals-data)

Published in Official PyTorch Medium Channel. Thank you PyTorch team !

- Builds a simple Convolutional Auto-encoder based Image similarity engine.

- This solves the problem of finding similar images using unsupervised learning. There are no labels for images.

Tasks that it can do.

- [x] Similar images using Auto-encoders.

- [x] Similar image search from image features.

- [x] Clustering similar images.

## Repostory Structure.

```

=== data                        Read data from here. It is in gitignore so it won't appear here.

=== docs                        Documentation using mkdocs.

=== image_similarity

====== cluster_images.py        Clusters the embeddings learnt using PCA and T-SNE.

====== torch_data.py            Contains Dataset class to create PyTorch dataset from folder.

====== torch_model.py           Convolutional Auto-enocder Model.

====== torch_engine.py          Train_step and validation_step for training.

====== torch_train.py           Trainng script. Trains Auto-enocder and saves the embeddings.

====== torch_infer.py           Contains inference code

====== config.py                Configurations of models and paths.

====== torch_inference.ipynb    Inference code in .ipynb to play with.

====== torch_train.ipynb        Stand-alone code to train in Jupyter.

=== tests                       Contains tests for CI

```

## Documentation

Please visit [here](https://oke-aditya.github.io/image_similarity) for documentation.

It contains detailed description of work.

## Image similarity Outputs

Some sample outputs of recommendations.

![Output 1](outputs/query_image_0/Image_sim_op.png)

![Output 2](outputs/query_image_2/Image_sim_op2.png)

More outputs can be found in outputs folder.

## Models

- Some models trained using a sample dataset are given in [this](https://drive.google.com/drive/folders/1T6uS4O7LiuGMtXlRSMFmKAEDNQ08Ry25?usp=sharing) link.

- It contains encoder, decoder and numpy embeddings generated from auto-enocoders.

- These are obtained by running `torch_train.py` script.