X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=dyncnn.git;a=blobdiff_plain;f=README.txt;fp=README.txt;h=8a832509880cfdb94b32cab0042dd6da9a1c0879;hp=0000000000000000000000000000000000000000;hb=a32852e5e1c1d0cd7886fbfa2dce337fb3db9796;hpb=8e60c68637e79580cdefa53edf79a4804849997d

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..8a83250
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,17 @@
+
+This is an implementation of a deep residual network for predicting
+the dynamics of 2D shapes.
+
+This package is composed of two main parts: A simple 2d physics
+simulator called 'flatland' written in C++, to generate the data-set,
+and a deep residual network 'dyncnn' written in the Lua/Torch7
+framework.
+
+You can run the reference experiment by executing the run.sh shell
+script. It will generate the data-set of 50k triplets of images, train
+the deep network, and output validation results every 100 epochs.
+
+--
+Francois Fleuret
+Oct 7, 2016
+Martigny