mirror of
https://github.com/k2-fsa/icefall.git
synced 2025-08-08 09:32:20 +00:00
Fix doc for building ncnn (#822)
This commit is contained in:
parent
9a9c5a0f9b
commit
9453eb1c70
24
docs/README.md
Normal file
24
docs/README.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /path/to/icefall/docs
|
||||||
|
pip install -r requirements.txt
|
||||||
|
make clean
|
||||||
|
make html
|
||||||
|
cd build/html
|
||||||
|
python3 -m http.server 8000
|
||||||
|
```
|
||||||
|
|
||||||
|
It prints:
|
||||||
|
|
||||||
|
```
|
||||||
|
Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...
|
||||||
|
```
|
||||||
|
|
||||||
|
Open your browser and go to <http://0.0.0.0:8000/> to view the generated
|
||||||
|
documentation.
|
||||||
|
|
||||||
|
Done!
|
||||||
|
|
||||||
|
**Hint**: You can change the port number when starting the server.
|
@ -531,16 +531,36 @@ First, let us install a modified version of ``ncnn``:
|
|||||||
git clone https://github.com/csukuangfj/ncnn
|
git clone https://github.com/csukuangfj/ncnn
|
||||||
cd ncnn
|
cd ncnn
|
||||||
git submodule update --recursive --init
|
git submodule update --recursive --init
|
||||||
python3 setup.py bdist_wheel
|
|
||||||
ls -lh dist/
|
# Note: We don't use "python setup.py install" or "pip install ." here
|
||||||
pip install ./dist/*.whl
|
|
||||||
|
mkdir -p build-wheel
|
||||||
|
cd build-wheel
|
||||||
|
|
||||||
|
cmake \
|
||||||
|
-DCMAKE_BUILD_TYPE=Release \
|
||||||
|
-DNCNN_PYTHON=ON \
|
||||||
|
-DNCNN_BUILD_BENCHMARK=OFF \
|
||||||
|
-DNCNN_BUILD_EXAMPLES=OFF \
|
||||||
|
-DNCNN_BUILD_TOOLS=OFF \
|
||||||
|
..
|
||||||
|
|
||||||
|
make -j4
|
||||||
|
|
||||||
|
cd ..
|
||||||
|
|
||||||
|
# Note: $PWD here is /path/to/ncnn
|
||||||
|
|
||||||
|
export PYTHONPATH=$PWD/python:$PYTHONPATH
|
||||||
|
export PATH=$PWD/tools/pnnx/build/src:$PATH
|
||||||
|
export PATH=$PWD/build/tools/quantize:$PATH
|
||||||
|
|
||||||
# now build pnnx
|
# now build pnnx
|
||||||
cd tools/pnnx
|
cd tools/pnnx
|
||||||
mkdir build
|
mkdir build
|
||||||
cd build
|
cd build
|
||||||
|
cmake ..
|
||||||
make -j4
|
make -j4
|
||||||
export PATH=$PWD/src:$PATH
|
|
||||||
|
|
||||||
./src/pnnx
|
./src/pnnx
|
||||||
|
|
||||||
@ -549,6 +569,9 @@ First, let us install a modified version of ``ncnn``:
|
|||||||
We assume that you have added the path to the binary ``pnnx`` to the
|
We assume that you have added the path to the binary ``pnnx`` to the
|
||||||
environment variable ``PATH``.
|
environment variable ``PATH``.
|
||||||
|
|
||||||
|
We also assume that you have added ``build/tools/quantize`` to the environment
|
||||||
|
variable ``PATH`` so that you are able to use ``ncnn2int8`` later.
|
||||||
|
|
||||||
Second, let us export the model using ``torch.jit.trace()`` that is suitable
|
Second, let us export the model using ``torch.jit.trace()`` that is suitable
|
||||||
for ``pnnx``:
|
for ``pnnx``:
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user