nlp-recipes icon indicating copy to clipboard operation
nlp-recipes copied to clipboard

[ASK] Review the ReadMe for Repo_metrics readme under Tools

Open heatherbshapiro opened this issue 5 years ago • 0 comments

Description

There is a readme for the repo metrics subfolder under tools. It needs general review to make sure it is accurate.

Other Comments

Principles of NLP Documentation Each landing page at the folder level should have a ReadMe which explains - ○ Summary of what this folder offers. ○ Why and how it benefits users ○ As applicable - Documentation of using it, brief description etc Scenarios folder: ○ Root Scenario folder should have a summary on what value these example notebook provides. ○ Include a table with scenario name, description, algorithm, Dataset ○ Other instructions, Pre-req of running these notebooks ○ Each scenario folder should have a summary text explaining about the scenario, what utils its using. Any benchmark numbers if applicable. Explain any concept relevant to the scenario Example Notebooks Guiding Principles: ○ We are providing recipes for solving NLP scenarios on Azure AI ○ We make it easier by providing Util packages ○ We provide example notebooks on how to use the utils for solving common NLP scenarios ○ Based on these principles above, all notebook examples should be using utils wherever applicable. Ex: If your example is doing classification using BERT, use the BERTSequenceClassifier instead of directly calling BertForSequenceClassification. Same with tokenization.

heatherbshapiro avatar Aug 14 '19 02:08 heatherbshapiro