Skip to main content

Python package clustimage is for unsupervised clustering of images.

Project description

clustimage

Python PyPI Version License Github Forks GitHub Open Issues Project Status Downloads Downloads DOI Open In Colab Sphinx Medium

The aim of clustimage is to detect natural groups or clusters of images. It works using a multi-step proces of carefully pre-processing the images, extracting the features, and evaluating the optimal number of clusters across the feature space. The optimal number of clusters can be determined using well known methods suchs as silhouette, dbindex, and derivatives in combination with clustering methods, such as agglomerative, kmeans, dbscan and hdbscan. With clustimage we aim to determine the most robust clustering by efficiently searching across the parameter and evaluation the clusters. Besides clustering of images, the clustimage model can also be used to find the most similar images for a new unseen sample.

A schematic overview is as following:

clustimage overcomes the following challenges:

* 1. Robustly groups similar images.
* 2. Returns the unique images.
* 3. Finds higly similar images for a given input image.

clustimage is fun because:

* It does not require a learning proces.
* It can group any set of images.
* It can return only the unique() images.
* it can find highly similar images given an input image.
* It provided many plots to improve understanding of the feature-space and sample-sample relationships
* It is build on core statistics, such as PCA, HOG and many more, and therefore it does not has a dependency block.
* It works out of the box.

⭐️ Star this repo if you like it ⭐️

Blogs

  • Read the blog to get a structured overview how to cluster images.

Documentation pages

On the documentation pages you can find detailed information about the working of the clustimage with many examples.

Installation

It is advisable to create a new environment (e.g. with Conda).
conda create -n env_clustimage python=3.8
conda activate env_clustimage
Install bnlearn from PyPI
pip install clustimage            # new install
pip install -U clustimage         # update to latest version
Directly install from github source
pip install git+https://github.com/erdogant/clustimage
Import clustimage package
from clustimage import clustimage

Examples

The results obtained from the clustimgage library is a dictionary containing the following keys:

* img       : image vector of the preprocessed images
* feat      : Features extracted for the images
* xycoord   : X and Y coordinates from the embedding
* pathnames : Absolute path location to the image file
* filenames : File names of the image file
* labels    : Cluster labels

Examples Mnist dataset:

Example: Clustering mnist dataset

In this example we will be using a flattened grayscale image array loaded from sklearn. The unique detected clusters are the following:

Click on the underneath scatterplot to zoom-in and see ALL the images in the scatterplot

Example: Plot the explained variance

Example: Plot the unique images

Example: Plot the dendrogram


Examples Flower dataset:

Example: cluster the flower dataset

Example: Make scatterplot with clusterlabels

Example: Plot the unique images per cluster

Example: Plot the images in a particular cluster

Example: Make prediction for unseen input image


Example: Clustering of faces on images


Example: Break up the steps


Example: Extract images belonging to clusters


Support

This project needs some love! ❤️ You can help in various ways.

* Become a Sponsor!
* Star this repo at the github page.
* Other contributions can be in the form of feature requests, idea discussions, reporting bugs, opening pull requests.
* Read more why becoming an sponsor is important on the Sponsor Github Page.

Cheers Mate.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clustimage-1.4.3.tar.gz (32.7 kB view details)

Uploaded Source

Built Distribution

clustimage-1.4.3-py3-none-any.whl (32.0 kB view details)

Uploaded Python 3

File details

Details for the file clustimage-1.4.3.tar.gz.

File metadata

  • Download URL: clustimage-1.4.3.tar.gz
  • Upload date:
  • Size: 32.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/1.5.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for clustimage-1.4.3.tar.gz
Algorithm Hash digest
SHA256 dc3de4c6e7007810b06d73e887ba6c8aa1e696b1d7dfa4a11074bf713f7ec6a3
MD5 5468e2b6cdaa700b8d532be28293b6bd
BLAKE2b-256 e9440a842e0a0ecaab3ce095b69097770fa5b8585884f4d6e31ceb3ddf664b72

See more details on using hashes here.

File details

Details for the file clustimage-1.4.3-py3-none-any.whl.

File metadata

  • Download URL: clustimage-1.4.3-py3-none-any.whl
  • Upload date:
  • Size: 32.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/1.5.0 colorama/0.4.4 CPython/3.8.12

File hashes

Hashes for clustimage-1.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8b7902574d0c3a31589ac709b1278ae63283a305c60ffaac6c2799b0d06e9f58
MD5 0a5b3f66bb25b7ea998585c42189ba39
BLAKE2b-256 d291295e18954cbeb806924d763f0dff4c166fbc3a219529b7eaa0f48ef60f78

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page