Update README.md

README.md

@@ -5,4 +5,76 @@ tags:
 language:
 - en
 pipeline_tag: text-to-speech
----
+---
+
+# NVIDIA FastPitch Multispeaker (en-US)
+
+FastPitch [1] is a fully-parallel transformer architecture with prosody control over pitch and individual phoneme duration. Additionally, it uses an unsupervised speech-text aligner [2]. See the model architecture section for complete architecture details.
+
+It is also compatible with NVIDIA Riva for production-grade server deployments.
+
+## Usage
+The model is available for use in the NeMo toolkit [3] and can be used as a pre-trained checkpoint for inference or for fine-tuning on another dataset.
+
+To train, fine-tune or play with the model you will need to install NVIDIA NeMo. We recommend you install it after you've installed the latest PyTorch version.
+```
+pip install nemo-toolkit['all']
+```
+
+## instantiate the model
+Note: This model generates only spectrograms and a vocoder is needed to convert the spectrograms to waveforms. In this example HiFiTTS_HiFiGAN is used.
+
+```
+from huggingface_hub import hf_hub_download
+from nemo.collections.tts.models import FastPitchModel
+from nemo.collections.tts.models import HifiGanModel
+
+REPO_ID = "Mastering-Python-HF/nvidia_tts_en_fastpitch_multispeaker"
+FILENAME = "tts_en_fastpitch_multispeaker.nemo"
+path = hf_hub_download(repo_id=REPO_ID, filename=FILENAME)
+
+spec_generator = FastPitchModel.restore_from(restore_path=path)
+
+REPO_ID = "Mastering-Python-HF/nvidia_tts_en_hifitts_hifigan_ft_fastpitch"
+FILENAME = "tts_en_hifitts_hifigan_ft_fastpitch.nemo"
+path = hf_hub_download(repo_id=REPO_ID, filename=FILENAME)
+
+model = HifiGanModel.restore_from(restore_path=path)
+
+```
+
+## Generate and save audio
+
+```
+import soundfile as sf
+parsed = spec_generator.parse("You can type your sentence here to get nemo to produce speech.")
+spectrogram = spec_generator.generate_spectrogram(tokens=parsed,speaker=92)
+audio = model.convert_spectrogram_to_audio(spec=spectrogram)
+sf.write("speech.wav", audio.to('cpu').detach().numpy()[0], 44100)
+```
+
+## Input
+This model accepts batches of text.
+
+## Output
+This model generates mel spectrograms.
+
+## Model Architecture
+FastPitch is a fully-parallel text-to-speech model based on FastSpeech, conditioned on fundamental frequency contours. The model predicts pitch contours during inference. By altering these predictions, the generated speech can be more expressive, better match the semantic of the utterance, and in the end more engaging to the listener. FastPitch is based on a fully-parallel Transformer architecture, with a much higher real-time factor than Tacotron2 for the mel-spectrogram synthesis of a typical utterance. It uses an unsupervised speech-text aligner.
+
+## Training
+The NeMo toolkit [3] was used for training the models for 1000 epochs. These model are trained with this example script and this base config.
+
+## Datasets
+This model is trained on LJSpeech sampled at 22050Hz, and has been tested on generating female English voices with an American accent.
+
+## Performance
+No performance information is available at this time.
+
+## Limitations
+This checkpoint only works well with vocoders that were trained on 22050Hz data. Otherwise, the generated audio may be scratchy or choppy-sounding.
+
+## References
+    -[1] FastPitch: Parallel Text-to-speech with Pitch Prediction
+    -[2] One TTS Alignment To Rule Them All
+    -[3] NVIDIA NeMo Toolkit