Files
nvidia-nemo--speech/docs/source/tts/api.rst
T
wehub-resource-sync ba4be087d5
Create PR to main with cherry-pick from release / cherry-pick (push) Failing after 0s
CICD NeMo / pre-flight (push) Failing after 0s
CICD NeMo / configure (push) Has been skipped
Build, validate, and release Neural Modules / pre-flight (push) Failing after 1s
CICD NeMo / code-linting (push) Has been skipped
Build, validate, and release Neural Modules / release (push) Has been skipped
Build, validate, and release Neural Modules / release-summary (push) Has been cancelled
CICD NeMo / cicd-test-container-build (push) Has been cancelled
CICD NeMo / cicd-import-tests (push) Has been cancelled
CICD NeMo / L0_Setup_Test_Data_And_Models (push) Has been cancelled
CICD NeMo / cicd-main-unit-tests (push) Has been cancelled
CICD NeMo / cicd-main-speech (push) Has been cancelled
CICD NeMo / Nemo_CICD_Test (push) Has been cancelled
CICD NeMo / Coverage (e2e) (push) Has been cancelled
CICD NeMo / Coverage (unit-test) (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
CICD NeMo / cicd-wait-in-queue (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:28:58 +08:00

69 lines
2.2 KiB
ReStructuredText

.. _nemo tts collection api:
NeMo TTS API
============
Model Classes
-------------
MagpieTTS (Codec-based TTS)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
MagpieTTS is an end-to-end TTS model that generates audio codes from transcript and optional context (audio or text). It supports multiple architectures (e.g. multi-encoder context, decoder context) and can be used for standard, long-form, and streaming inference.
.. autoclass:: nemo.collections.tts.models.MagpieTTSModel
:show-inheritance:
:members: infer_batch, do_tts, generate_long_form_speech, list_available_models, audio_to_codes, codes_to_audio, has_baked_context_embedding, num_baked_speakers, get_baked_context_embeddings_batch, create_longform_chunk_state, embed_text, prepare_context_tensors
Mel-Spectrogram Generators
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: nemo.collections.tts.models.FastPitchModel
:show-inheritance:
:members:
:exclude-members: setup_training_data, setup_validation_data, training_step, on_validation_epoch_end, validation_step, setup_test_data, on_train_epoch_start
Vocoders
~~~~~~~~
.. autoclass:: nemo.collections.tts.models.HifiGanModel
:show-inheritance:
:members:
:exclude-members: setup_training_data, setup_validation_data, training_step, on_validation_epoch_end, validation_step, setup_test_data, on_train_epoch_start
Codecs
~~~~~~
.. autoclass:: nemo.collections.tts.models.AudioCodecModel
:show-inheritance:
:members:
:exclude-members: setup_training_data, setup_validation_data, training_step, on_validation_epoch_end, validation_step, setup_test_data, on_train_epoch_start
Base Classes
----------------
The classes below are the base of the TTS pipeline.
.. autoclass:: nemo.collections.tts.models.base.MelToSpec
:show-inheritance:
:members:
.. autoclass:: nemo.collections.tts.models.base.SpectrogramGenerator
:show-inheritance:
:members:
.. autoclass:: nemo.collections.tts.models.base.Vocoder
:show-inheritance:
:members:
Dataset Processing Classes
--------------------------
.. autoclass:: nemo.collections.tts.data.dataset.TTSDataset
:show-inheritance:
:members:
.. autoclass:: nemo.collections.tts.data.dataset.VocoderDataset
:show-inheritance:
:members: