diff --git a/README.md b/README.md index 695af22..7f17950 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ sudo apt-get install libsndfile1 ### Install PaddlePaddle -See [install](https://www.paddlepaddle.org.cn/install/quick) for more details. This repo requires PaddlePaddle **2.0.0.rc1** or above. +See [install](https://www.paddlepaddle.org.cn/install/quick) for more details. This repo requires PaddlePaddle **2.0.0rc1** or above. ### Install Parakeet ```bash diff --git a/docs/source/advanced.rst b/docs/source/advanced.rst index 262efc5..25b7e48 100644 --- a/docs/source/advanced.rst +++ b/docs/source/advanced.rst @@ -2,7 +2,7 @@ Advanced Usage ====================== -This sections covers how to extend parakeet by implementing you own models and +This sections covers how to extend parakeet by implementing your own models and experiments. Guidelines on implementation are also elaborated. Model @@ -90,7 +90,7 @@ practice, we use the dataset and dataloader abstraction. Dataset ^^^^^^^^^^ -Dataset is the representation of a set of examples used for a projet. In most of +Dataset is the representation of a set of examples used by a project. In most of the cases, dataset is a collection of examples. Dataset is an object which has methods below. @@ -135,11 +135,11 @@ of running configuration, we use ``yaml`` configuration files. Also, we want to interact with command line options. Some options that usually change according to running environments is provided by command line arguments. -In addition, we wan to override an option in the config file without editing +In addition, we want to override an option in the config file without editing it. Taking these requirements in to consideration, we use `yacs `_ -as a confi management tool. Other tools like `omegaconf `_ +as a config management tool. Other tools like `omegaconf `_ are also powerful and have similar functions. In each example provided, there is a ``config.py``, where the default config is diff --git a/docs/source/install.rst b/docs/source/install.rst index 5555672..49f2ea3 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -5,7 +5,7 @@ Installation Install PaddlePaddle ------------------------ -Parakeet requires PaddlePaddle as its backend. Not that 2.0.0rc1 or newer versions +Parakeet requires PaddlePaddle as its backend. Note that 2.0.0rc1 or newer versions of paddle is required. Since paddlepaddle has multiple packages depending on the device (cpu or gpu) @@ -40,7 +40,7 @@ Experimemts in parakeet often involve audio and spectrum processing, thus ``librosa`` and ``soundfile`` are required. ``soundfile`` requires a extra C library ``libsndfile``, which is not always handled by pip. -For windows and mac users, ``libsndfile`` is also installed when Installing +For windows and mac users, ``libsndfile`` is also installed when installing ``soundfile`` via pip, but for linux users, installing ``libsndfile`` via system package manager is required. Example commands for popular distributions are listed below.