Skip to content

[MagpieTTS][Docs] Add magpietts docs#15302

Merged
blisc merged 3 commits intomainfrom
magpietts_doc
Jan 26, 2026
Merged

[MagpieTTS][Docs] Add magpietts docs#15302
blisc merged 3 commits intomainfrom
magpietts_doc

Conversation

@subhankar-ghosh
Copy link
Collaborator

Important

The Update branch button must only be pressed in very rare occassions.
An outdated branch is never blocking the merge of a PR.
Please reach out to the automation team before pressing that button.

What does this PR do ?

Add magpietts docs

Collection: [Note which collection this PR will affect]

Changelog

  • Add specific line by line info of high level changes in this PR.

Usage

Documentation

GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

  • Related to # (issue)

Signed-off-by: subhankar-ghosh <subhankar2321@gmail.com>
@subhankar-ghosh subhankar-ghosh requested a review from blisc January 16, 2026 06:57
@github-actions github-actions bot added the TTS label Jan 16, 2026
@subhankar-ghosh subhankar-ghosh changed the title Add magpietts docs [MagpieTTS][Docs] Add magpietts docs Jan 16, 2026
@subhankar-ghosh subhankar-ghosh added documentation Improvements or additions to documentation Run CICD and removed TTS labels Jan 16, 2026
@github-actions github-actions bot removed the Run CICD label Jan 16, 2026
@github-actions
Copy link
Contributor

[🤖]: Hi @subhankar-ghosh 👋,

We wanted to let you know that a CICD pipeline for this PR just finished successfully.

So it might be time to merge this PR or get some approvals.

//cc @chtruong814 @ko3n1g @pablo-garay @thomasdhc

@blisc blisc requested a review from Copilot January 20, 2026 16:34
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive documentation for Magpie-TTS, a hallucination-free text-to-speech system developed by NVIDIA that uses monotonic alignment techniques to ensure robust speech synthesis.

Changes:

  • Added main Magpie-TTS documentation covering architecture, features, training, and inference
  • Added preference optimization guide detailing DPO and GRPO training approaches
  • Added longform inference guide explaining multi-sentence speech generation

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
docs/source/tts/magpietts.rst Main documentation covering model architecture, key features, training, inference, and resources
docs/source/tts/magpietts-po.rst Detailed guide on preference optimization techniques (DPO and GRPO) for quality improvement
docs/source/tts/magpietts-longform.rst Guide for generating speech from long text inputs with sentence-level chunking
docs/source/tts/intro.rst Updated table of contents to include the three new Magpie-TTS documentation pages

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +75 to +76
Preference Optimization
-----------------------
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have this section or just link to the po doc?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was trying to make this as the one Readme that has all information, and if someone needs more details then they go to the po doc. That was the idea.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should just describe the methods without the code blocks and link to the policy optimization docs for people who want more information

Signed-off-by: subhankar-ghosh <subhankar2321@gmail.com>
@github-actions github-actions bot added the TTS label Jan 22, 2026
@subhankar-ghosh subhankar-ghosh requested a review from blisc January 22, 2026 06:30
@blisc blisc requested review from shehzeen and removed request for blisc January 22, 2026 19:16
@blisc
Copy link
Collaborator

blisc commented Jan 22, 2026

@shehzeen , can you do a pass over the RL docs?

Signed-off-by: Shehzeen Hussain <shehzeensh@gmail.com>
@blisc blisc added the Run CICD label Jan 26, 2026
@blisc blisc enabled auto-merge (squash) January 26, 2026 17:36
@github-actions github-actions bot removed the Run CICD label Jan 26, 2026
@github-actions
Copy link
Contributor

[🤖]: Hi @subhankar-ghosh 👋,

We wanted to let you know that a CICD pipeline for this PR just finished successfully.

So it might be time to merge this PR or get some approvals.

//cc @chtruong814 @ko3n1g @pablo-garay @thomasdhc

@blisc blisc merged commit 3bf62de into main Jan 26, 2026
55 checks passed
@blisc blisc deleted the magpietts_doc branch January 26, 2026 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation TTS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants