Skip to content

Commit

Permalink
Merge pull request tmbdev#104 from mihaelacr-google/patch-1
Browse files Browse the repository at this point in the history
Update README to fix installation instructions.
  • Loading branch information
kba authored Nov 8, 2016
2 parents 62339c0 + 50009a7 commit a22d2c7
Showing 1 changed file with 17 additions and 15 deletions.
32 changes: 17 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,15 @@ available now.

- scons, Eigen
- protocol buffer library and compiler
- libpng
- Optional: HDF5, ZMQ, Python

```sh
# Ubuntu 15.04 / Debian 8
sudo apt-get install scons libprotobuf-dev libprotobuf9 protobuf-compiler
sudo apt-get install scons libprotobuf-dev libprotobuf9 protobuf-compiler libpng-dev

# Ubuntu 14.04:
sudo apt-get install scons libprotobuf-dev libprotobuf8 protobuf-compiler
sudo apt-get install scons libprotobuf-dev libprotobuf8 protobuf-compiler libpng-dev
```

Download [Eigen](http://eigen.tuxfamily.org) with Tensor support (> v3.3-beta1)
Expand All @@ -41,7 +42,8 @@ and copy the header files to an `include` path:
# with wget
wget 'https://github.com/RLovelett/eigen/archive/3.3-rc1.tar.gz'
tar xf 3.3-rc1.tar.gz
mv eigen-3.3-rc1 /usr/local/include
rm -f /usr/local/include/eigen3
mv eigen-3.3-rc1 /usr/local/include/eigen3
# or with git:
sudo git clone --depth 1 --single-branch --branch 3.3-rc1 \
"https://github.com/RLovelett/eigen" /usr/local/include/eigen3
Expand All @@ -66,18 +68,6 @@ sudo apt-get install hdf5-helpers libhdf5-7 libhdf5-dev python-h5py

# Getting Started

There is a full set of tests in the current version of clstm; just
run them with:

./run-tests

This will check:

- gradient checkers for layers and compute steps
- training a simple model through the C++ API
- training a simple model through the Python API
- checking the command line training tools, including loading and saving

To build a standalone C library, run

scons
Expand All @@ -97,6 +87,18 @@ After building the executables, you can run two simple test runs as follows:
- `run-cmu` will train an English-to-IPA LSTM
- `run-uw3-500` will download a small OCR training/test set and train an OCR LSTM

There is a full set of tests in the current version of clstm; just
run them with:

./run-tests

This will check:

- gradient checkers for layers and compute steps
- training a simple model through the C++ API
- training a simple model through the Python API
- checking the command line training tools, including loading and saving

To build the Python extension, run

python setup.py build
Expand Down

0 comments on commit a22d2c7

Please sign in to comment.