Skip to content

Commit

Permalink
Add Installation section in docs/
Browse files Browse the repository at this point in the history
  • Loading branch information
snukky committed Mar 14, 2018
1 parent 357d3ac commit d0e543f
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
2 changes: 2 additions & 0 deletions _plugins/github_link_tag.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ def initialize(tag_name, path, tokens)
path.sub!(/\s*".*"\s*/, '')
end
@repo, @path = path.split('/', 2)
@repo.strip! unless @repo.nil?
@path.strip! unless @path.nil?
end

def render(context)
Expand Down
53 changes: 53 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,59 @@ command line options):



## Installation

Clone a fresh copy from github:

git clone https://github.com/marian-nmt/marian

The project is a standard CMake out-of-source build:

cd marian
mkdir build
cd build
cmake ..
make -j

If run for the first time, this will also download {% github_link marian-dev %}
--- the training framework for Marian.

### Custom Boost

Download, compile and install Boost:
```
wget https://dl.bintray.com/boostorg/release/1.64.0/source/boost_1_64_0.tar.gz
tar zxvf boost_1_64_0.tar.gz
cd boost_1_64_0
./bootstrap.sh
./b2 -j16 --prefix=$(pwd) --libdir=$(pwd)/lib64 --layout=system link=static install
```

To compile Marian training framework with your custom Boost installation:
```
cd /path/to/marian-dev
mkdir build
cd build
cmake .. -DBOOST_ROOT=/path/to/boost_1_64_0
make -j16
```

Tested on Ubuntu 16.04.3 LTS.

### Non-default CUDA

Specify the path to your CUDA root directory via CMake:
```
cd /path/to/marian-dev
mkdir build
cd build
cmake .. -DCUDA_TOOLKIT_ROOT_DIR=/usr/local/cuda-9.1
make -j16
```



## Training

For training NMT models, you want to use `marian` command.
Expand Down

0 comments on commit d0e543f

Please sign in to comment.