Perception provides flexible, well-documented, and comprehensively tested tooling for perceptual hashing research, development, and production use.
Project description
perception 
perception provides flexible, well-documented, and comprehensively tested tooling for perceptual hashing research, development, and production use. See the documentation for details.
Background
perception was initially developed at Thorn as part of our work to eliminate child sexual abuse material from the internet. For more information on the issue, check out our CEO's TED talk.
Getting Started
Installation
pip install opencv-python perception
Hashing
Hashing with different functions is simple with perception.
from perception import hashers
file1, file2 = 'test1.jpg', 'test2.jpg'
hasher = hashers.PHash()
hash1, hash2 = hasher.compute(file1), hasher.compute(file2)
distance = hasher.compute_distance(hash1, hash2)
Examples
See below for end-to-end examples for common use cases for perceptual hashes.
Supported Hashing Algorithms
perception currently ships with:
- pHash (DCT hash) (
perception.hashers.PHash) - Facebook's PDQ Hash (
perception.hashers.PDQ) - dHash (difference hash) (
perception.hashers.DHash) - aHash (average hash) (
perception.hashers.AverageHash) - Marr-Hildreth (
perception.hashers.MarrHildreth) - Color Moment (
perception.hashers.ColorMoment) - Block Mean (
perception.hashers.BlockMean) - wHash (wavelet hash) (
perception.hashers.WaveletHash)
Contributing
To work on the project, start by doing the following.
# Install local dependencies for
# code completion, etc.
make init
# Build the Docker container to run
# tests and such.
make build
- Running
make initwill update this repository's dependencies and preserve the results inPipfile.lock. We strongly recommend including changes to the lock alongside any other changes that may have been made. - You can get a JupyterLab server running to experiment with using
make lab-server. - To do a (close to) comprehensive check before committing code, you can use
make precommit. - To view the documentation, use
make documentation-server.
To implement new features, please first file an issue proposing your change for discussion.
To report problems, please file an issue with sample code, expected results, actual results, and a complete traceback.
Alternatives
There are other packages worth checking out to see if they meet your needs for perceptual hashing. Here are some examples.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
File details
Details for the file perception-0.7.2a5-cp310-cp310-manylinux_2_28_x86_64.whl.
File metadata
- Download URL: perception-0.7.2a5-cp310-cp310-manylinux_2_28_x86_64.whl
- Upload date:
- Size: 2.5 MB
- Tags: CPython 3.10, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4b4bdb264c090abd0a224b4310603a416c677c4fa05a2c9833ea657539c9e48c |
|
| MD5 | 4f86074ac1cc123ab98d0eb0af4aeb2f |
|
| BLAKE2b-256 | 7743e424f42461555a932401441f7771ba7cf2168f662cfda060cb724883526a |
File details
Details for the file perception-0.7.2a5-cp39-cp39-manylinux_2_28_x86_64.whl.
File metadata
- Download URL: perception-0.7.2a5-cp39-cp39-manylinux_2_28_x86_64.whl
- Upload date:
- Size: 2.5 MB
- Tags: CPython 3.9, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7bab7dc74b8249cde33e471dc05c3a3fbacb36b3e9b6951a582d94a1619ee1b8 |
|
| MD5 | 6b5c1fb48ca9fcfc100436eac3ac965f |
|
| BLAKE2b-256 | 2ae6718cc1eb56e40be823143dfe45b6a77821abc0c3c807df73ba427ca37c69 |
