From 26868f6226c36c76a885b5620b23bd876b05e64f Mon Sep 17 00:00:00 2001
From: Brussart Paul-emile <paul-emile.brussart@ecl19.ec-lyon.fr>
Date: Mon, 13 Feb 2023 21:07:17 +0000
Subject: [PATCH] Add README.md

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a166c30
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Hands on Reinforcement Learning
+
+## Introduction
+This project involves the application of Reinforcement Learning to train neural networks on various tasks, and tracking and disseminating the results. The first task, Cart Pole, involves training a neural network using the Reinforce method and then optimizing it with the Stable Baseline library. The second task, Panda Reach Joints Dense, involves using a robotic arm to reach all points in a given space.
+
+## How to use it
+Executing the multiple scripts will train the models and produce monitoring data on the Weights and Bias platform.
+
+## Results
+
+### Reinforce Cartpole 
+The results of the training of a Neural Network applied to the Cartpole Environment are displayed below :
+
+![Loss](reinforce_cartpole_loss.png)
+![Reward](reinforce_cartpole_reward.png)
+
+### A2C SB3 Cartpole
+The trained model can be found on Hugging Face : [a2c_sb3_cartpole](https://huggingface.co/pbrussar/a2c_sb3_cartpole).
+The tracking and monitoring of the training can be seen on [Weights and Biases](https://wandb.ai/pbrussar/cartpole?workspace=user-pbrussar).
+
+### A2C SB3 Panda Reach
+The trained model can be found on Hugging Face : [a2c_sb3_pandareach](https://huggingface.co/pbrussar/pandareach).
+The tracking and monitoring of the training can be seen on [Weights and Biases](https://wandb.ai/pbrussar/pandareach?workspace=user-pbrussar).
+
+Here is a screenshot of the training being completed:
+![Training](panda_reach_training.png)
+
+## Authors and acknowledgment
+Author : Paul-Emile Brussart.
+Following Quentin Gallouédec's [repository](https://gitlab.ec-lyon.fr/qgalloue/hands-on-rl/-/tree/main) and directives. 
+
+## License
+Copyright 2023 Paul-Emile BRUSSART
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-- 
GitLab