diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | README.md | 15 | ||||
| -rw-r--r-- | nerv/doc/source/conf.py | 3 | ||||
| -rw-r--r-- | nerv/doc/source/index.rst | 4 |
4 files changed, 16 insertions, 7 deletions
@@ -3,3 +3,4 @@ install/ build/ *.swp *.swo +speech/ @@ -1,24 +1,31 @@ #The Nerv Toolkit User Manual# -NOTE: This readme is obsolete and will be rearranged, for further information, please check http://determinant.github.io/nerv/ +NOTE: This readme is obsolete and will be rearranged, for further information, please check http://nerv-sjtu.github.io/nerv/ 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 + +#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## diff --git a/nerv/doc/source/conf.py b/nerv/doc/source/conf.py index 8426613..4d6119f 100644 --- a/nerv/doc/source/conf.py +++ b/nerv/doc/source/conf.py @@ -15,6 +15,7 @@ import sys import os import shlex +import alabaster # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -119,7 +120,7 @@ html_theme = 'alabaster' #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = [alabaster.get_path()] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". diff --git a/nerv/doc/source/index.rst b/nerv/doc/source/index.rst index e55892b..21cf309 100644 --- a/nerv/doc/source/index.rst +++ b/nerv/doc/source/index.rst @@ -21,7 +21,7 @@ TODO List | Status/ | Task | Assignee | | Priority | | | +==========+==========================================================================+=============+ -| High | Generalize nerv.Matrix to nerv.Tensor (use the same API as Torch Tensor) | Ted Yin | +| High | Generalize nerv.Matrix to nerv.Tensor (use the same API as Torch Tensor) | Mengxiao Bi | +----------+--------------------------------------------------------------------------+-------------+ | High | Development manual: coding style & contribution rules | Ted Yin | +----------+--------------------------------------------------------------------------+-------------+ @@ -31,7 +31,7 @@ TODO List +----------+--------------------------------------------------------------------------+-------------+ | High | support for RNN/LSTM | Tianxing He | +----------+--------------------------------------------------------------------------+-------------+ -| Mid | support for CNN | ? (Ted Yin) | +| High | support for CNN | Mengxiao Bi | +----------+--------------------------------------------------------------------------+-------------+ | Mid | User manual | ALL | +----------+--------------------------------------------------------------------------+-------------+ |