Skip to content

Commit 0e74fea

Browse files
authored
Update README.md
1 parent 6cc76c4 commit 0e74fea

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,18 @@
22

33
A universal supervisor controller and Reinforcement Learning suite for Webots ([https://www.cyberbotics.com/](https://www.cyberbotics.com/) ) that can be adapted to **any wheeled robot morphology** with ease. This is also a Reinforcement Learning suite that allows for easy experimentation and controller synthesis with the popular **CMA-ES** evolutionary algorithm, a **novelty search** augmented CMA-ES, and **MAP-Elites**, as well as both a fixed and recurrent neural network.
44

5-
This suite allows the user to pick a desired configuration of Neural Network and Algorithm to carry out Reinforcement Learning with a robot of their choice.
5+
This suite allows the user to pick a desired configuration of Neural Network and Algorithm to carry out Reinforcement Learning with a robot of their choice.
66

77
This is a **work in progress** and will continued to be refined, streamlined and expanded.
88

9-
**Coding Standards**
9+
## **Coding Standards**
10+
1011
All code code has been designed for **ease of use** and **educational** purposes. Variables are as **close to plain English** as possible, and in cases speed and space efficiency has been sacrificed to make each step of the coding involved **as clear as possible** to the user.
1112

1213
This suite is designed to be used by non-technical as well as technical users and it is asked that the above coding standards are kept in mind during any future merge/pull requests.
1314

14-
Set up instructions can also be included as comments in each relevant module.
15-
16-
**UniversalController**
17-
15+
## **Universal Controller**
16+
(Set up instructions can also be found as comments in each relevant module.)
1817
*Features*
1918
- Default configuration is for a two wheeled robotic agent but can be easily expanded - instructions inside module next to relevant methods
2019
- Within a few lines of code a non-technical user can carry out Reinforcement Learning/Controller synthesis with a robotic agent and environment of their choice
@@ -56,7 +55,7 @@ Example set up code from UniversalController.py:
5655
myEA.runAlgorithm(generations = 40)
5756

5857

59-
**Available Configurations:**
58+
## **Available Configurations:**
6059

6160
*Neural Networks*
6261
- Fixed Neural Network - standard feed forward NN
@@ -72,7 +71,9 @@ Example set up code from UniversalController.py:
7271

7372
- Currently usable with any wheeled robot - default configuration is two wheels and can be manually edited via instructions in UniversalController.py
7473

75-
**Data Reporting**
74+
75+
## **Data Reporting**
76+
7677
- Dedicated DataReporting module with instructions that allows for:
7778
- Saving and loading of all run and hyperparameter testing data
7879
- Visualisation of run data via box plots
@@ -108,5 +109,6 @@ Example data visualisation code from DataVisualisationandTesting.py:
108109
A formal user guide will be put together in the future.
109110

110111

111-
**Known Deap Library Issue**
112-
-Deap library throws an exception that does not interrupt the running program but displays in the console window when the CMA-ES algorithm resets itself in-between completed runs. You can simply comment out the few lines of code it refers to if you wish to avoid it clogging up the window.
112+
# **Known Deap Library Issue**
113+
114+
Deap library throws an exception that does not interrupt the running program but displays in the console window when the CMA-ES algorithm resets itself in-between completed runs. You can simply comment out the few lines of code it refers to if you wish to avoid it clogging up the window.

0 commit comments

Comments
 (0)