Metadata-Version: 2.4
Name: simikit
Version: 0.0.3
Summary: Image Similarity Toolkit in Python
Project-URL: Homepage, https://github.com/yie1d/simikit
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: loguru>=0.7.3
Requires-Dist: pillow>=11.1.0
Requires-Dist: pywavelets>=1.8.0
Requires-Dist: scikit-learn>=1.6.1
Requires-Dist: tomli>=2.2.1
Requires-Dist: torch>=2.6.0
Requires-Dist: transformers>=4.50.3
Dynamic: license-file

## SimiKit: Image Similarity Toolkit in Python


English | [中文](doc/README_cn.md) 

## Overview

SimiKit is a toolkit for commonly used image similarity algorithms. This project provides various tools to help developers quickly compare the effects of multiple image similarity algorithms, and assist developers in selecting an image similarity algorithm that best meets their needs.

## Installation

> pip instal simikit

## Basic Usage
```python
from simikit.features.hash import AHash

image_path = r'tests/image.png'
print(AHash().encode(image_path))
```

## Supported Algorithms

- HASH
  - Average hashing
  - Difference hashing
  - Perceptual hashing
  - Wavelet hashing
- Transformer
  - VIT
  - DINOv2

## Contribution

Thank you for your interest in `simikit`. Submissions in all aspects are welcome. Let's work together to make `simikit` better!

## Future Plans

- Add more image similarity algorithms

If there is any similarity algorithm that you want but is not currently available in the `simikit`, you are welcome to raise it in the `Issues` section!
