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.

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

Update TLT TTS notebooks #73

Merged
merged 4 commits into from
Sep 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The best way to get started with Riva is to start with the tutorials.

## Tutorials
## Tutorials

| Domain | Tutorial | Key Words | Github URL |
|--------|----------|-----------|------------|
Expand All @@ -15,12 +15,12 @@ The best way to get started with Riva is to start with the tutorials.
| ASR | How to pretrain a Riva ASR Language Modeling (n-gram) with TAO Toolkit | ASR, Customization, Language Model pretraining, n-gram, TAO Toolkit | [Riva ASR - Customization - Language Model (n-gram) pretraining with TAO Toolkit](asr-python-advanced-tao-ngram-pretrain.ipynb) |
| ASR | How to fine-tune a Riva ASR Acoustic Model (Citrinet) with TAO Toolkit | ASR, Customization, Acoustic Model fine-tuning, Citrinet, TAO Toolkit | [Riva ASR - Customization - Acoustic Model (Citrinet) fine-tuning with TAO Toolkit](asr-python-advanced-finetune-am-citrinet-tao-finetuning.ipynb) |
| ASR | How to deploy custom Acoustic Model (Citrinet) trained with TAO Toolkit on Riva | ASR, Customization, Acoustic Model deployment, Citrinet | [Riva ASR - Customization - Acoustic Model (Citrinet) deployment on Riva](asr-python-advanced-finetune-am-citrinet-tao-deployment.ipynb) |
| ASR | The Making of RIVA German ASR Service | ASR, New Language Adaptation, German | [Riva ASR - German](New-language-adaptation/German) |
| ASR | The Making of RIVA Hindi ASR Service | ASR, New Language Adaptation, Hindi | [Riva ASR - Hindi](New-language-adaptation/Hindi) |
| ASR | The Making of RIVA Mandarin ASR Service | ASR, New Language Adaptation, Mandarin | [Riva ASR - Mandarin](New-language-adaptation/Mandarin) |
| ASR | The Making of RIVA German ASR Service | ASR, New Language Adaptation, German | [Riva ASR - German](New-language-adaptation/German) |
| ASR | The Making of RIVA Hindi ASR Service | ASR, New Language Adaptation, Hindi | [Riva ASR - Hindi](New-language-adaptation/Hindi) |
| ASR | The Making of RIVA Mandarin ASR Service | ASR, New Language Adaptation, Mandarin | [Riva ASR - Mandarin](New-language-adaptation/Mandarin) |
| TTS | How do I use Riva TTS APIs with out-of-the-box models? | TTS, API Basics | [Riva TTS - API Basics](tts-python-basics.ipynb) |
| TTS | How do I customize Riva TTS audio output with SSML? | TTS, Customization, SSML, Pitch, Rate, Pronunciation | [Riva TTS - Customization - Customization with SSML](tts-python-advanced-customization-with-ssml.ipynb) |
| TTS | How to train Riva TTS models (FastPitch and HiFiGAN) with TAO Toolkit | TTS, Customization, FastPitch, HiFiGAN, Training, TAO Toolkit | [Riva TTS - Customization - FastPitch and HiFiGAN training with TAO Toolkit](tts-python-advanced-pretrain-tts-tao-training.ipynb) |
| TTS | How to train Riva TTS models (FastPitch and HiFiGAN) with TAO Toolkit | TTS, Customization, FastPitch, HiFiGAN, Training, TAO Toolkit | [Riva TTS - Customization - FastPitch and HiFiGAN training with TAO Toolkit](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/tao/resources/texttospeech_notebook/files) |
| TTS | How to Deploy a custom TTS Models (FastPitch and HiFi-GAN) trained with TAO Toolkit Riva | TTS, Customization, FastPitch, HiFiGAN, Deployment | [Riva TTS - Customization - FastPitch and HiFiGAN deployment on Riva](tts-python-advanced-pretrain-tts-tao-deployment.ipynb) |
| Deploy | How to Deploy Riva at Scale on AWS with EKS | Deploy, AWS EKS | [Riva - Deploy - AWS EKS](deploy-eks.md) |

Expand All @@ -30,41 +30,41 @@ The best way to get started with Riva is to start with the tutorials.
This section covers the Requirements and Setup needed to run all Riva Tutorials.

#### Requirements
Before you try running the NVIDIA Riva tutorials, ensure you meet the following requirements:
- [Python 3](https://www.python.org/download/releases/3.0/)
Before you try running the NVIDIA Riva tutorials, ensure you meet the following requirements:
- [Python 3](https://www.python.org/download/releases/3.0/)

#### Setup
1. Clone the NVIDIA Riva tutorials repository.
``git clone https://github.com/nvidia-riva/tutorials.git``
1. Clone the NVIDIA Riva tutorials repository.
``git clone https://github.com/nvidia-riva/tutorials.git``
``cd tutorials``

2. Create a Python virtual environment - We will be using this virtual environment to install all the depencies needed for Riva tutorials.
2. Create a Python virtual environment - We will be using this virtual environment to install all the depencies needed for Riva tutorials.
``python3 -m venv venv-riva-tutorials``

3. Activate the Python virtual environment we just created.
3. Activate the Python virtual environment we just created.
``. venv-riva-tutorials/bin/activate``

4. Install Jupyter notebook.
``pip3 install jupyter``
4. Install Jupyter notebook.
``pip3 install jupyter``

5. Create an IPython kernel - The Riva tutorials Jupyter notebooks will be using this kernel in the next step.
5. Create an IPython kernel - The Riva tutorials Jupyter notebooks will be using this kernel in the next step.
``ipython kernel install --user --name=venv-riva-tutorials``

6. Start the Jupyter notebooks server.
``jupyter notebook --allow-root --port 8888``
If you have a browser installed on your machine, the notebook should automatically open. If you do not have a browser, copy/paste the URL from the command.
6. Start the Jupyter notebooks server.
``jupyter notebook --allow-root --port 8888``
If you have a browser installed on your machine, the notebook should automatically open. If you do not have a browser, copy/paste the URL from the command.
Once you open a Riva tutorial notebook on a browser, choose the `venv-riva-tutorials` kernel by `Kernel` -> `Change kernel` -> `venv-riva-tutorials`

### Running the Riva Client

#### Requirements
Before you try running the Riva client, ensure you meet the following requirements:
Before you try running the Riva client, ensure you meet the following requirements:
- You have access and are logged into NVIDIA NGC. For step-by-step instructions, refer to the [NGC Getting Started Guide](https://docs.nvidia.com/ngc/ngc-overview/index.html#registering-activating-ngc-account).
- [Python 3](https://www.python.org/download/releases/3.0/)
- [Python 3](https://www.python.org/download/releases/3.0/)

#### Setup

1. [Optional] If using the `venv-riva-tutorials` (or another) Python virtual environment, activate it.
1. [Optional] If using the `venv-riva-tutorials` (or another) Python virtual environment, activate it.
``. <Python virtual environment directory location>/venv-riva-tutorials/bin/activate``

2. Install `nvidia-riva-client` using `pip`.
Expand Down
Loading