Merge remote-tracking branch 'origin/main'

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
+
+<pre>
+llm-arch
+├── config
+│   ├── architectures.json <i>(configuration for the architectures under test and displayed in the UI)</i>
+├── data
+│   ├── fine_tuning <i>(data and scripts related to fine-tuning LLMs)</i>
+│   ├── json <i>(raw json files containing the synthetic private data built for the project)</i>
+│   ├── sqlite
+│   │   ├── 01_all_products_dataset.db <i>(sqlite db containing all products generated)</i>
+│   │   ├── 02_baseline_dataset.db <i>(sqlite db containing the subset of data selected to be the baseline)</i>
+│   │   ├── test_records.db <i>(sqlite database containing the peristed test results)</i>
+│   ├── vector_stores <i>(chromadb files containing the document embeddings for the RAG architectures)</i>
+├── img
+├── pages
+├── src
+│   ├── data_synthesis <i>(python code related to generating, selecting and loading the private dataset used for the project)</i>
+│   ├── training <i>(python code related to training the architectures - not used at runtime)</i>
+│   ├── architectures.py <i>(the core architecture pipeline code including components, and trace)</i>
+│   ├── common.py <i>(utilities for common functions, e.g. security token access, data type manipulations)</i>
+│   ├── datatypes.py <i>(object oriented representation of the test data and single point for runtime access of the product DB)</i>
+│   ├── st_helpers.py <i>(helpers specific to streamlit)</i>
+│   ├── testing.py <i>(functionality relating to running, recording and reporting on batches of tests)</i>
+├── Home.py <i>(main entry point for streamlit - first page in the streamlit app)</i>
+├── local_env.yml <i>(conda environment for running project locally)</i>
+├── README.md <i>(readme - this file)</i>
+├── requirements.txt <i>(requirements file for additional requirements in the HF spaces environment - do not use for local running of the project)</i>
+</pre>
+
+
 # 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.