Skip to content

Commit 06943bd

Browse files
authored
Update README.md
1 parent fa4f62c commit 06943bd

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,32 @@
22

33
- It is an extension of [Unity ML agent](https://github.com/Unity-Technologies/ml-agents) for deep learning, primarily reinforcement learning, with in-editor/in-game training support. It also provides interface for another optimization algorithm called MAES.
44

5-
- It uses a modified version of [KerasSharp](https://github.com/tcmxx/keras-sharp) and [TensorflowSharp](https://github.com/migueldeicaza/TensorFlowSharp) as backend. No python is needed for model building/evaluation/training. You can even build a standalone with training capability.
5+
- It uses a modified version of [KerasSharp](https://github.com/tcmxx/keras-sharp) and [TensorflowSharp](https://github.com/migueldeicaza/TensorFlowSharp) as backend. No python is needed for model building/evaluation/training. You can even build a standalone(an actual playable game!) with training capability.
66

7-
- This repo is made for Aalto University's Computational Intelligence in Games course. [The original materials](https://github.com/tcmxx/CNTKUnityTools) are made with [CNTK](https://github.com/Microsoft/CNTK). Now it is remade with [Tensorflow](https://github.com/tensorflow/tensorflow). It will also be my master's thesis hopefully.
7+
- This repo is made for Aalto University's Computational Intelligence in Games course. [The original materials](https://github.com/tcmxx/CNTKUnityTools) are made with [CNTK](https://github.com/Microsoft/CNTK). Now the course is updated to another course called [Computational Intelligence in Media](https://onlinelearning.aalto.fi/pilot/intelligent-computational-media/) whcih includes two parts: Audio and Games. The material game part for is remade here with [Tensorflow](https://github.com/tensorflow/tensorflow) and [Unity ML agent](https://github.com/Unity-Technologies/ml-agents). It will also be my master's thesis hopefully.
88

99
- Note: This project is still in development. Don't use this unless you know that you have time to check the sourcecodes!
1010

11+
1112
## Features:
1213
* Use your already made Unity ML-Agent, but enable learning in Unity editor/build without python or extra coding.
1314
* Reinforcement learning(using PPO) and supervised learning.
14-
* Evolution Strategy (using Matrix Adaption Evolution Strategy(MEAS))
15+
* Evolution Strategy (using Covariance Matrix Adaption Evolution Strategy(CMA-ES))
1516
* Examples provided.
1617

17-
## Documentation
18-
For more information including installation and usage instructions, go to [Document](Documents/Readme.md).
19-
20-
## Tested Unity Version: 2018.1.6f1
18+
# Requirements:
19+
[Unity ML agent v0.5](https://github.com/Unity-Technologies/ml-agents)
20+
Unity 2018.1.6f1(Should be working with some of the newer versions as well).
2121

2222
## Platforms:
23-
Windows is almost fully supported. If you want to use GPU, CUDA and cuDNN are needed(Please google CUDA v9.0 and cudnn v7 and install them). Mac should be fully supported if I have a Mac to build, but now it does not have Concat Gradient. Mac does not support GPU. Linux is not tested at all.
23+
- Windows is almost fully supported. If you want to use GPU, CUDA and cuDNN are needed(Please google CUDA v9.0 and cudnn v7 and install them).
24+
- Mac should be fully supported if I have a Mac to build, but now it does not have Concat Gradient, which means the agent can not have both visual and vector observations at the same time, and discrete action branching is not supported neither. Mac does not support GPU. - Linux is not tested at all.
25+
- Android does not support any type of gradient/training. But you can use trained neural network on it.
26+
- IOS is not tested a all.
2427

25-
Android does not support any type of gradient/training. IOS is not tested a all.
28+
## Documentation
29+
- Installation: https://github.com/tcmxx/UnityTensorflowKeras/blob/master/Documents/Installation.md
30+
- For more information including installation and usage instructions, go to [Document](Documents/Readme.md).
2631

2732
## Future Plan:
2833
We plan to keep this repo updated with latest game related machine learning technologies for the course every year.
@@ -32,7 +37,7 @@ Possible future plans/contributions:
3237
* More benchmark environments.
3338
* Better API for in game usage.
3439
* More algorithms including: Deep Q Learning, Deep Mimic, Evolved Policy Gradient, Genetic Algorithms and so on.
35-
* Improving the logging tool or using Tensorboard in c#.
40+
* Improving the logging tool.
3641
* Graphic editor for neural network architecture
3742

3843
## License

0 commit comments

Comments
 (0)