Corrected documentation
Some default values were wrong or not present in the documentation.
@@ -60,7 +60,7 @@ class Elmo(torch.nn.Module):
Should we apply layer normalization (passed to ``ScalarMix``)?
dropout : ``float``, optional, (default = 0.5).
The dropout to be applied to the ELMo representations.
- vocab_to_cache : ``List[str]``, optional, (default = 0.5).
+ vocab_to_cache : ``List[str]``, optional, (default = None).
A list of words to pre-compute and cache character convolutions
for. If you use this option, Elmo expects that you pass word
indices of shape (batch_size, timesteps) to forward, instead
@@ -274,7 +274,7 @@ class _ElmoCharacterEncoder(torch.nn.Module):
ELMo JSON options file
weight_file : ``str``
ELMo hdf5 weight file
- requires_grad: ``bool``, optional
+ requires_grad: ``bool``, optional, (default = False).
If True, compute gradient of ELMo parameters for fine tuning.
The relevant section of the options file is something like:
@@ -503,9 +503,9 @@ class _ElmoBiLm(torch.nn.Module):
ELMo JSON options file
weight_file : ``str``
ELMo hdf5 weight file
- requires_grad: ``bool``, optional
+ requires_grad: ``bool``, optional, (default = False).
If True, compute gradient of ELMo parameters for fine tuning.
- vocab_to_cache : ``List[str]``, optional, (default = 0.5).
+ vocab_to_cache : ``List[str]``, optional, (default = None).
A list of words to pre-compute and cache character convolutions
for. If you use this option, _ElmoBiLm expects that you pass word
indices of shape (batch_size, timesteps) to forward, instead
