Sortformer Diarizer 4spk v1 model PR Part 4: Sortformer Documents and Notebook Tutorials

[tango4j]

What does this PR do ?

This PR adds Sortformer documents and tutorial notebooks.

Collection: ASR/speaker_tasks

Changelog

Speaker Diarization documents.
tutorial/speaker_tasks/End_to_end_Diarization_Training.ipynb
tutorial/speaker_tasks/End_to_end_Diarization_Inference.ipynb

Usage

Run tutorial notebooks.

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)

[KunalDhawan]

Thanks @tango4j, looks great, added minor comments

[KunalDhawan]

Should we keep a list of benchmark datasets here and maybe a table showcasing the performance of our models on these sets compared to current SOTA?

[KunalDhawan]

Should we pin to a release version (or maybe add that as a comment) in case the notebook becomes inconsistent with future main?

[KunalDhawan]

Really good and informative tutorial, great work!