search

kaldi-asr / kaldi

kaldi-asr/kaldi is the official location of the Kaldi project.
http://kaldi-asr.org
Other
14.24k stars 5.32k forks source link

Enforce/suggest an LVCSR task creation template #3385

Open vijayaditya opened 5 years ago

vijayaditya commented 5 years ago

I have come across few tasks (e.g. egs/tedlium/) which do not provide a README. This makes it difficult for experimenters to start working on this task. It would be great if we start adding the necessary details in a README for the existing tasks and create an LVCSR task template directory for new tasks to aid reviewers/task-designers. e.g. 

egs/template/
|----->README.md (details of the task, link to the paper if available)
|----->s5/README.md (details of the recipe, compare and contrast with other recipes in this task if necessary)

This issue is created to discuss the template and track any PRs adding READMEs for the existing tasks.

danpovey commented 5 years ago

Makes sense. I'd probably rather just to keep them plain text files (README), since it's always been like that and it will avoid the question of whether to upgrade the old ones. But open to opinions on that.

vijayaditya commented 5 years ago

I didn't see any complex markdown features being used in the existing README.md, so the plain text files might be sufficient.

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.