speechx doc

speechx/README.md

@@ -1,24 +1,61 @@
-# SpeechX -- Speech Inference All in One
+# SpeechX -- All in One Speech Task Inference 
 
-> Test under `Ubuntu 16.04.7 LTS`.
+## Environment
+
+We develop under:
+* docker - registry.baidubce.com/paddlepaddle/paddle:2.1.1-gpu-cuda10.2-cudnn7
+* os - Ubuntu 16.04.7 LTS
+* gcc/g++ - 8.2.0
+* cmake - 3.16.0
+
+> We make sure all things work fun under docker, and recommend using it to develop and deploy.
+
+* [How to Install Docker](https://docs.docker.com/engine/install/)
+* [A Docker Tutorial for Beginners](https://docker-curriculum.com/)
+* [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/overview.html)
 
 ## Build
 
+1. First to launch docker container.
+
+```
+nvidia-docker run --privileged  --net=host --ipc=host -it --rm -v $PWD:/workspace --name=dev registry.baidubce.com/paddlepaddle/paddle:2.1.1-gpu-cuda10.2-cudnn7 /bin/bash
 ```
+
+* More `Paddle` docker images you can see [here](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/install/docker/linux-docker.html).
+
+* If you want only work under cpu, please download corresponded [image](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/install/docker/linux-docker.html), and using `docker` instead `nviida-docker`.
+
+
+2. Build `speechx` and `examples`.
+
+```
+pushd /path/to/speechx
 ./build.sh
 ```
 
-## Valgrind
+3. Go to `examples` to have a fun.
+
+More details please see `README.md` under `examples`.
+
+
+## Valgrind (Optional)
 
 > If using docker please check `--privileged` is set when `docker run`.
 
-1. Fatal error at startup: a function redirection which is mandatory for this platform-tool combination cannot be set up
+* Fatal error at startup: `a function redirection which is mandatory for this platform-tool combination cannot be set up`
 ```
 apt-get install libc6-dbg
 ```
 
+* Install
+
 ```
 pushd tools
 ./setup_valgrind.sh
 popd
 ```
+
+## TODO
+
+* DecibelNormalizer: there is a little bit difference between offline and online db norm. The computation of online db norm read feature chunk by chunk, which causes the feature size is different with offline db norm. In normalizer.cc:73, the samples.size() is different, which causes the difference of result.

speechx/TODO.md

@@ -1,3 +0,0 @@
-# TODO
-
-* DecibelNormalizer: there is a little bit difference between offline and online db norm. The computation of online db norm read feature chunk by chunk, which causes the feature size is different with offline db norm. In normalizer.cc:73, the samples.size() is different, which causes the difference of result.

speechx/examples/README.md

@@ -1,5 +1,16 @@
 # Examples
 
-* decoder - offline decoder 
+* decoder - online decoder to work as offline
 * feat - mfcc, linear 
 * nnet - ds2 nn
+
+## How to run
+
+`run.sh` is the entry point.
+
+Example to play `decoder`:
+
+```
+pushd decoder
+bash run.sh
+```