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

adding lexicon mapping notebook #13

Merged
merged 4 commits into from
Apr 20, 2022

Conversation

vinhngx
Copy link
Contributor

@vinhngx vinhngx commented Apr 19, 2022

Update repo structure. Replacing #5

@vinhngx vinhngx closed this Apr 19, 2022
@vinhngx vinhngx reopened this Apr 19, 2022
@NikhilSrihari
Copy link
Contributor

NikhilSrihari commented Apr 19, 2022

@vinhngx
Some feedback on this tutorial:

  1. Pls remove license info from the topic. This will only be added in the readme.md file now
  2. The tutorial title for other tutorials is as a task-based question. Let us discuss this in today's meeting with Arun
  3. "Extending the vocabulary section", line "pass the extended vocabulary file to the" - Can we hyperlink extended vocabulary to the "How to modify vocabulary file" section?
  4. "Customizing the lexicon" to "Customizing pronunciation with lexicon mapping"
  5. Looks like we assume folks already have an understanding of what Riva build, Riva servicemaker and Riva pipeline before they start this nb - We should either call this out and link them to the right place, so they can learn that first OR provide an overview here

@vinhngx
Copy link
Contributor Author

vinhngx commented Apr 20, 2022

Fixed 1, 4, 5.
For 3 I don't think this file can be linked locally (depending on Riva repo dir which can be either local or in docker volume per config.sh file). We pointed that out.
We give link to an example vocab file on NGC for the EN model though.

  1. Changed title to "How to Customize Riva ASR Vocabulary and Pronunciation with Lexicon Mapping"

For other notebooks, I'd suggest changing "How do I" to simply "How to".
In the industry ppl say "How-to guide", not "How-do-I-guide" ;-)

@NikhilSrihari
Copy link
Contributor

@LynseyFabel @vinhngx
2. On "How do I" vs "How to" - i will let @LynseyFabel comment
3. I think you misunderstood me. I am just asking you to hyperlink the phrase "extended vocabulary" in line "pass the extended vocabulary file to the.." of "Extending the vocabulary" section to the "How to modify vocabulary file" section. They are both in the same notebook. You can link by adding an a tag. Example here

@LynseyFabel
Copy link
Contributor

LynseyFabel commented Apr 20, 2022

If you say "How to" that is not a question and you have a question mark in every title. If you want to ask a question, you need to say "How do I.." or "How do you".. "How to" is a title to an answer. If you want to keep "How to" then you need to remove the question mark from every tutorial. I'm not a fan of a title that starts with "How to" its assumed the user is going to learn how to do something.

@vinhngx
Copy link
Contributor Author

vinhngx commented Apr 20, 2022

I think the "How do I...?" format fits a FAQ doc well, coz you're in fact collecting and answering questions, literally.

For a notebook or tutorial title, it's unnecessarily wordy IMO.
Here we're writing a guide/tutorial, and I think most ppl are familiar with "how-to guide".

If I do a Google search most often I'll do something like "how to customize xxx" rather than "how do I ... " --- could be a personal practice and preference. The difference between "how to" and "how do I" is just a space and a char, but the main reason I don't do the latter is not because I'm trying to save two keystrokes, but because I think it's unnecessary and doesn't really add anything.

@vinhngx
Copy link
Contributor Author

vinhngx commented Apr 20, 2022

"Extending the vocabulary" section to the "How to modify vocabulary file" section. They are both in the same notebook. You can link by adding an a tag. Example here

@NikhilSrihari gotcha. Added.

@NikhilSrihari
Copy link
Contributor

NikhilSrihari commented Apr 20, 2022

@LynseyFabel @vinhngx I think we can continue the discussion on title 👍
But for now, I think we can merge this PR and get QA started

@NikhilSrihari NikhilSrihari merged commit a10976b into dev/22.04 Apr 20, 2022
@blisc blisc deleted the vinhn-lexicon-mapping-tutorial branch February 1, 2023 16:06
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.

3 participants