You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,11 @@ Dynamic neural network library
3
3
4
4
DyNet (formerly known as [cnn](http://github.com/clab/cnn-v1)) is a neural network library that is written in C++ with bindings in Python. It is designed to be efficient when run on either CPU or GPU, and works well with networks that have dynamic structures that change for every training instance. Read the instructions below to get started, and feel free to contact the [dynet-users group](https://groups.google.com/forum/#!forum/dynet-users) group or [github page](http://github.com/clab/dynet) with any questions, issues, or contributions.
5
5
6
-
###Building
6
+
## Building
7
7
8
8
(for how to use the python bindings, perform the following build process, then see `PYINSTALL.md`)
9
9
10
-
####Prerequisites
10
+
### Prerequisites
11
11
12
12
DyNet relies on a number of external libraries including Boost, cmake, Eigen, and mercurial (to install Eigen).
13
13
Boost, cmake, and mercurial can be installed from standard repositories, for example on Ubuntu linux:
@@ -18,7 +18,7 @@ To compile DyNet you also need the [development version of the Eigen library](ht
18
18
19
19
hg clone https://bitbucket.org/eigen/eigen/
20
20
21
-
####Building
21
+
### Building
22
22
23
23
To get and build DyNet, clone the repository
24
24
@@ -41,7 +41,7 @@ To see that things have built properly, you can run
41
41
42
42
which will train a multilayer perceptron to predict the xor function.
43
43
44
-
####Compiling/linking External Programs
44
+
### Compiling/linking External Programs
45
45
46
46
When you want to use DyNet in an external program, you will need to add the `dynet`
47
47
directory to the compile path:
@@ -52,7 +52,7 @@ and link with the dynet library:
52
52
53
53
-L/path/to/dynet/build/dynet -ldynet
54
54
55
-
####Debugging build problems
55
+
### Debugging build problems
56
56
57
57
If you have a build problem and want to debug, please run
58
58
@@ -63,9 +63,9 @@ then examine the commands in the `make.log` file to see if anything looks fishy.
63
63
you would like help, send this `make.log` file via the "Issues" tab on github, or to
64
64
the dynet-users mailing list.
65
65
66
-
####Build options
66
+
### Build options
67
67
68
-
#####GPU (CUDA) support
68
+
#### GPU (CUDA) support
69
69
70
70
`dynet` supports running programs on GPUs with CUDA. If you have CUDA installed, you
71
71
can build DyNet with GPU support by adding `-DBACKEND=cuda` to your cmake options.
@@ -79,7 +79,7 @@ shown above. When you want to run a program on GPU, you can link to the "libgdyn
79
79
(Eventually you will be able to use a single library to run on either CPU or GPU, but this is
80
80
not fully implemented yet.)
81
81
82
-
#####Non-standard Boost location
82
+
#### Non-standard Boost location
83
83
84
84
`dynet` supports boost, and will find it if it is in the standard location. If boost is
85
85
in a non-standard location, say `$HOME/boost`, you can specify the location by adding
@@ -91,7 +91,7 @@ the following to your cmake options:
91
91
Note that you will also have to set your `LD_LIBRARY_PATH` to point to the `boost/lib`
92
92
directory.
93
93
94
-
#####Building for Windows
94
+
#### Building for Windows
95
95
96
96
DYNET has been tested to build in Windows using Microsoft Visual Studio 2015. You may be able to build with MSVC 2013 by slightly modifying the instructions below.
97
97
@@ -107,7 +107,7 @@ To generate the MSVC solution and project files, run [cmake](http://www.cmake.or
107
107
108
108
This will generate dynet.sln and a bunch of \*.vcxproj files (one for the DYNET library, and one per example). You should be able to just open dynet.sln and build all. **Note: multi-process functionality is currently not supported in Windows, so you will not be able to build rnnlm-mp. Go to build->Configuration Manager and uncheck the box next to this project**
109
109
110
-
###Command line options
110
+
## Command line options
111
111
112
112
All programs using DyNet have a few command line options. These must be specified at the
113
113
very beginning of the command line, before other options.
@@ -125,7 +125,7 @@ very beginning of the command line, before other options.
125
125
*`--dynet-gpu-ids X,Y,Z`: Specify the GPUs that you want to use by device ID. Currently only
126
126
one GPU is supported, but if you use this command you can select which one to use.
127
127
128
-
###Creating your own models
128
+
## Creating your own models
129
129
130
130
An illustration of how models are trained (for a simple logistic regression model) is below:
0 commit comments