Skip to content

Commit

Permalink
Fix doc2vec documentation
Browse files Browse the repository at this point in the history
Fixed descriptions of various arguments passed up to parent Word2Vec __init__ method.
  • Loading branch information
jstol authored Jun 1, 2017
1 parent cc74b66 commit c2636c0
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions gensim/models/doc2vec.py
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@ def __init__(self, documents=None, dm_mean=None,
`window` is the maximum distance between the predicted word and context words used for prediction
within a document.
`alpha` is the initial learning rate (will linearly drop to zero as training progresses).
`alpha` is the initial learning rate (will linearly drop to `min_alpha` as training progresses).
`seed` = for the random number generator.
Note that for a fully deterministically-reproducible run, you must also limit the model to
Expand All @@ -587,10 +587,12 @@ def __init__(self, documents=None, dm_mean=None,
`iter` = number of iterations (epochs) over the corpus. The default inherited from Word2Vec is 5,
but values of 10 or 20 are common in published 'Paragraph Vector' experiments.
`hs` = if 1 (default), hierarchical sampling will be used for model training (else set to 0).
`hs` = if 1, hierarchical softmax will be used for model training.
If set to 0 (default), and `negative` is non-zero, negative sampling will be used.
`negative` = if > 0, negative sampling will be used, the int for negative
specifies how many "noise words" should be drawn (usually between 5-20).
Default is 5. If set to 0, no negative samping is used.
`dm_mean` = if 0 (default), use the sum of the context word vectors. If 1, use the mean.
Only applies when dm is used in non-concatenative mode.
Expand Down

0 comments on commit c2636c0

Please sign in to comment.