Updated readme

README.md

@@ -6,13 +6,28 @@ pip install -r requirements.txt
 ````
 Rename .env_demo to .env and fill in the required fields.
 
-## Required data
+## Setting up the database
+
+### Required data
 The data required to run the code is not included in this repository. 
 The data can be downloaded from the [Soccernet](https://www.soccer-net.org/data).
 Files needed are:
-* Labels-v2.json
+* Labels-v2.json [link](https://www.soccer-net.org/data#h.5klq86rmgt96)
 * Labels-captions.json
 
+The data should be placed in the ./data/Dataset/SoccerNet/ directory
+For each league, create a new folder with the name of the leauge
+For each season create a new folder with the name of the season (YYYY-YYYY)
+For each game create a new folder with the name of the game (YYYY-MM-DD - HomeTeam Score - Score AwayTeam)
+In each game folder, place the Labels-v2.json and Labels-captions.json files
+
+### Setting up and populating the database
+To set up the database, execute the following command:
+````bash
+python src/database.py
+````
+Adjust the path to the data in the database.py file as needed.
+
 ## Running the code
 To run the code, execute the following command:
 ````bash
@@ -20,6 +35,14 @@ python main.py
 ````
 The code will prompt you to enter a natural language query.
 
+````angular2html
+Enter a query: How many goals has Messi scored each season?
+Lionel Messi has scored the following number of goals each season:
+- 2014-2015: 13 goals
+- 2015-2016: 3 goals
+- 2016-2017: 31 goals
+````
+
 ## Results
 ..
 

requirements.txt

@@ -1,11 +1,13 @@
-openai
-langchainhub
+openai==1.10.0
+langchainhub==0.1.14
 langchain == 0.1.4
-langchain_openai
-langchain_experimental
-sqlalchemy
-python-dotenv
-chromadb
-python-Levenshtein
-rapidfuzz
-thefuzz
+langchain-experimental==0.0.49
+langchain-openai==0.0.5
+SQLAlchemy==2.0.29
+python-dotenv==1.0.1
+python-Levenshtein==0.25.0
+rapidfuzz==3.6.1
+thefuzz==0.22.1
+faiss-cpu==1.7.4
+Levenshtein==0.25.0
+langsmith==0.1.29

src/{database/database.py → database.py}

@@ -438,8 +438,8 @@ def fill_Augmented_League(file_path):
 
 if __name__ == "__main__":
     # Example directory path
-    process_json_files('../../data/Dataset/SN-ASR_captions_and_actions/')
-    fill_Augmented_Team('../../data/Dataset/augmented.csv')
-    fill_Augmented_League('../../data/Dataset/augmented_leauges.csv')
+    process_json_files('../data/Dataset/SoccerNet/')
+    fill_Augmented_Team('../data/Dataset/augmented.csv')
+    fill_Augmented_League('../data/Dataset/augmented_leauges.csv')
 # Rename the event/annotation table to something more descriptive. Events are fucking everything else over