Skip to main content

Open-source Python library for pattern mining

Project description

pypatternminer

pypatternminer is an open-source Python library for pattern mining. It provides a broad, research-oriented, and reproducible framework for major pattern-mining families, including:

  • Itemset mining
  • High-utility itemset mining
  • High-utility sequential pattern mining
  • Sequential pattern mining

The project is developed with two main goals:

  1. to provide a comprehensive Python framework covering many influential pattern-mining algorithms in a unified environment;
  2. to provide publicly available code and testing datasets to support transparent and reproducible research.

Why pypatternminer?

Pattern mining has produced a large number of important algorithms over the past three decades, but the Python ecosystem remains relatively fragmented. pypatternminer aims to help bridge this gap by offering:

  • a unified Python environment for multiple pattern-mining families;
  • broad algorithmic coverage;
  • validation against SPMF reference implementations;
  • public access to source code and testing datasets;
  • a foundation for teaching, benchmarking, and future research.

Current Coverage

At the current stage, pypatternminer includes 144 implemented entries:

Category Implemented
Itemset mining 42
High-utility itemset mining 70
High-utility sequential pattern mining 3
Sequential pattern mining 29
Total 144

Planned future extensions include:

  • association rule mining
  • sequential rule mining
  • sequence prediction
  • periodic pattern mining
  • episode mining

Validation

A key design principle of pypatternminer is implementation reliability.

Each Python implementation is validated against the corresponding Java implementation in SPMF using:

  • the same input datasets,
  • the same parameter settings,
  • and the same experimental conditions.

The returned pattern sets and associated values, such as support or utility, are compared to ensure matching outputs.

Installation

Install from source

Clone the repository and install the required dependencies:

git clone https://github.com/taiduydinh/pypatternminer.git
cd pypatternminer
pip install -r requirements.txt

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

pypatternminer-0.1.1.tar.gz (309.0 kB view details)

Uploaded Source

Built Distribution

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

pypatternminer-0.1.1-py3-none-any.whl (398.0 kB view details)

Uploaded Python 3

File details

Details for the file pypatternminer-0.1.1.tar.gz.

File metadata

  • Download URL: pypatternminer-0.1.1.tar.gz
  • Upload date:
  • Size: 309.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pypatternminer-0.1.1.tar.gz
Algorithm Hash digest
SHA256 fbc4500e6790959407044cfc81ffbc53ae1bb220febbd38d72dcc223b1430e8f
MD5 de588d1f821502300aa9158961d807c0
BLAKE2b-256 d328b43cf1316059963677efa949950ebae121f0bc0b3be19020194ef595b284

See more details on using hashes here.

Provenance

The following attestation bundles were made for pypatternminer-0.1.1.tar.gz:

Publisher: publish.yml on taiduydinh/pypatternminer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pypatternminer-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pypatternminer-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 398.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pypatternminer-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 41d4fe768d734e927c2f2f28fdd46786dfadae65dc9652c8eef79661dcebd9fa
MD5 4cecbc20d74c6d4ce0bac18ae75acd64
BLAKE2b-256 51ceb81d6962d8cb06de48838bc155bd7a2fab2fcd98dcadd1454536011bec81

See more details on using hashes here.

Provenance

The following attestation bundles were made for pypatternminer-0.1.1-py3-none-any.whl:

Publisher: publish.yml on taiduydinh/pypatternminer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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