# mic-dkfz/nnssl architecture

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

- Interactive diagram: https://gitdiagram.com/mic-dkfz/nnssl
- Repository: https://github.com/mic-dkfz/nnssl

## Overview

nnssl is a 3D medical-imaging self-supervised pretraining framework, including the nnFoundation CNN and ViT models and the broader OpenMind SSL benchmark. Its documented user workflow prepares a raw collection, fingerprints/plans and preprocesses it, then pretrains a model. The graph also shows the internal training, data-loading and architecture layers, plus conversion and model-sharing capabilities. Edges follow README statements or SOURCE INDEX references; unsampled subsystem details and wiring are not inferred.

Main entry points: [`src/nnssl/training/nnsslTrainer/AbstractTrainer.py`](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/training/nnsslTrainer/AbstractTrainer.py) (Trainer framework), [`src/nnssl/preprocessing/preprocessors/default_preprocessor.py`](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/preprocessing/preprocessors/default_preprocessor.py) (Preprocessing), [`src/nnssl/data/raw_dataset.py`](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/data/raw_dataset.py) (Raw collections), [`src/nnssl/dataset_conversion`](https://github.com/mic-dkfz/nnssl/tree/nnFoundation/src/nnssl/dataset_conversion) (Dataset conversion)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_data["Data preparation"]
  node_raw["Raw collections<br/>[raw_dataset.py]"]
  node_conversion["Dataset conversion"]
  node_dataset[("Blosc2 dataset<br/>[dataset.py]")]
end

subgraph group_planning["Planning and preprocessing"]
  node_fingerprint["Fingerprinting"]
  node_planner["Experiment planning"]
  node_plan["Plans<br/>[plan.py]"]
  node_preprocess["Preprocessing"]
  node_resample["Resampling"]
end

subgraph group_training["Pretraining"]
  node_runner["Training entrypoint"]
  node_trainer["Trainer framework<br/>[AbstractTrainer.py]"]
  node_loader["3D patch loader<br/>[data_loader_3d.py]"]
  node_methods["SSL trainers"]
end

subgraph group_models["Models and adaptation"]
  node_architecture["Architecture selection"]
  node_adaptation["Adaptation plans<br/>[adaptation_plan.py]"]
end

subgraph group_sharing["Model sharing"]
  node_sharing["Model import/export"]
  node_checkpoints["Pretrained checkpoints"]
end

node_user(("Researcher"))

node_user -->|"prepares data"| node_raw
node_user -->|"converts datasets"| node_conversion
node_conversion -->|"creates collection"| node_raw
node_raw -->|"fingerprints"| node_fingerprint
node_fingerprint -.->|"informs plan"| node_planner
node_planner -->|"creates plan"| node_plan
node_plan -->|"configures"| node_preprocess
node_preprocess -->|"resamples data"| node_resample
node_preprocess -->|"saves processed data"| node_dataset
node_user -->|"starts pretraining"| node_runner
node_runner -->|"dispatches"| node_trainer
node_trainer -->|"builds batches"| node_loader
node_loader -->|"reads cases"| node_dataset
node_trainer -->|"builds network"| node_architecture
node_methods -.->|"extends framework"| node_trainer
node_trainer -->|"creates adaptation plan"| node_adaptation
node_user -.->|"imports or exports"| node_sharing
node_sharing -.->|"transfers weights"| node_checkpoints

click node_raw "https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/data/raw_dataset.py"
click node_conversion "https://github.com/mic-dkfz/nnssl/tree/nnFoundation/src/nnssl/dataset_conversion"
click node_dataset "https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/data/dataloading/dataset.py"
click node_fingerprint "https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/experiment_planning/dataset_fingerprint/default_fingerprint_extractor.py"
click node_planner "https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/experiment_planning/experiment_planners/default_experiment_planner.py"
click node_plan "https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/experiment_planning/experiment_planners/plan.py"
click node_preprocess "https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/preprocessing/preprocessors/default_preprocessor.py"
click node_resample "https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/preprocessing/resampling/default_resampling.py"
click node_runner "https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/run/run_training_wandb.py"
click node_trainer "https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/training/nnsslTrainer/AbstractTrainer.py"
click node_loader "https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/ssl_data/dataloading/data_loader_3d.py"
click node_methods "https://github.com/mic-dkfz/nnssl/tree/nnFoundation/src/nnssl/training/nnsslTrainer"
click node_architecture "https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/architectures/get_network_by_name.py"
click node_adaptation "https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/adaptation_planning/adaptation_plan.py"
click node_sharing "https://github.com/mic-dkfz/nnssl/tree/nnFoundation/src/nnssl/model_sharing"

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_raw,node_conversion,node_dataset toneBlue
class node_fingerprint,node_planner,node_plan,node_preprocess,node_resample toneAmber
class node_runner,node_trainer,node_loader,node_methods toneMint
class node_architecture,node_adaptation toneRose
class node_sharing,node_checkpoints,node_user toneIndigo
```

## Components

### Data preparation

- [Raw collections](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/data/raw_dataset.py): `src/nnssl/data/raw_dataset.py`
- [Dataset conversion](https://github.com/mic-dkfz/nnssl/tree/nnFoundation/src/nnssl/dataset_conversion): `src/nnssl/dataset_conversion`
- [Blosc2 dataset](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/data/dataloading/dataset.py): `src/nnssl/data/dataloading/dataset.py`

### Planning and preprocessing

- [Fingerprinting](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/experiment_planning/dataset_fingerprint/default_fingerprint_extractor.py): `src/nnssl/experiment_planning/dataset_fingerprint/default_fingerprint_extractor.py`
- [Experiment planning](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/experiment_planning/experiment_planners/default_experiment_planner.py): `src/nnssl/experiment_planning/experiment_planners/default_experiment_planner.py`
- [Plans](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/experiment_planning/experiment_planners/plan.py): `src/nnssl/experiment_planning/experiment_planners/plan.py`
- [Preprocessing](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/preprocessing/preprocessors/default_preprocessor.py): `src/nnssl/preprocessing/preprocessors/default_preprocessor.py`
- [Resampling](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/preprocessing/resampling/default_resampling.py): `src/nnssl/preprocessing/resampling/default_resampling.py`

### Pretraining

- [Training entrypoint](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/run/run_training_wandb.py): `src/nnssl/run/run_training_wandb.py`
- [Trainer framework](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/training/nnsslTrainer/AbstractTrainer.py): `src/nnssl/training/nnsslTrainer/AbstractTrainer.py`
- [3D patch loader](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/ssl_data/dataloading/data_loader_3d.py): `src/nnssl/ssl_data/dataloading/data_loader_3d.py`
- [SSL trainers](https://github.com/mic-dkfz/nnssl/tree/nnFoundation/src/nnssl/training/nnsslTrainer): `src/nnssl/training/nnsslTrainer`

### Models and adaptation

- [Architecture selection](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/architectures/get_network_by_name.py): `src/nnssl/architectures/get_network_by_name.py`
- [Adaptation plans](https://github.com/mic-dkfz/nnssl/blob/nnFoundation/src/nnssl/adaptation_planning/adaptation_plan.py): `src/nnssl/adaptation_planning/adaptation_plan.py`

### Model sharing

- [Model import/export](https://github.com/mic-dkfz/nnssl/tree/nnFoundation/src/nnssl/model_sharing): `src/nnssl/model_sharing`
- **Pretrained checkpoints**

### Other components

- **Researcher**

## Connections

- Researcher → Raw collections: prepares data
- Researcher → Dataset conversion: converts datasets
- Dataset conversion → Raw collections: creates collection (evidence: `src/nnssl/dataset_conversion/Dataset800_Rocket_v0.py`)
- Raw collections → Fingerprinting: fingerprints
- Fingerprinting → Experiment planning: informs plan
- Experiment planning → Plans: creates plan (evidence: `src/nnssl/experiment_planning/experiment_planners/default_experiment_planner.py`)
- Plans → Preprocessing: configures (evidence: `src/nnssl/preprocessing/preprocessors/default_preprocessor.py`)
- Preprocessing → Resampling: resamples data (evidence: `src/nnssl/preprocessing/preprocessors/default_preprocessor.py`)
- Preprocessing → Blosc2 dataset: saves processed data (evidence: `src/nnssl/preprocessing/preprocessors/default_preprocessor.py`)
- Researcher → Training entrypoint: starts pretraining
- Training entrypoint → Trainer framework: dispatches (evidence: `src/nnssl/run/run_training_wandb.py`)
- Trainer framework → 3D patch loader: builds batches (evidence: `src/nnssl/training/nnsslTrainer/AbstractTrainer.py`)
- 3D patch loader → Blosc2 dataset: reads cases (evidence: `src/nnssl/ssl_data/dataloading/data_loader_3d.py`)
- Trainer framework → Architecture selection: builds network (evidence: `src/nnssl/training/nnsslTrainer/AbstractTrainer.py`)
- SSL trainers → Trainer framework: extends framework (evidence: `src/nnssl/training/nnsslTrainer/masked_image_modeling/BaseMAETrainer.py`)
- Trainer framework → Adaptation plans: creates adaptation plan (evidence: `src/nnssl/training/nnsslTrainer/AbstractTrainer.py`)
- Researcher → Model import/export: imports or exports
- Model import/export → Pretrained checkpoints: transfers weights
