# fatihsen20/frequent-mining-algorithms architecture

> Architecture diagram of the GitHub repository fatihsen20/frequent-mining-algorithms, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/fatihsen20/frequent-mining-algorithms
- Repository: https://github.com/fatihsen20/frequent-mining-algorithms

## Overview

##### Project type and purpose
- This is an open-source Python library (package) named FIMProject providing implementations of frequent itemset mining (FIM) algorithms (Apriori, Eclat, FP-Growth, H-Mine) and association rule generation, with a placeholder FSM (Frequent Sequence Mining) subpackage for future algorithms.
- Its primary purpose is to serve as a drop-in Python dependency for data scientists who need to compute frequent itemsets and association rules on transaction data (pandas DataFrame).

##### File structure
- Top-level files: configuration (`pyproject.toml`, `setup.cfg`, `.flake8`, `LICENSE`), distribution metadata, and an `example` directory with a notebook demonstrating usage.
- `src/FIM`: core algorithms (`apriori.py`, `eclat.py`, `fpgrowth.py`, `hmine.py`), rule-generation (`association_rules.py`), utilities (`utils.py`), plus a `tests` subfolder with unit tests for each algorithm.
- `src/FSM`: stub for future frequent-sequence modules.
- No web front end or external service components—this is purely a library stack.

##### README for additional insights
- Dependencies: Python ≥3.7, pandas (for DataFrame encoding), pip installation.
- Example usage shows data flow: raw transaction lists → `TransactionEncoder` → one-hot DataFrame → algorithm → frequency DataFrame → `association_rules` → rule set DataFrame.
- No mention of internal architectural patterns, but the separation into modules suggests a modular, plug-and-play design.

##### Final recommendation
[Raw Transactions] → [TransactionEncoder] → [FIM Algorithms] → [association_rules] → [Rules Output]
- Surround with the “FIMProject” package boundary, note the FSM stub off to one side
- Every component and flow is explicitly named to give an at-a-glance understanding of how a user’s data traverses the library and how the modules interact.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Data Flow
    DataRaw["Raw Transactions"]:::data
    DataRaw -->|input| TransEnc

    TransEnc["TransactionEncoder"]:::module
    click TransEnc "https://github.com/fatihsen20/frequent-mining-algorithms/blob/main/src/FIM/utils.py"
    TransEnc -->|encoded DF| EncodedDF
    EncodedDF["Encoded DataFrame"]:::data
    EncodedDF -->|input| apriori
    EncodedDF -->|input| eclat
    EncodedDF -->|input| fpgrowth
    EncodedDF -->|input| hmine

    subgraph "FIMProject Package"
        direction TB
        FIMCore[(Core FIM Package)]:::module
        click FIMCore "https://github.com/fatihsen20/frequent-mining-algorithms/tree/main/src/FIM/"
        TransEnc
        apriori["apriori()"]:::module
        click apriori "https://github.com/fatihsen20/frequent-mining-algorithms/blob/main/src/FIM/apriori.py"
        eclat["eclat()"]:::module
        click eclat "https://github.com/fatihsen20/frequent-mining-algorithms/blob/main/src/FIM/eclat.py"
        fpgrowth["fpgrowth()"]:::module
        click fpgrowth "https://github.com/fatihsen20/frequent-mining-algorithms/blob/main/src/FIM/fpgrowth.py"
        hmine["hmine()"]:::module
        click hmine "https://github.com/fatihsen20/frequent-mining-algorithms/blob/main/src/FIM/hmine.py"
        assoc["association_rules()"]:::module
        click assoc "https://github.com/fatihsen20/frequent-mining-algorithms/blob/main/src/FIM/association_rules.py"
    end

    apriori -->|freq items| DataFreq
    eclat -->|freq items| DataFreq
    fpgrowth -->|freq items| DataFreq
    hmine -->|freq items| DataFreq

    DataFreq["Frequent Itemsets DataFrame"]:::data
    DataFreq -->|rules input| assoc

    assoc -->|rules| DataRules
    DataRules["Association Rules DataFrame"]:::data

    %% FSM Stub
    subgraph "FSM Stub Package"  
        direction TB
        FSMStub[(Stub)]:::stub
        click FSMStub "https://github.com/fatihsen20/frequent-mining-algorithms/tree/main/src/FSM/"
    end
    FSMStub -.-> TransEnc

    %% Unit Tests
    subgraph "Unit Tests"  
        direction LR
        Tests[(Tests)]:::test
        click Tests "https://github.com/fatihsen20/frequent-mining-algorithms/tree/main/src/FIM/tests/"
    end
    Tests --> apriori
    Tests --> eclat
    Tests --> fpgrowth
    Tests --> hmine
    Tests --> assoc

    %% Example Usage
    example["apriori.ipynb"]:::example
    click example "https://github.com/fatihsen20/frequent-mining-algorithms/blob/main/example/FIM/apriori.ipynb"
    example --> TransEnc
    example --> apriori

    %% External Dependencies
    ExternalPython["Python Runtime"]:::ext
    ExternalPandas["pandas DataFrame"]:::ext
    ExternalPython --> TransEnc
    ExternalPandas --> TransEnc
    ExternalPandas --> apriori
    ExternalPandas --> eclat
    ExternalPandas --> fpgrowth
    ExternalPandas --> hmine
    ExternalPandas --> assoc

    classDef module fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef data fill:#90EE90,stroke:#333,stroke-width:1px
    classDef ext fill:#FFA500,stroke:#333,stroke-width:1px
    classDef test fill:#FFE4B5,stroke:#333,stroke-width:1px
    classDef example fill:#D8BFD8,stroke:#333,stroke-width:1px
    classDef stub stroke:#000,stroke-dasharray: 5 5,fill:#FFF
```
