Skip to content

Commit 361bb19

Browse files
committed
Update README.md
1 parent 2be5279 commit 361bb19

File tree

2 files changed

+30
-3
lines changed

2 files changed

+30
-3
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,20 @@ Library documentation: [nmt-keras.readthedocs.io](https://nmt-keras.readthedocs.
2222
* MLPs for initializing the RNN hidden and memory state.
2323
* [Spearmint](https://github.com/HIPS/Spearmint) [wrapper](https://github.com/lvapeab/nmt-keras/tree/master/meta-optimizers/spearmint) for hyperparameter optimization
2424

25-
## Requirements
25+
## Installation
26+
27+
Assuming that you have [pip](https://en.wikipedia.org/wiki/Pip_(package_manager)) installed, run:
28+
29+
```bash
30+
git clone https://github.com/lvapeab/nmt-keras
31+
cd nmt-keras
32+
pip install -r requirements.txt
33+
```
34+
35+
for obtaining the required packages for running this library.
36+
37+
38+
### Requirements
2639

2740
NMT-Keras requires the following libraries:
2841

docs/source/requirements.rst

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
1-
Requirements
1+
Installation
22
============
3+
Assuming that you have pip_ installed, run::
4+
5+
git clone https://github.com/lvapeab/nmt-keras
6+
cd nmt-keras
7+
pip install -r requirements.txt
8+
9+
for obtaining the required packages for running this library.
10+
11+
Nevertheless, it is highly recommended to install and configure Theano_ with the GPU and speed optimizations enabled.
12+
13+
Requirements
14+
^^^^^^^^^^^^
315

416
- Our version of Keras_.
517
- `Multimodal Keras Wrapper`_. See the documentation_ and tutorial_.
@@ -9,4 +21,6 @@ Requirements
921
.. _Multimodal Keras Wrapper: https://github.com/lvapeab/multimodal_keras_wrapper
1022
.. _documentation: http://marcbs.github.io/staged_keras_wrapper/
1123
.. _tutorial: http://marcbs.github.io/multimodal_keras_wrapper/tutorial.html
12-
.. _Coco-caption: https://github.com/lvapeab/coco-caption
24+
.. _Coco-caption: https://github.com/lvapeab/coco-caption
25+
.. _pip: https://en.wikipedia.org/wiki/Pip_(package_manager)
26+
.. _Theano: http://theano.readthedocs.io/en/0.8.x/install.html

0 commit comments

Comments
 (0)