-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
adding canary docs #11176
base: main
Are you sure you want to change the base?
adding canary docs #11176
Conversation
Signed-off-by: Krishna Puvvada <[email protected]>
@@ -1120,3 +1120,160 @@ Depending on the type of model, there may be extra steps that must be performed | |||
|
|||
* CTC Models - `Examples directory for CTC Models <https://github.com/NVIDIA/NeMo/blob/stable/examples/asr/asr_ctc/README.md>`_ | |||
* RNN Transducer Models - `Examples directory for Transducer Models <https://github.com/NVIDIA/NeMo/blob/stable/examples/asr/asr_transducer/README.md>`_ | |||
|
|||
Multi-task AED Models |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the following information present in the docs:
- What is Canary model
- How to load a canary model and transcribe?
- How to finetune a Canary model to adapt to new languages
- Same languages but new data -> tokenizer update
- Recommended hyper parameters for finetuning
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks like a good start but needs more details for setting up internals
max_duration: 40 | ||
use_bucketing: True | ||
num_buckets: 30 | ||
bucket_duration_bins: [3.79, 4.82, 5.688, ..., 35.827] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Provide info / link to calcualte bucket duration bins (ir just update below sentence to mention that to get the list of floats, follow this link)
Special Tokens Configuration | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
The model uses special tokens for task control and language specification. These can be configured during tokenizer creation or loaded from an existing tokenizer: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we need docs how to construct this special tokenizer (either here or somewhere below and link to that section)
|
||
|
||
Transformer Decoder | ||
~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
~~~~~~~~~~~~~~~~~ | |
~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No picture upload. Upload to latest nemo release and update url
What does this PR do ?
Add a one line overview of what this PR aims to accomplish.
Collection: [ASR]
Changelog
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:
PR Type:
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