# anantshri1/ml-qec architecture

> Architecture diagram of the GitHub repository anantshri1/ml-qec, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/anantshri1/ml-qec
- Repository: https://github.com/anantshri1/ml-qec

## Overview

This is a small Python toolkit for quantum error-correction experiments, described as targeting an ML-assisted surface-code pre-decoder. The sampled runtime currently provides binary-symplectic stabilizer utilities and centralized experiment/data path helpers; it does not show a GNN, training, simulation, or benchmark implementation. The two modules appear independent. The caller relationship is shown as unverified because no client is present in the tree.

Main entry points: [`src/qec/paths.py`](https://github.com/anantshri1/ml-qec/blob/main/src/qec/paths.py) (Path helpers), [`src/qec/stabilisers.py`](https://github.com/anantshri1/ml-qec/blob/main/src/qec/stabilisers.py) (Stabilizer math)

## Diagram (Mermaid)

```mermaid
flowchart TD

node_engineer(("Python caller"))
node_stabiliser_math["Stabilizer math<br/>[stabilisers.py]"]
node_path_helpers["Path helpers<br/>[paths.py]"]
node_filesystem["Project and data filesystem"]

node_engineer -.->|"uses API"| node_stabiliser_math
node_engineer -.->|"uses API"| node_path_helpers
node_path_helpers -->|"resolves paths"| node_filesystem
node_path_helpers -->|"creates directories"| node_filesystem

click node_stabiliser_math "https://github.com/anantshri1/ml-qec/blob/main/src/qec/stabilisers.py"
click node_path_helpers "https://github.com/anantshri1/ml-qec/blob/main/src/qec/paths.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_engineer,node_filesystem toneIndigo
class node_stabiliser_math,node_path_helpers toneTeal
```

## Components

### Other components

- **Python caller**
- [Stabilizer math](https://github.com/anantshri1/ml-qec/blob/main/src/qec/stabilisers.py): `src/qec/stabilisers.py`
- [Path helpers](https://github.com/anantshri1/ml-qec/blob/main/src/qec/paths.py): `src/qec/paths.py`
- **Project and data filesystem**

## Connections

- Python caller → Stabilizer math: uses API
- Python caller → Path helpers: uses API
- Path helpers → Project and data filesystem: resolves paths (evidence: `src/qec/paths.py`)
- Path helpers → Project and data filesystem: creates directories (evidence: `src/qec/paths.py`)
