update readme

pull/908/head
Hui Zhang 3 years ago
parent b079577e08
commit 6e9a230f04

@ -9,7 +9,7 @@
## Features
See [feature list](docs/source/feature_list.md) for more information.
See [feature list](docs/source/asr/feature_list.md) for more information.
## Setup
@ -18,20 +18,20 @@ All tested under:
* python>=3.7
* paddlepaddle==2.1.2
Please see [install](docs/source/install.md).
Please see [install](docs/source/asr/install.md).
## Getting Started
Please see [Getting Started](docs/source/getting_started.md) and [tiny egs](examples/tiny/s0/README.md).
Please see [Getting Started](docs/source/asr/getting_started.md) and [tiny egs](examples/tiny/s0/README.md).
## More Information
* [Data Prepration](docs/source/data_preparation.md)
* [Data Augmentation](docs/source/augmentation.md)
* [Ngram LM](docs/source/ngram_lm.md)
* [Benchmark](docs/source/benchmark.md)
* [Relased Model](docs/source/released_model.md)
* [Data Prepration](docs/source/asr/data_preparation.md)
* [Data Augmentation](docs/source/asr/augmentation.md)
* [Ngram LM](docs/source/asr/ngram_lm.md)
* [Benchmark](docs/source/asr/benchmark.md)
* [Relased Model](docs/source/asr/released_model.md)
## Questions and Help
@ -45,4 +45,4 @@ DeepSpeech is provided under the [Apache-2.0 License](./LICENSE).
## Acknowledgement
We depends on many open source repos. See [References](docs/source/reference.md) for more information.
We depends on many open source repos. See [References](docs/source/asr/reference.md) for more information.

@ -1,7 +1,7 @@
Welcome to paddle Deepspeech documentation !
==============================================
**Deepspeech** is a ASR library implemented by paddlepaddle.
**Deepspeech** is a Speech toolkits implemented by paddlepaddle.
Contents
@ -11,37 +11,37 @@ Contents
:maxdepth: 1
:caption: Introduction
deepspeech_architecture
asr/deepspeech_architecture
.. toctree::
:maxdepth: 1
:caption: Getting_started
install
getting_started
asr/install
asr/getting_started
.. toctree::
:maxdepth: 1
:caption: More Information
data_preparation
augmentation
feature_list
ngram_lm
asr/data_preparation
asr/augmentation
asr/feature_list
asr/ngram_lm
.. toctree::
:maxdepth: 1
:caption: Released_model
released_model
asr/released_model
.. toctree::
:maxdepth: 1
:caption: Acknowledgement
reference
asr/reference

Loading…
Cancel
Save