Skip to main content

A Python package for deduplicating data.

Project description

deduplicate_lib

deduplication algorithms in python


GitHub codecov PyPI version Python 3.9+ License: MIT CI Code style: ruff

Key Features

  • Easy to use deduplication algorithms for any vector array
  • Suite of tolerance tuning algorithms to help you find the right tolerance value for your system
  • Suite of benchmarking tools to ensure rigor, accuracy, and speed (not yet implemented)
  • Factory Plugin architecture, for easy extensibility and modification

Implemented Algorithms

  • Distance Matrix (Simple, accurate, expensive): Computes the distance matrix for all vectors and determines duplicates by finding those that fall below a given distance
  • Multi Hashing (Fast): Smears and rounds the vectors using a normal distribution and computes the hashes for each which are then used to determine duplicates by proportion of hash clashes.

Quick Start

install using pip

pip install deduplicate_lib

load your data into python

from deduplicate_lib.plugins.deduplication_algorithms.multi_hash import MultiHash

# define your paramerters in the MultiHash object
dda=MultiHash(
      tolerance=0.01,
      dataset_array: your_data_array,
      perturbations: int = 200, 
    )

print(dda.get_dataset_unique_structures())

A more detailed example can be seen in the examples directory

Dependencies

  • Python 3.9+
  • numpy
  • numba

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

# Clone the repository
git clone https://github.com/julianholland/deduplicate.git
cd deduplicate

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

# Run linting
ruff check .
ruff format .

Running Tests

# Run all tests
pytest

# Run specific test categories
pytest tests/core/
pytest tests/plugins/
pytest tests/plugins/duplicate_detection_algorithms/distance_matrix

# Run with coverage
pytest --cov

📝 Citation

If you use deduplicate_lib in your research, please cite:

@software{alomancy2025,
  title={Deduplicate_lib: Auto Tolerance Finding Deduplication Algorithms in Python},
  author={Julian Holland},
  year={2026},
  url={https://github.com/julianholland/deduplicate},
  version={0.0.1dev}
}

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • The Fritz Haber Institute
  • Juan Manuel Lombardi <3

Project Links

Project To-Do

  • Add example.ipynb
  • Create general Pre-allocation protocal
  • Add benchmarks for time and robustness
  • Add Locality-Sensitive Hashing as an option
  • Speedup slow tasks with Numba
  • Set up Read the Docs
  • Create general deduplicate function

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

deduplicate_lib-0.0.2.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

deduplicate_lib-0.0.2-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file deduplicate_lib-0.0.2.tar.gz.

File metadata

  • Download URL: deduplicate_lib-0.0.2.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for deduplicate_lib-0.0.2.tar.gz
Algorithm Hash digest
SHA256 d5c61bd544b084b952622beb86cbe2fdaa9293e267c580ae6e0c2f98cf4616c8
MD5 562d9007deaad5fe0a438c63e5841148
BLAKE2b-256 adcfd1347b3b13862f73751e408dd65fdc653d107431738d6320d4e7cf6a06ea

See more details on using hashes here.

File details

Details for the file deduplicate_lib-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for deduplicate_lib-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0ca26a1cc0393261868ec4a74e3618586c1c696661d7d0d8a39064eb4e830366
MD5 00cea181d6229b85965525e91de9ff5a
BLAKE2b-256 0e2210c9c1e44c2ba83369c58caef02e60cf94c5a10409b34c10f29a1a06334b

See more details on using hashes here.

Supported by

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