# simonbing/crlsanitycheck architecture

> Architecture diagram of the GitHub repository simonbing/crlsanitycheck, 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/simonbing/crlsanitycheck
- Repository: https://github.com/simonbing/crlsanitycheck

## Overview

This repository is an experimental benchmark for sanity-checking causal representation learning on Causal Chamber real data and synthetic or semi-synthetic data. The principal workflow is to select an experiment and dataset, prepare train/validation/test data, fit a method, and evaluate or save results. The graph preserves the documented Contrastive CRL, Multiview CRL, CITRIS, and supervised-fit entry points, plus the shared data/model layer and the Contrastive CRL implementation. Some experiment internals are unsampled, so only documented or indexed relationships are shown.

Main entry points: [`crc/contrastive_crl_experiment.py`](https://github.com/simonbing/crlsanitycheck/blob/master/crc/contrastive_crl_experiment.py) (Contrastive experiment), [`crc/baselines/contrastive_crl/src/run_experiments.py`](https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/run_experiments.py) (Baseline runner), [`crc/multiview_experiment.py`](https://github.com/simonbing/crlsanitycheck/blob/master/crc/multiview_experiment.py) (Multiview experiment), [`crc/baselines/contrastive_crl/src/data_generation.py`](https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/data_generation.py) (Contrastive data)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_experiments["Experiment entry points"]
  node_contrast_experiment["Contrastive experiment"]
  node_multiview_experiment["Multiview experiment"]
  node_citris_experiment["CITRIS experiment"]
  node_supervised_experiment["Supervised fit"]
  node_run_experiments["Baseline runner<br/>[run_experiments.py]"]
end

subgraph group_data["Data and generation"]
  node_dataset_adapters["Chamber datasets<br/>[torch_datasets.py]"]
  node_contrast_data["Contrastive data<br/>[data_generation.py]"]
  node_contrast_utils["Data selection<br/>[utils.py]"]
end

subgraph group_methods["CRL methods"]
  node_model_builders["Contrastive models<br/>[models.py]"]
  node_nonlinearities["Nonlinearities<br/>[nonlinearities.py]"]
  node_training["Model training<br/>[training.py]"]
  node_evaluation["Model evaluation<br/>[evaluation.py]"]
  node_mcc["MCC metrics<br/>[mcc.py]"]
end

subgraph group_shared["Shared runtime"]
  node_shared_arch["Shared architectures<br/>[architectures.py]"]
  node_torch_utils["Torch utilities<br/>[torch_utils.py]"]
  node_utils["Task and split utilities<br/>[utils.py]"]
end

node_engineer(("Experiment runner"))
node_chamber_data[("Causal Chamber data")]

node_engineer -->|"runs"| node_contrast_experiment
node_engineer -->|"runs"| node_multiview_experiment
node_engineer -->|"runs"| node_citris_experiment
node_engineer -.->|"runs"| node_supervised_experiment
node_chamber_data -->|"supplies data"| node_dataset_adapters
node_contrast_experiment -->|"selects data"| node_contrast_utils
node_contrast_experiment -->|"builds model"| node_model_builders
node_contrast_experiment -->|"trains model"| node_training
node_contrast_experiment -->|"evaluates model"| node_evaluation
node_contrast_utils -->|"creates data"| node_contrast_data
node_contrast_utils -->|"loads chamber data"| node_dataset_adapters
node_contrast_data -->|"uses transforms"| node_nonlinearities
node_contrast_data -->|"uses model components"| node_model_builders
node_model_builders -->|"uses nonlinearities"| node_nonlinearities
node_training -->|"evaluates validation"| node_evaluation
node_evaluation -->|"computes MCC"| node_mcc
node_run_experiments -->|"trains model"| node_training
node_run_experiments -->|"evaluates model"| node_evaluation
node_run_experiments -->|"builds model"| node_model_builders
node_run_experiments -->|"generates data"| node_contrast_data
node_multiview_experiment -->|"uses architectures"| node_shared_arch
node_multiview_experiment -.->|"prepares chamber data"| node_dataset_adapters
node_citris_experiment -->|"uses benchmark data"| node_chamber_data
node_supervised_experiment -->|"uses architectures"| node_shared_arch
node_contrast_experiment -->|"selects device"| node_torch_utils
node_multiview_experiment -->|"uses task utilities"| node_utils

click node_contrast_experiment "https://github.com/simonbing/crlsanitycheck/blob/master/crc/contrastive_crl_experiment.py"
click node_multiview_experiment "https://github.com/simonbing/crlsanitycheck/blob/master/crc/multiview_experiment.py"
click node_citris_experiment "https://github.com/simonbing/crlsanitycheck/blob/master/crc/citris_experiment.py"
click node_supervised_experiment "https://github.com/simonbing/crlsanitycheck/blob/master/crc/supervised_fit_experiment.py"
click node_dataset_adapters "https://github.com/simonbing/crlsanitycheck/blob/master/crc/shared/torch_datasets.py"
click node_contrast_data "https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/data_generation.py"
click node_contrast_utils "https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/utils.py"
click node_model_builders "https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/models.py"
click node_nonlinearities "https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/nonlinearities.py"
click node_training "https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/training.py"
click node_evaluation "https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/evaluation.py"
click node_mcc "https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/mcc.py"
click node_run_experiments "https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/run_experiments.py"
click node_shared_arch "https://github.com/simonbing/crlsanitycheck/blob/master/crc/shared/architectures.py"
click node_torch_utils "https://github.com/simonbing/crlsanitycheck/blob/master/crc/utils/torch_utils.py"
click node_utils "https://github.com/simonbing/crlsanitycheck/blob/master/crc/utils/utils.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_contrast_experiment,node_multiview_experiment,node_citris_experiment,node_supervised_experiment,node_run_experiments toneBlue
class node_dataset_adapters,node_contrast_data,node_contrast_utils,node_chamber_data toneAmber
class node_model_builders,node_nonlinearities,node_training,node_evaluation,node_mcc toneMint
class node_shared_arch,node_torch_utils,node_utils toneRose
class node_engineer toneIndigo
```

## Components

### Experiment entry points

- [Contrastive experiment](https://github.com/simonbing/crlsanitycheck/blob/master/crc/contrastive_crl_experiment.py): `crc/contrastive_crl_experiment.py`
- [Multiview experiment](https://github.com/simonbing/crlsanitycheck/blob/master/crc/multiview_experiment.py): `crc/multiview_experiment.py`
- [CITRIS experiment](https://github.com/simonbing/crlsanitycheck/blob/master/crc/citris_experiment.py): `crc/citris_experiment.py`
- [Supervised fit](https://github.com/simonbing/crlsanitycheck/blob/master/crc/supervised_fit_experiment.py): `crc/supervised_fit_experiment.py`
- [Baseline runner](https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/run_experiments.py): `crc/baselines/contrastive_crl/src/run_experiments.py`

### Data and generation

- [Chamber datasets](https://github.com/simonbing/crlsanitycheck/blob/master/crc/shared/torch_datasets.py): `crc/shared/torch_datasets.py`
- [Contrastive data](https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/data_generation.py): `crc/baselines/contrastive_crl/src/data_generation.py`
- [Data selection](https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/utils.py): `crc/baselines/contrastive_crl/src/utils.py`

### CRL methods

- [Contrastive models](https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/models.py): `crc/baselines/contrastive_crl/src/models.py`
- [Nonlinearities](https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/nonlinearities.py): `crc/baselines/contrastive_crl/src/nonlinearities.py`
- [Model training](https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/training.py): `crc/baselines/contrastive_crl/src/training.py`
- [Model evaluation](https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/evaluation.py): `crc/baselines/contrastive_crl/src/evaluation.py`
- [MCC metrics](https://github.com/simonbing/crlsanitycheck/blob/master/crc/baselines/contrastive_crl/src/mcc.py): `crc/baselines/contrastive_crl/src/mcc.py`

### Shared runtime

- [Shared architectures](https://github.com/simonbing/crlsanitycheck/blob/master/crc/shared/architectures.py): `crc/shared/architectures.py`
- [Torch utilities](https://github.com/simonbing/crlsanitycheck/blob/master/crc/utils/torch_utils.py): `crc/utils/torch_utils.py`
- [Task and split utilities](https://github.com/simonbing/crlsanitycheck/blob/master/crc/utils/utils.py): `crc/utils/utils.py`

### Other components

- **Experiment runner**
- **Causal Chamber data**

## Connections

- Experiment runner → Contrastive experiment: runs (evidence: `README.md`)
- Experiment runner → Multiview experiment: runs (evidence: `README.md`)
- Experiment runner → CITRIS experiment: runs (evidence: `README.md`)
- Experiment runner → Supervised fit: runs
- Causal Chamber data → Chamber datasets: supplies data (evidence: `crc/shared/torch_datasets.py`)
- Contrastive experiment → Data selection: selects data (evidence: `crc/contrastive_crl_experiment.py`)
- Contrastive experiment → Contrastive models: builds model (evidence: `crc/contrastive_crl_experiment.py`)
- Contrastive experiment → Model training: trains model (evidence: `crc/contrastive_crl_experiment.py`)
- Contrastive experiment → Model evaluation: evaluates model (evidence: `crc/contrastive_crl_experiment.py`)
- Data selection → Contrastive data: creates data (evidence: `crc/baselines/contrastive_crl/src/utils.py`)
- Data selection → Chamber datasets: loads chamber data (evidence: `crc/baselines/contrastive_crl/src/utils.py`)
- Contrastive data → Nonlinearities: uses transforms (evidence: `crc/baselines/contrastive_crl/src/data_generation.py`)
- Contrastive data → Contrastive models: uses model components (evidence: `crc/baselines/contrastive_crl/src/data_generation.py`)
- Contrastive models → Nonlinearities: uses nonlinearities (evidence: `crc/baselines/contrastive_crl/src/models.py`)
- Model training → Model evaluation: evaluates validation (evidence: `crc/baselines/contrastive_crl/src/training.py`)
- Model evaluation → MCC metrics: computes MCC (evidence: `crc/baselines/contrastive_crl/src/evaluation.py`)
- Baseline runner → Model training: trains model (evidence: `crc/baselines/contrastive_crl/src/run_experiments.py`)
- Baseline runner → Model evaluation: evaluates model (evidence: `crc/baselines/contrastive_crl/src/run_experiments.py`)
- Baseline runner → Contrastive models: builds model (evidence: `crc/baselines/contrastive_crl/src/run_experiments.py`)
- Baseline runner → Contrastive data: generates data (evidence: `crc/baselines/contrastive_crl/src/run_experiments.py`)
- Multiview experiment → Shared architectures: uses architectures (evidence: `crc/multiview_experiment.py`)
- Multiview experiment → Chamber datasets: prepares chamber data
- CITRIS experiment → Causal Chamber data: uses benchmark data (evidence: `README.md`)
- Supervised fit → Shared architectures: uses architectures (evidence: `crc/supervised_fit_experiment.py`)
- Contrastive experiment → Torch utilities: selects device (evidence: `crc/contrastive_crl_experiment.py`)
- Multiview experiment → Task and split utilities: uses task utilities (evidence: `crc/multiview_experiment.py`)
