Skip to content

Commit c8773a9

Browse files
authored
Update README.md
1 parent a4eb580 commit c8773a9

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,12 @@ This is necessary in order to model long-term dependencies such as can be found
66
This program will learn to produce text similar to the one that
77
it has been training on using a LSTM network implemented in C. The repo is inspired by Andrej Karpathys <i>char-rnn</i>: https://github.com/karpathy/char-rnn but instead implemented in C to be used in more constrained environments.
88

9-
# How do I use it?
9+
# Build
1010

1111
Do you have a mac or a Linux machine?
1212
In that case it is super easy to download and run.
1313

14-
However, I don't really know how to compile this program in Windows since I am not using Windows myself. I have used a program called MinGW to compile my own C programs in the past. But maybe check this out if you are on Windows: https://sourceforge.net/projects/mingw/files/
15-
16-
Otherwise:
14+
## Mac or Linux (Unix world)
1715

1816
Download the program.
1917
Open a terminal window and type:
@@ -36,6 +34,19 @@ Then run the program:
3634
where datafile is a file with the traning data and it will start training on it. You can see the progress
3735
over time.
3836

37+
## Windows
38+
39+
I have only built it using Visual Studio Native Tools Command Prompt for VS2017.
40+
But install CMake and Nmake.
41+
Then do:
42+
43+
<pre>
44+
cmake -G"NMake Makefiles"
45+
nmake
46+
</pre>
47+
48+
# Configure
49+
3950
Check out the file "std_conf.h".
4051

4152
In std_conf.h you can edit the program. You can edit the hyperparameters such as learning rate etc, set the number of layers (2/3 is best I think), set how often it should output data etc. If you edit this file, you edit the source code and you will need to rebuild the program with the command "make". You can also use input arguments to set some of the behaviour.

0 commit comments

Comments
 (0)