Merge branch 'master' of https://github.com/jcjohnson/torch-rnn

README.md

@@ -1,5 +1,29 @@
 # torch-rnn
 torch-rnn provides high-performance, reusable RNN and LSTM modules for torch7, and uses these modules for character-level
-language modeling similar to [char-rnn](https://github.com/karpathy/char-rnn).
+language modeling similar to [char-rnn](https://github.com/karpathy/char-rnn). You can find documentation for the modules
+[here](modules.md).
 
-Compared to char-rnn, torch-rnn is up to **1.9x faster** and uses up to **7x less memory**.
+Compared to char-rnn, torch-rnn is up to **1.9x faster** and uses up to **7x less memory**. For more details see 
+the [Benchmark](#Benchmarks) section below.
+
+
+# TODOs
+- CPU support
+- OpenCL support
+- Documentation
+  - Dependencies / installation
+  - VanillaRNN
+  - LSTM
+  - LanguageModel
+  - preprocess.py
+  - train.lua
+  - sample.lua
+
+# Setup
+
+# Usage
+
+# Benchmarks
+
+<img src='imgs/lstm_time_benchmark.png' width="400px">
+<img src='imgs/lstm_memory_benchmark.png' width="400px">

modules.md

@@ -0,0 +1,5 @@
+# VanillaRNN
+
+# LSTM
+
+# LanguageModel