Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention Icefall and ESPnet colab notebook in documentation as examples of use #384

Merged
merged 2 commits into from
Aug 23, 2021
Merged

Mention Icefall and ESPnet colab notebook in documentation as examples of use #384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f649b7
Mention Icefall and ESPnet colab notebook in documentation as example…
pzelasko Aug 23, 2021
ca93e82
Fix lists in docss
pzelasko Aug 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ Lhotse is a Python library aiming to make speech and audio data preparation flex
- Flexible data preparation for model training with the notion of **audio cuts**.
- **Efficiency**, especially in terms of I/O bandwidth and storage capacity.

### Examples of use

Check out the following links to see how Lhotse is being put to use:
- [Icefall recipes](https://github.com/k2-fsa/icefall): where k2 and Lhotse meet.
- Minima ESPnet+Lhotse example: [![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1HKSYPsWx_HoCdrnLpaPdYj5zwlPsM3NH)

### Main ideas

Like Kaldi, Lhotse provides standard data preparation recipes, but extends that with a seamless PyTorch integration
Expand Down
24 changes: 18 additions & 6 deletions docs/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,23 @@ About
Main goals
**********

- Attract a wider community to speech processing tasks with a **Python-centric design**.
- Accommodate experienced Kaldi users with an **expressive command-line interface**.
- Provide **standard data preparation recipes** for commonly used corpora.
- Provide **PyTorch Dataset classes** for speech and audio related tasks.
- Flexible data preparation for model training with the notion of **audio cuts**.
- **Efficiency**, especially in terms of I/O bandwidth and storage capacity.
* Attract a wider community to speech processing tasks with a **Python-centric design**.
* Accommodate experienced Kaldi users with an **expressive command-line interface**.
* Provide **standard data preparation recipes** for commonly used corpora.
* Provide **PyTorch Dataset classes** for speech and audio related tasks.
* Flexible data preparation for model training with the notion of **audio cuts**.
* **Efficiency**, especially in terms of I/O bandwidth and storage capacity.

Examples of use
***************

Check out the following links to see how Lhotse is being put to use:

* `Icefall recipes`_: where k2 and Lhotse meet.
* Minima ESPnet+Lhotse example: |yesno colab notebook|

.. |yesno colab notebook| image:: https://colab.research.google.com/assets/colab-badge.svg
:target: https://colab.research.google.com/drive/1HKSYPsWx_HoCdrnLpaPdYj5zwlPsM3NH

Main ideas
**********
Expand Down Expand Up @@ -117,3 +128,4 @@ the speech starts roughly at the first second (100 frames):

.. _k2: https://github.com/kaldi-asr/kaldi
.. _Kaldi: https://github.com/kaldi-asr/kaldi
.. _Icefall recipes: https://github.com/k2-fsa/icefall