Documentation

Current documentation in README explains how to install the toolkit and how to run examples. However, I don’t think this is enough for users who want to make some changes to the existing recipes or make their own new recipe. In that case, one needs to understand what run.sh does step by step, but I think docs for that are missing at the moment. It would be great if we provide documentation for:

• Data format used in the espnet. How data.json is structured?
• Core command line tools: https://github.com/espnet/espnet/tree/master/espnet/bin. What is the input and output format?
• Utility tools https://github.com/espnet/espnet/tree/master/utils. Looks like there are many tools but when should I use them?
• espnet python packages https://github.com/espnet/espnet/tree/master/espnet (ref https://github.com/espnet/espnet/issues/57) I can see very limited docs on https://espnet.github.io/espnet/.

I think docs for the above items (and possibly more) help users get started to hack the toolkit.

EDIT: I meant new users or developers except for the current core developers.

[ShigekiKarita]

Item 1 is done. Now the ci/doc.sh script generates all the modules under espnet and tools under espnet/bin and utils automatically.

See updated master doc https://espnet.github.io/espnet/

[sw005320]

Today, I, @ShigekiKarita, and @kan-bayashi discussed this issue.

1. We’ll automatically generate the class, binary, and utils/*.{sh.py} descriptions, and update them to our webpage.

2. We’ll add some descriptions by basically following @kamo-naoyuki’s suggestions using Jupyter notebook, constantly (at least data structure, main loop etc.)

We are now working on 1.