Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,070 changes: 1,070 additions & 0 deletions AIM_INTEGRATION_PLAN.md

Large diffs are not rendered by default.

520 changes: 520 additions & 0 deletions DVC_IMPLEMENTATION_GUIDE.md

Large diffs are not rendered by default.

703 changes: 703 additions & 0 deletions DVC_MIGRATION_DESIGN.md

Large diffs are not rendered by default.

609 changes: 609 additions & 0 deletions DVC_SETUP.md

Large diffs are not rendered by default.

799 changes: 799 additions & 0 deletions DVC_TROUBLESHOOTING.md

Large diffs are not rendered by default.

37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ python smoke_test_cuda.py # optional sanity check
- For CUDA-specific setup and optimization guide, see [docs/CUDA_SETUP.md](docs/CUDA_SETUP.md).
- For an annotated walkthrough of the harness, see [QUICKSTART.md](QUICKSTART.md).

### Stage‑1A Pilot Utilities

To sanity‑check the new Stage‑1A utilities (Task‑B data, circularity metrics, VDI probe), run:

```bash
Expand All @@ -63,6 +65,41 @@ bash scripts/run_pilot_dry_run.sh

This runs a small, end‑to‑end dry‑run on `gpt2-small` to validate the geometry and structural probes without training the 2‑layer pilot model.

## Data Management with DVC

This project uses [DVC (Data Version Control)](https://dvc.org) to manage datasets, results, and artifacts. DVC keeps large data files out of Git while maintaining full version control and reproducibility.

### First-time Setup

After cloning the repository, pull all tracked data:

```bash
# Install DVC
pip install dvc

# Pull datasets and results
dvc pull
```

This downloads:
- Raw datasets (`lab/data/corpora/`)
- Data splits (`lab/data/splits/`)
- Results and metrics (`reports/`)
- Paper supplements (`paper/supplement/`)

### Why DVC?

- **Version control for data** - Track dataset and result versions alongside code
- **Efficient storage** - Large files stored separately from Git
- **Reproducibility** - Exact data versions tied to code commits
- **Scalability** - Seamlessly migrate to S3/GCS/Azure when needed

### Documentation

- [DVC_SETUP.md](DVC_SETUP.md) - Complete setup and usage guide
- [DVC_MIGRATION_DESIGN.md](DVC_MIGRATION_DESIGN.md) - Architecture and design decisions
- [DVC_TROUBLESHOOTING.md](DVC_TROUBLESHOOTING.md) - Common issues and solutions

## Repository Layout

| Path | Purpose |
Expand Down
Loading