From 88c8aa5855e19a21bf15c52e625015df33aec575 Mon Sep 17 00:00:00 2001
From: ShrihanSolo <shrihan.agarwal@gmail.com>
Date: Tue, 3 Sep 2024 19:03:22 +0000
Subject: [PATCH] readme v8

---
 README.md | 48 +++++++++++++++++++++++++++++-------------------
 1 file changed, 29 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 95c9421..befa7e1 100644
--- a/README.md
+++ b/README.md
@@ -43,39 +43,49 @@ The `training_env.yml` is required for training the Pytorch model, and `deeplens
 
 
 ### Repository Structure
+
+The repository structure is below. 
+
 ```
 AdaptiveMVEforLensModeling/
 │
 ├── src/
 │   ├── sim/
-│   │   └── # Contains all information required to generate the dataset
+│   │   ├── configs/
+│   │   │   └── deeplenstronomy config files to generate the data
+│   │   │
+│   │   └── notebooks/
+│   │       └── gen_sim.ipynb: used to generate the data in data/.
+│   │   
 │   │
 │   ├── data/
-│   │   └── # Data should be stored here after download or generation
+│   │   └── Data should be stored here after download or generation.
 │   │
 │   └── training/
 │       ├── MVEonly/
 │       │   ├── paper_models/
-│       │   │   └── # Final PyTorch models used in the MVEonly model, along with training information
-│       │   │
-│       │   └── # Notebooks and code specific to the MVEonly model
-│       │
-│       ├── MVEUDA/
-│       │   ├── paper_models/
-│       │   │   └── # Final PyTorch models used in the MVEUDA model, along with training information
-│       │   │
-│       │   ├── figures/
-│       │   │   └── # Figures generated for the paper
+│       │   │   └── Final PyTorch models in the MVEonly model + training information.
 │       │   │
-│       │   └── ModelVizPaper.ipynb
-│       │       └── # Notebook used to generate figures in MVEUDA/figures/ and used in the paper
+│       │   └── RunA.ipynb
+│       │       └── Notebook(s) with different seeds required to run the MVEonly model.
 │       │
-│       └── # Other notebooks and resources related to training
+│       └── MVEUDA/
+│           ├── paper_models/
+│           │   └── Final PyTorch models in the MVEonly model + training information.
+│           │
+│           ├── figures/
+│           │   └── All figures in the paper are drawn from here.
+│           | 
+│           ├── RunA.ipynb
+│           │   └── Notebook(s) with different seeds required to run the MVE-UDA model.
+│           │
+│           └── ModelVizPaper.ipynb
+│               └── Notebook used to generate figures in figures/ from data in paper_models/
 │
-├── envs/
-│   └── # Environment specific files
-│
-└── # Additional files and directories as needed
+└── envs/
+    └── Conda environment specification files
+
+[ASCII formatting generated using ChatGPT]
 ```
 
 ### Quickstart