A bunch of doc issues
-
[ ]
TransformerDecoder.forward: where doesself.trainingcome from? https://github.com/asyml/texar-pytorch/blob/d17d502b50da1d95cb70435ed21c6603370ce76d/texar/torch/modules/decoders/transformer_decoders.py#L448-L449 -
[ ] All arguments should say their types explicitly in the docstring. E.g., what is the type of
infer_mode? The method signature is too dense to read for the type https://github.com/asyml/texar-pytorch/blob/d17d502b50da1d95cb70435ed21c6603370ce76d/texar/torch/modules/decoders/transformer_decoders.py#L448-L449 -
[ ]
TransformerDecoder.forward:start_tokensandend_tokenare mentioned but they are not explained in the argument docstring, and there is not explicit pointer that tells users where they can find the explanation. https://github.com/asyml/texar-pytorch/blob/d17d502b50da1d95cb70435ed21c6603370ce76d/texar/torch/modules/decoders/transformer_decoders.py#L353 -
[ ]
RNNDecoderBase.forward: An ordinary user (not developer) does not need to knowdynamic_decode. It's confusing sayPlease refer to ..here. Say explicitly that it's needed only when one wants to over-writeforward.. Also, we are using our own dynamic_decode -- should refer to here instead oftf.contrib.seq2seq.dynamic_decodehttps://github.com/asyml/texar-pytorch/blob/d17d502b50da1d95cb70435ed21c6603370ce76d/texar/torch/modules/decoders/rnn_decoder_base.py#L104-L107 -
[ ]
XLNetDecoder.forward: Isoutputjust a list of sampled tokens orXLNetDecoderOutput? https://github.com/asyml/texar-pytorch/blob/d17d502b50da1d95cb70435ed21c6603370ce76d/texar/torch/modules/decoders/xlnet_decoder.py#L318-L320 -
[ ]
"helper"should be"helper_type"https://github.com/asyml/texar-pytorch/blob/d17d502b50da1d95cb70435ed21c6603370ce76d/texar/torch/modules/decoders/xlnet_decoder.py#L313-L314
- [ ]
DecoderBaseshould be exposed in readthedocs, cuz a few important methods in it are used by users, like: https://github.com/asyml/texar-pytorch/blob/d17d502b50da1d95cb70435ed21c6603370ce76d/texar/torch/modules/decoders/decoder_base.py#L144-L150