Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lvapeab committed Apr 27, 2017
1 parent 2be5279 commit 361bb19
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 3 deletions.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
18 changes: 16 additions & 2 deletions docs/source/requirements.rst
Original file line number Diff line number Diff line change
@@ -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_.
Expand All @@ -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
.. _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

0 comments on commit 361bb19

Please sign in to comment.