# vivienneforreal/fuzzsim architecture

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

- Interactive diagram: https://gitdiagram.com/vivienneforreal/fuzzsim
- Repository: https://github.com/vivienneforreal/fuzzsim

## Overview

##### Project type and purpose
- From the file tree, this is a Python-based computational library/tool (not a web app or service) that provides “fuzz” functionality—data loading, optimization, evaluation, and a suite of core algorithms (capacity, Choquet, k-NN, norms, similarity).
- The presence of Jupyter notebooks (demo.ipynb, demo 2.ipynb) indicates it’s intended for interactive experimentation or demonstration of the library’s features.

##### File structure
- Top-level files:
- requirements.txt – external dependencies
- scripts/setup_env.sh – environment setup
- archive/ – legacy code and logs
- demo notebooks – usage examples
- Main package: fuzz/
- fuzz/dataloader.py – data ingestion
- fuzz/optim.py – optimization routines (e.g., parameter search)
- fuzz/eval.py – evaluation metrics
- fuzz/src/ – core algorithm implementations (capacity.py, choquet.py, knn.py, norm.py, sim.py)
- fuzz/utils.py – shared utilities
- The structure follows a modular library pattern: data → algorithms → optimization → evaluation, with clear separation of concerns.

##### (empty) README
- No additional architecture details provided, so we infer patterns from code organization.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Demo Layer
    subgraph "Demo Layer"
        direction TB
        Demo1["demo.ipynb"]:::external
        Demo2["demo 2.ipynb"]:::external
    end

    %% Env Setup
    subgraph "Environment Setup"
        direction TB
        EnvReq["requirements.txt"]:::external
        EnvScript["scripts/setup_env.sh"]:::external
    end

    %% Core Library
    subgraph "Core Library" 
        direction TB
        DataLoader["dataloader.py"]:::core
        subgraph "Core Algorithms"
            direction TB
            capacity["capacity.py"]:::core
            choquet["choquet.py"]:::core
            knn["knn.py"]:::core
            norm["norm.py"]:::core
            sim["sim.py"]:::core
        end
        Optimizer["optim.py"]:::core
        Evaluator["eval.py"]:::core
        Utils["utils.py"]:::core
    end

    %% Archive
    Archive["archive/"]:::archive

    %% Connections
    EnvReq -->|bootstrap| Demo1
    EnvScript -->|bootstrap| Demo1
    EnvReq -->|bootstrap| Demo2
    EnvScript -->|bootstrap| Demo2
    Demo1 -->|loads data| DataLoader
    Demo2 -->|loads data| DataLoader
    DataLoader -->|feeds data| capacity
    DataLoader -->|feeds data| choquet
    DataLoader -->|feeds data| knn
    DataLoader -->|feeds data| norm
    DataLoader -->|feeds data| sim
    capacity -->|results| Optimizer
    choquet -->|results| Optimizer
    knn -->|results| Optimizer
    norm -->|results| Optimizer
    sim -->|results| Optimizer
    Optimizer -->|tuned params| Evaluator
    Evaluator -->|metrics| Demo1
    Evaluator -->|metrics| Demo2
    Utils --> capacity
    Utils --> choquet
    Utils --> knn
    Utils --> norm
    Utils --> sim
    Utils --> Optimizer
    Utils --> Evaluator

    %% Click Events
    click Demo1 "https://github.com/vivienneforreal/fuzzsim/blob/master/demo.ipynb"
    click Demo2 "https://github.com/vivienneforreal/fuzzsim/blob/master/demo 2.ipynb"
    click EnvReq "https://github.com/vivienneforreal/fuzzsim/blob/master/requirements.txt"
    click EnvScript "https://github.com/vivienneforreal/fuzzsim/blob/master/scripts/setup_env.sh"
    click DataLoader "https://github.com/vivienneforreal/fuzzsim/blob/master/fuzz/dataloader.py"
    click capacity "https://github.com/vivienneforreal/fuzzsim/blob/master/fuzz/src/capacity.py"
    click choquet "https://github.com/vivienneforreal/fuzzsim/blob/master/fuzz/src/choquet.py"
    click knn "https://github.com/vivienneforreal/fuzzsim/blob/master/fuzz/src/knn.py"
    click norm "https://github.com/vivienneforreal/fuzzsim/blob/master/fuzz/src/norm.py"
    click sim "https://github.com/vivienneforreal/fuzzsim/blob/master/fuzz/src/sim.py"
    click Optimizer "https://github.com/vivienneforreal/fuzzsim/blob/master/fuzz/optim.py"
    click Evaluator "https://github.com/vivienneforreal/fuzzsim/blob/master/fuzz/eval.py"
    click Utils "https://github.com/vivienneforreal/fuzzsim/blob/master/fuzz/utils.py"
    click Archive "https://github.com/vivienneforreal/fuzzsim/tree/master/archive/"

    %% Styles
    classDef core fill:#ADD8E6,stroke:#333,stroke-width:1px;
    classDef external fill:#90EE90,stroke:#333,stroke-width:1px;
    classDef archive fill:#D3D3D3,stroke:#333,stroke-width:1px;
```
