WMD docstring: add tutorial link and query example (#813)

piskvorky · Aug 4, 2016 · 6613f05 · 6613f05
1 parent 35bad8b
commit 6613f05
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/gensim/similarities/docsim.py b/gensim/similarities/docsim.py
@@ -568,11 +568,13 @@ class WmdSimilarity(interfaces.SimilarityABC):
     .. Matt Kusner et al. "From Word Embeddings To Document Distances".
 
     Example:
+        # See Tutorial Notebook for more examples https://github.com/RaRe-Technologies/gensim/blob/develop/docs/notebooks/WMD_tutorial.ipynb
         >>> # Given a document collection "corpus", train word2vec model.
         >>> model = word2vec(corpus)
         >>> instance = WmdSimilarity(corpus, model, num_best=10)
 
         >>> # Make query.
+        >>> query = 'Very good, you should seat outdoor.'
         >>> sims = instance[query]
     """
     def __init__(self, corpus, w2v_model, num_best=None, normalize_w2v_and_replace=True, chunksize=256):