add docs of MultiturnDialog and SentenceClassification - Githubissues

thu-coai / cotk

Conversational Toolkit. An Open-Source Toolkit for Fast Development and Fair Evaluation of Text Generation

Apache License 2.0

128 stars 27 forks source link

add docs of MultiturnDialog and SentenceClassification #438

Closed aaa123git closed 3 years ago

aaa123git commented 4 years ago

add docs of MultiturnDialog and SentenceClassification

**Reference Issues: #425

hzhwcmhf commented 4 years ago

MultiTurnDialog
- fields 这一部分可以不用复制原本fields的文档。只需要解释是这个默认值是什么，传参会覆盖默认值。
- pretrained 这里不用说这么细，但要注明这个只在fields为默认值的时候才有效。部分内容，例如需要使用配套tokenizer，可以使用的值，可以补充到pretrained field的链接里面。
- 缺少example
SwitchBoardCorpus
- 参数没有补全
- 这个需要额外加一个example，因为和MultiturnDialog不一致

hzhwcmhf commented 4 years ago

multi turn dialog我又编辑过了，把sentenceclassification那部分合并一下，尽量维护少的docstring。另外上面提到SwitchBoardCorpus\example的事情都没有搞好