a few small edits to clarify readmes

BU-Spark · Dec 21, 2023 · ebaddb5 · ebaddb5
1 parent 20bfaa1
commit ebaddb5
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # Documentation 
 
+This is the README for the Spring 2023 course project. For Fall 2023, 
+see this [README](./fall23/README.md).
 
 ## Roadmap of Repository Directories
 - [`DeploymentFinalNBs`](https://github.com/BU-Spark/ml-atfal-mafkoda-missing-children/tree/dev/Deployment:FinalNBs) - contains the deployment notebooks for the face aging demo as well as the facial recognition demo

diff --git a/fall23/README.md b/fall23/README.md
@@ -6,6 +6,7 @@ This document provides an overview of the key components in our ML Pipeline. Ple
 
 **JSON Data File**
 - Description : This is a JSON file that contains all relevant Facebook data. It serves as the primary dataset.
+  An example JSON file is in the `inputs_outputs` folder.
 
 **Data Downloader**
 - Function : Downloads all images associated with a specific `CaseId`.
@@ -34,7 +35,7 @@ This notebook automates the downloading and organizing of images based on JSON F
 - **Error Logging**: Missing data from the JSON file is logged into a CSV file for review.
 
 
-## data_explore.ipynb   
+## data_explore.ipynb  
 The `data_explore` directory includes the `data_explore.ipynb` notebook, which specializes in analyzing and visualizing the given Facebook posts data. Key components and outputs of the notebook are outlined below:
 
 ### Data Conversion and Preprocessing

diff --git a/fall23/requirements_fall2023.txt b/fall23/requirements_fall2023.txt
@@ -0,0 +1,7 @@
+requests  
+Pillow  
+tqdm 
+pandas 
+seaborn  
+matplotlib  
+deepface