More detailed method description in recipes

[kehanlu]

Hi,
I found in many recipes, the descriptions did not reveal full methods they used in the recipe. Make it difficult to make reasonable comparison with other toolkits or methods in a glance.

For example, in recipes/AISHELL-1/ASR/transformer, the reported results in both recipes used spec augmentation and rirs noise augmentation to improve the error rates, but did not specify in README.md. Anyone who wants to know what they really do have to read the code and hparams file by themselves.

I suggest that we can design some guide for contributors to report their recipes. For example paper they implemented, augmentation method they used or other detailed config such as kernel size, training epochs etc.

[TParcollet]

@mravanelli what do you think ?

[mravanelli]

Yes, I think we can provide more details in the README file if the users think that this is necessary.

…

On Mon, 30 Aug 2021 at 15:32, Parcollet Titouan ***@***.***> wrote: @mravanelli <https://github.com/mravanelli> what do you think ? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#961 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AEA2ZVTP46FNQ2LRFPVUVEDT7PMFJANCNFSM5C7GQN6A> .

[Adel-Moumen]

Hey,

I think we could create a template for README.md with a section describing the systems.. what do you think?

Best.

[Noel6161131110]

Hey there,

should we edit on the existing readme..😀

[Noel6161131110]

Hey Lets jot down the things to include in the readme template please add your ideas as reply....