From f45620383de29829759e860fcec662cb1e627a6e Mon Sep 17 00:00:00 2001
From: Yann SOULLARD <yann.soullard@univ-rouen.fr>
Date: Wed, 3 Jan 2018 15:47:48 +0100
Subject: [PATCH] README

---
 README.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e00b871
--- /dev/null
+++ b/README.md
@@ -0,0 +1,79 @@
+# CTCModel : A transparent CTC implementation for Keras
+
+## Description
+
+CTCModel makes the training of a RNN with the Connectionnist Temporal Classification approach completely transparent.
+
+It directly inherits from the traditionnal Keras 2 Model and uses the TensorFlow implementation of the CTC loss and decoding functions.
+
+## Dependencies
+- Keras
+- Tensorflow
+
+## Installation
+$ git clone https://github.com/litislab/CTCModel
+$ cd CTCModel
+
+## Getting started
+<code>
+from keras.layers import LSTM, TimeDistributed, Dense, Activation, Input
+from keras.optimizers import Adam
+from numpy import zeros
+from CTCModel import CTCModel
+&nbsp;
+input_layer = Input((None, h_features))
+lstm0 = LSTM(128, return_sequences=True)(input_layer)
+lstm1 = LSTM(128, return_sequences=True)(lstm0)
+dense = TimeDistributed(Dense(nb_labels))(lstm1)
+output_layer = Activation("sigmoid")
+&nbsp;
+model = CTCModel(input_layer, output_layer)
+model.compile(optimizer=Adam(lr=1e-4))
+</code>
+
+
+----------
+
+
+The standard inputs x and y of a Keras Model, where x is the observations and y the labels, are here defined differently. In CTCModel, you must provide as x:
+
+ -  the **input observations**
+ -  the **labels**
+ -  the **lengths of the input sequences**
+ -  the **lengths of the label sequences** 
+
+Here, y is not used in a standard way and must be defined for Keras methods (as the labels or an empty structure of length equal to the length of labels).
+Let *x_train*, *y_train*, *x_train_len* and *y_train_len* those terms. Fit, evaluate and predict methods can be used as follow:
+<code>
+model.fit(x=[x_train,y_train,x_train_len,y_train_len], y=zeros(nb_train), batch_size=64)
+&nbsp;
+print(model.evaluate(x=[x_test,y_test,x_test_len,y_test_len], batch_size=64))
+&nbsp;
+model.predict([x_test, x_test_len])
+</code>
+
+
+## Under the hood
+CTCModel works by adding three additionnal output layers to a recurrent network for computing the CTC loss, decoding and evaluating using standard metrics for sequence analysis (the sequence error rate and label error rate). Each one can be applied in a blind manner, by the use of standard Keras methods such as *fit*, *predict* and *evaluate*. Note that methods based on generator have been defined and can be used in a standard way provided that input x and label y that are return by the generator have the specific structure seen above. 
+
+Except the three specific layers, CTCModel works as a standard Keras Model and most of the overriden methods just select the right output layer and call the related Keras Model method. There is also additional methods to save or load model parameters and other ones to get specific computations, e.g. the loss using *get_loss* or the input probabilities using *get_probas* (and the related *on_batch* and *generator* methods). 
+
+## Credits and licence
+CTCModel was developped at the LITIS laboratory, Normandie University (http://www.litislab.fr) by Cyprien RUFFINO and Yann SOULLARD, under the supervision of Thierry PAQUET.
+
+CTCModel is under the terms of the GPL-3.0 licence.
+
+If you use CTCModel for research purposes, please consider adding the following citation to your paper:
+
+<code>
+@misc{ctcmodel,
+author = {Ruffino, Cyprien and Soullard, Yann and Paquet, Thierry},
+howpublished = {$\backslash$url{\{}https://arxiv.org/link},
+title = {{CTCModel : nom de l'article}},
+year = {2017}
+}
+</code>
+
+## References
+F. Chollet et al.. Keras: Deep Learning for Python, https://github.com/keras-team/keras, 2015.
+A. Graves, S. Fernández, F. Gomez, J. Schmidhuber. Connectionist temporal classification: labelling unsegmented sequence data with recurrent neural networks. In Proceedings of the 23rd international conference on Machine learning (pp. 369-376). ACM, June 2006.
-- 
GitLab