diff --git a/README.md b/README.md index 3c4fc8f..0307c07 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,20 @@ Library documentation: [nmt-keras.readthedocs.io](https://nmt-keras.readthedocs. * MLPs for initializing the RNN hidden and memory state. * [Spearmint](https://github.com/HIPS/Spearmint) [wrapper](https://github.com/lvapeab/nmt-keras/tree/master/meta-optimizers/spearmint) for hyperparameter optimization -## Requirements +## Installation + +Assuming that you have [pip](https://en.wikipedia.org/wiki/Pip_(package_manager)) installed, run: + + ```bash + git clone https://github.com/lvapeab/nmt-keras + cd nmt-keras + pip install -r requirements.txt + ``` + + for obtaining the required packages for running this library. + + +### Requirements NMT-Keras requires the following libraries: diff --git a/docs/source/requirements.rst b/docs/source/requirements.rst index 32b7eef..c9329ea 100644 --- a/docs/source/requirements.rst +++ b/docs/source/requirements.rst @@ -1,5 +1,17 @@ -Requirements +Installation ============ +Assuming that you have pip_ installed, run:: + + git clone https://github.com/lvapeab/nmt-keras + cd nmt-keras + pip install -r requirements.txt + +for obtaining the required packages for running this library. + +Nevertheless, it is highly recommended to install and configure Theano_ with the GPU and speed optimizations enabled. + +Requirements +^^^^^^^^^^^^ - Our version of Keras_. - `Multimodal Keras Wrapper`_. See the documentation_ and tutorial_. @@ -9,4 +21,6 @@ Requirements .. _Multimodal Keras Wrapper: https://github.com/lvapeab/multimodal_keras_wrapper .. _documentation: http://marcbs.github.io/staged_keras_wrapper/ .. _tutorial: http://marcbs.github.io/multimodal_keras_wrapper/tutorial.html -.. _Coco-caption: https://github.com/lvapeab/coco-caption \ No newline at end of file +.. _Coco-caption: https://github.com/lvapeab/coco-caption +.. _pip: https://en.wikipedia.org/wiki/Pip_(package_manager) +.. _Theano: http://theano.readthedocs.io/en/0.8.x/install.html \ No newline at end of file