aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authortxh18 <[email protected]>2015-11-23 15:34:05 +0800
committertxh18 <[email protected]>2015-11-23 15:34:05 +0800
commitfee96e3d2cb39c6e2b4631b9d8b37b9949df27e7 (patch)
tree18493f755fedd928f5225d435875cd440342d255 /README.md
parentcb4f01b67c3bbbfef8eee8902210b75957add62f (diff)
parent6d66b73e49e3a3e41a1fb92d5180163f45ff6253 (diff)
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index 35af165..fe9dfc1 100644
--- a/README.md
+++ b/README.md
@@ -3,22 +3,30 @@ NOTE: This readme is obsolete and will be rearranged, for further information, p
This user manual will information about how to use __Nerv__ and __Nerv__'s interface.
-##How to use##
+##How to make and start using##
First make sure you have __lua__ and __CUDA__ installed on your computer.
__Nerv__ is currently developed via github.You can download and make __Nerv__ by doing the following:
```
cd ~
git clone https://github.com/Nerv-SJTU/nerv.git
cd nerv
-git clone https://github.com/Nerv-SJTU/nerv-speech.git speech
git submodule init && git submodule update
make
+#To include some new CUDA feature(e.x. atomicCAS), use "make CFLAGS=-D__NERV_FUTURE_CUDA_7"
+
+#further, if you want the speech modules
+git clone https://github.com/Nerv-SJTU/nerv-speech.git speech
make speech
```
The `git submodule` command is for the __luajit__ repository inside __Nerv__.
Now, you can try to run some example scripts.
```
-./nerv examples/cumatrix_example.lua
+./install/bin/nerv examples/cumatrix_example.lua
+```
+To get an example of DNN(for ASR) training, run(this requires the speech modules)
+You need to be at or (copy files from) `/slfs1`(SJTU speechlab cluster) to get this running.
+```
+./install/bin/nerv nerv/examples/asr_trainer.lua nerv/examples/swb_baseline.lua
```
##How to contribute##