From c9e8bc5faa1f0e8db256ff4fdb49a768de06a2e3 Mon Sep 17 00:00:00 2001
From: jmuozan <146674258+jmuozan@users.noreply.github.com>
Date: Tue, 14 May 2024 11:21:31 +0200
Subject: [PATCH] Readme Intro

---
 README.md | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 005c9b3..0e73292 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,24 @@
-#  Things to solve
+#  Machine Learning for Action Detection
 
-- [ ] Hands don't have visibility values so if they are not detected you will get no output. It's necessary to translate it into a blank array filled with 0s
+As part of my thesis project on Future Learning focused on Arts and Crafts I decided to prototype for third MicroChallenge a machine learning model that can learn certain actions and tell you when you're doing them right or wrong. With a live camera prediction you'll be able to know if the movement is being done in the correct way.
 
-- [ ] The arrays to train need to have the same dimensions so I need to add blank arrays so all the samples are the same
+## What files are available on the repo?
+
+In this repository you'll find:
+
+- `ML_Sequence_Recognition.ipynb` a Jupyter notebook with all the steps since the data collection and treatment to the training and real-time predictions
+- `Real_Time_Pred.py` a python file with just the predictions in real time, in case you just want to test how it works
+- `actions.h5` the model already trained
+- `IMGS` folder, with the images for this documentation
+- `CSVs` for you to see how the data will look like during it's collection and treatment
+
+## References
+
+If you want to use ML to predict sequences but this structure doesn't fit to you I highly recommend to check the following tutorials where I've been inspired:
+
+- [Nicholas Renotte: Sign Language Detection using ACTION RECOGNITION with Python | LSTM Deep Learning Model](https://www.youtube.com/watch?v=doDUihpj6ro&list=PLtjLv8XIYA2GPl5Pju2eebqfV9oOlB675&index=4)
+- [Nicholas Renotte: AI Learns to Do Deadlifts](https://www.youtube.com/watch?v=H7cGq0xIHbc&list=PLtjLv8XIYA2GPl5Pju2eebqfV9oOlB675)
+- [Nicholas Renotte: Training my deadlift bot with MediaPipe and OpenCV](https://www.youtube.com/watch?v=PGsAsuwBdw0&list=PLtjLv8XIYA2GPl5Pju2eebqfV9oOlB675&index=2)
 
-