Updated README to include project outline structure.

README.md

@@ -14,6 +14,37 @@ license: cc-by-sa-4.0
 
 This project is a demonstration playground for the LLM-enabled architectures built as a submission for the Online MSc in Artificial Intelligence through the University of Bath.  The purpose of the project is to explore "LLM-enabled architectures" where an LLM is used in conjunction with some store of private data.  The goal is to provide decision support information to technical managers on the _how_ of using LLMs with their organisational data.  Specifically by comparing technical architectures and assessing the organisational implications of the technical choices.
 
+# File Structure
+
+```
+llm-arch
+├── config
+│   ├── architectures.json (configuration for the architectures under test and displayed in the UI)
+├── data
+│   ├── fine_tuning (data and scripts related to fine-tuning LLMs)
+│   ├── json (raw json files containing the synthetic private data built for the project)
+│   ├── sqlite
+│   │   ├── 01_all_products_dataset.db (sqlite db containing all products generated)
+│   │   ├── 02_baseline_dataset.db (sqlite db containing the subset of data selected to be the baseline)
+│   │   ├── test_records.db (sqlite database containing the peristed test results)
+│   ├── vector_stores
+├── img
+├── pages
+├── src
+│   ├── data_synthesis
+│   ├── training
+│   ├── architectures.py (the core architecture pipeline code including components, and trace)
+│   ├── common.py (utilities for common functions, e.g. security token access, data type manipulations)
+│   ├── datatypes.py (object oriented representation of the test data and single point for runtime access of the product DB)
+│   ├── st_helpers.py (helpers specific to streamlit)
+│   ├── testing.py (functionality relating to running, recording and reporting on batches of tests)
+├── Home.py (main entry point for streamlit - first page in the streamlit app)
+├── local_env.yml (conda environment for running project locally)
+├── README.md (readme - this file)
+├── requirements.txt (requirements file for additional requirements in the HF spaces environment - do not use for local running of the project)
+```
+
+
 # Demonstration environment
 
 The project is available as a demonstration running [here on Hugging Face Spaces](https://huggingface.co/spaces/alfraser/llm-arch).  This should be the preferred method to interact with the project.