From a1aee997f9d21dd317b6c8a88d23416e0d216e4d Mon Sep 17 00:00:00 2001
From: nprimo <primo.niccolo@gmail.com>
Date: Wed, 28 Feb 2024 12:14:47 +0100
Subject: [PATCH] feat(emotion-detector): refine structure of the project

---
 subjects/ai/emotions-detector/README.md       | 66 ++++++++-----------
 subjects/ai/emotions-detector/audit/README.md | 50 ++------------
 2 files changed, 34 insertions(+), 82 deletions(-)

diff --git a/subjects/ai/emotions-detector/README.md b/subjects/ai/emotions-detector/README.md
index 74cdd4038..751ad2d47 100644
--- a/subjects/ai/emotions-detector/README.md
+++ b/subjects/ai/emotions-detector/README.md
@@ -62,48 +62,40 @@ For that step, I suggest again to use **OpenCV** as much as possible. This link
 
 ```
 project
-│   README.md
-│   environment.yml
-│
-└───data
-│   │   train.csv
-│   │   test.csv
-│   │   xxx.csv
-│
-└───results
-│   │
-|   |───model (free format)
-│   │   │   my_own_model.pkl
-│   │   │   my_own_model_architecture.txt
-│   │   │   tensorboard.png
-│   │   │   learning_curves.png
-│   │   │   pre_trained_model.pkl (optional)
-│   │   │   pre_trained_model_architecture.txt (optional)
-│   │
-|   |───hack_cnn (free format)
-│   │   │   hacked_image.png   (optional)
-│   │   │   input_image.png
-│   │
-|   |───preprocessing_test
-|   |   |   input_video.mp4  (free format)
-│   │   │   image0.png  (free format)
-│   │   │   image1.png
-│   │   │   imagen.png
-│   │   │   image20.png
-|
-|───scripts
-│   │   train.py
-│   │   predict.py
-│   │   preprocess.py
-│   │   predict_live_stream.py
-│   │   hack_the_cnn.py
+├── data
+│   ├── test.csv
+│   ├── train.csv
+│   └── xxx.csv
+├── environment.yml
+├── README.md
+├── results
+│   ├── hack_cnn
+│   │   ├── hacked_image.png
+│   │   └── input_image.png
+│   ├── model
+│   │   ├── learning_curves.png
+│   │   ├── my_own_model_architecture.txt
+│   │   ├── my_own_model.pkl
+│   │   ├── pre_trained_model_architecture.txt
+│   │   └── pre_trained_model.pkl
+│   └── preprocessing_test
+│       ├── image0.png
+│       ├── image1.png
+│       ├── image_n.png
+│       └── input_video.mp4
+└── scripts
+    ├── hack_the_cnn.py
+    ├── predict_live_stream.py
+    ├── predict.py
+    ├── preprocess.py
+    └── train.py
 
 ```
 
 - Run **predict.py** expected output:
 
 ```prompt
-python predict.py
+python ./scripts/predict.py
 
 Accuracy on test set: 72%
 
@@ -112,7 +104,7 @@ Accuracy on test set: 72%
 - Run **predict_live_stream.py** expected output:
 
 ```prompt
-python predict_live_stream.py
+python ./scripts/predict_live_stream.py
 
 Reading video stream ...
 
diff --git a/subjects/ai/emotions-detector/audit/README.md b/subjects/ai/emotions-detector/audit/README.md
index 316ecfd29..e65cbf913 100644
--- a/subjects/ai/emotions-detector/audit/README.md
+++ b/subjects/ai/emotions-detector/audit/README.md
@@ -2,47 +2,7 @@
 
 ##### Preliminary
 
-```
-project
-│   README.md
-│   environment.yml
-│
-└───data
-│   │   train.csv
-│   │   test.csv
-│   │   xxx.csv
-│
-└───results
-│   │
-|   |───model (free format)
-│   │   │   my_own_model.pkl
-│   │   │   my_own_model_architecture.txt
-│   │   │   tensorboard.png
-│   │   │   learning_curves.png
-│   │   │   pre_trained_model.pkl (optional)
-│   │   │   pre_trained_model_architecture.txt (optional)
-│   │
-|   |───hack_cnn (free format)
-│   │   │   hacked_image.png   (optional)
-│   │   │   input_image.png
-│   │
-|   |───preprocessing_test
-|   |   |   input_video.mp4  (free format)
-│   │   │   image0.png  (free format)
-│   │   │   image1.png
-│   │   │   imagen.png
-│   │   │   image20.png
-|
-|───scripts
-│   │   train.py
-│   │   predict.py
-│   │   preprocess.py
-│   │   predict_live_stream.py
-│   │   hack_the_cnn.py
-
-```
-
-###### Does the structure of the project look as above?
+###### Does the structure of the project is equivalent to the one described in the subject `Delivery` section?
 
 ###### Does the readme file summarize how to run the code and explain the global approach?
 
@@ -64,10 +24,10 @@ project
 
 ###### Does the text document explain why the architecture was chosen and what were the previous iterations?
 
-###### Does the following command `python predict.py ` run without any error and returns an accuracy greater than 70%?
+###### Does the following command `python ./scripts/predict.py` run without any error and returns an accuracy greater than 70%?
 
 ```prompt
-    python predict.py
+    python ./scripts/predict.py
 
     Accuracy on test set: 72%
 
@@ -87,10 +47,10 @@ project
 
 ###### If there's an issue related to the webcam, does the code takes as input a video recorded video stream?
 
-###### Does the following command `predict_live_stream.py` run without any error and return the following?
+###### Does the following command `python ./scripts/predict_live_stream.py` run without any error and return the following?
 
 ```prompt
-    python predict_live_stream.py
+    python ./scripts/predict_live_stream.py
 
     Reading video stream ...