-
Notifications
You must be signed in to change notification settings - Fork 111
A bunch of doc issues #259
Copy link
Copy link
Open
Labels
priority: highHigh priority, should be address immediatelyHigh priority, should be address immediatelytopic: docsIssue about docstrings and documentationIssue about docstrings and documentation
Description
Activity
Metadata
Metadata
Labels
priority: highHigh priority, should be address immediatelyHigh priority, should be address immediatelytopic: docsIssue about docstrings and documentationIssue about docstrings and documentation
TransformerDecoder.forward: where doesself.trainingcome from?texar-pytorch/texar/torch/modules/decoders/transformer_decoders.py
Lines 448 to 449 in d17d502
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 typetexar-pytorch/texar/torch/modules/decoders/transformer_decoders.py
Lines 448 to 449 in d17d502
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.texar-pytorch/texar/torch/modules/decoders/transformer_decoders.py
Line 353 in d17d502
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_decodetexar-pytorch/texar/torch/modules/decoders/rnn_decoder_base.py
Lines 104 to 107 in d17d502
XLNetDecoder.forward: Isoutputjust a list of sampled tokens orXLNetDecoderOutput?texar-pytorch/texar/torch/modules/decoders/xlnet_decoder.py
Lines 318 to 320 in d17d502
"helper"should be"helper_type"texar-pytorch/texar/torch/modules/decoders/xlnet_decoder.py
Lines 313 to 314 in d17d502