Permalink
Browse files

renamed and updated README

  • Loading branch information...
1 parent 6c3f7f1 commit 412c7d9ae0c5ef3519c458815abe51976b78f8a1 @kvalle committed Mar 4, 2012
Showing with 11 additions and 8 deletions.
  1. +0 −8 README
  2. +11 −0 README.md
View
8 README
@@ -1,8 +0,0 @@
-** PyANN
-** Generic Artificial Neural Network Framework in Python
-
-This is a general framework for creating neural nets, through the use of script files and case files.
-
-Script files define the neural net you want to create. A case file contains optional training and testing data.
-
-Documentation is non-existent, so take a look at the examples in the annlib/scripts and annlib/cases folders.
View
@@ -0,0 +1,11 @@
+## PyANN - Generic Artificial Neural Network Framework in Python
+
+This is a general framework for creating neural nets, through the use of script files and case files.
+Script files define the neural net you want to create, case files contain optional training and testing data.
+
+The framework was written as part of a series of exercises in the course _IT3708 Subsymbolic Methods in AI_ at [NTNU](http://ntnu.no).
+For more information, see our [expercise report](PyANN/blob/master/report.pdf?raw=true) describing the framework implementation and how we used it to train a ANN [webots](http://www.cyberbotics.com/overview) controller.
+
+We haven't bothered to write any user documentation, so take instead a look at the examples in the `annlib/scripts` and `annlib/cases` folders.
+
+The framework's only dependency should be the python `yaml` package.

0 comments on commit 412c7d9

Please sign in to comment.