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

NFA docs: update READMEs and links, add docs page #7219

Merged
merged 3 commits into from
Aug 12, 2023
Merged

NFA docs: update READMEs and links, add docs page #7219

merged 3 commits into from
Aug 12, 2023

Conversation

erastorgueva-nv
Copy link
Collaborator

@erastorgueva-nv erastorgueva-nv commented Aug 12, 2023

What does this PR do ?

Update documentation for NFA.

Collection: tools/nemo_forced_aligner

Changelog

  • Update NeMo README
  • Update NFA README - add links to new materials, move most info to new NFA docs page
  • Update links to NFA tutorials

Usage

N/A

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • [ N/A ] Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • [ N/A ] 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)

titu1994
titu1994 previously approved these changes Aug 12, 2023
Copy link
Collaborator

@titu1994 titu1994 left a comment

Choose a reason for hiding this comment

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

Looks great, minor comments

docs/source/tools/nemo_forced_aligner.rst Outdated Show resolved Hide resolved
docs/source/tools/nemo_forced_aligner.rst Outdated Show resolved Hide resolved
docs/source/tools/nemo_forced_aligner.rst Show resolved Hide resolved
tools/nemo_forced_aligner/README.md Outdated Show resolved Hide resolved
Signed-off-by: Elena Rastorgueva <[email protected]>
Copy link
Collaborator

@titu1994 titu1994 left a comment

Choose a reason for hiding this comment

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

Thanks !

@titu1994 titu1994 merged commit 6f6d70c into main Aug 12, 2023
@titu1994 titu1994 deleted the nfa_docs branch August 12, 2023 02:21
guyueh1 pushed a commit to guyueh1/NeMo that referenced this pull request Aug 14, 2023
* move some of NFA readme to new NFA docs page and add various links

Signed-off-by: Elena Rastorgueva <[email protected]>

* address code review comments

Signed-off-by: Elena Rastorgueva <[email protected]>

---------

Signed-off-by: Elena Rastorgueva <[email protected]>
dorotat-nv pushed a commit to dorotat-nv/NeMo that referenced this pull request Aug 24, 2023
* move some of NFA readme to new NFA docs page and add various links

Signed-off-by: Elena Rastorgueva <[email protected]>

* address code review comments

Signed-off-by: Elena Rastorgueva <[email protected]>

---------

Signed-off-by: Elena Rastorgueva <[email protected]>
Signed-off-by: dorotat <[email protected]>
rohitrango pushed a commit to rohitrango/NeMo that referenced this pull request Jun 25, 2024
* move some of NFA readme to new NFA docs page and add various links

Signed-off-by: Elena Rastorgueva <[email protected]>

* address code review comments

Signed-off-by: Elena Rastorgueva <[email protected]>

---------

Signed-off-by: Elena Rastorgueva <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants