Skip to content

Commit 1b68f09

Browse files
committed
Fixed hierarchy level of README
Former-commit-id: 3313a2c
1 parent 69e107b commit 1b68f09

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ Dynamic neural network library
33

44
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.
55

6-
### Building
6+
## Building
77

88
(for how to use the python bindings, perform the following build process, then see `PYINSTALL.md`)
99

10-
#### Prerequisites
10+
### Prerequisites
1111

1212
DyNet relies on a number of external libraries including Boost, cmake, Eigen, and mercurial (to install Eigen).
1313
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
1818

1919
hg clone https://bitbucket.org/eigen/eigen/
2020

21-
#### Building
21+
### Building
2222

2323
To get and build DyNet, clone the repository
2424

@@ -41,7 +41,7 @@ To see that things have built properly, you can run
4141

4242
which will train a multilayer perceptron to predict the xor function.
4343

44-
#### Compiling/linking External Programs
44+
### Compiling/linking External Programs
4545

4646
When you want to use DyNet in an external program, you will need to add the `dynet`
4747
directory to the compile path:
@@ -52,7 +52,7 @@ and link with the dynet library:
5252

5353
-L/path/to/dynet/build/dynet -ldynet
5454

55-
#### Debugging build problems
55+
### Debugging build problems
5656

5757
If you have a build problem and want to debug, please run
5858

@@ -63,9 +63,9 @@ then examine the commands in the `make.log` file to see if anything looks fishy.
6363
you would like help, send this `make.log` file via the "Issues" tab on github, or to
6464
the dynet-users mailing list.
6565

66-
#### Build options
66+
### Build options
6767

68-
##### GPU (CUDA) support
68+
#### GPU (CUDA) support
6969

7070
`dynet` supports running programs on GPUs with CUDA. If you have CUDA installed, you
7171
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
7979
(Eventually you will be able to use a single library to run on either CPU or GPU, but this is
8080
not fully implemented yet.)
8181

82-
##### Non-standard Boost location
82+
#### Non-standard Boost location
8383

8484
`dynet` supports boost, and will find it if it is in the standard location. If boost is
8585
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:
9191
Note that you will also have to set your `LD_LIBRARY_PATH` to point to the `boost/lib`
9292
directory.
9393

94-
##### Building for Windows
94+
#### Building for Windows
9595

9696
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.
9797

@@ -107,7 +107,7 @@ To generate the MSVC solution and project files, run [cmake](http://www.cmake.or
107107

108108
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**
109109

110-
### Command line options
110+
## Command line options
111111

112112
All programs using DyNet have a few command line options. These must be specified at the
113113
very beginning of the command line, before other options.
@@ -125,7 +125,7 @@ very beginning of the command line, before other options.
125125
* `--dynet-gpu-ids X,Y,Z`: Specify the GPUs that you want to use by device ID. Currently only
126126
one GPU is supported, but if you use this command you can select which one to use.
127127

128-
### Creating your own models
128+
## Creating your own models
129129

130130
An illustration of how models are trained (for a simple logistic regression model) is below:
131131

0 commit comments

Comments
 (0)