Docs for word2vec.py forwarding functions and one more #1251
Conversation
|
A lot of new people consider the documentation for gensim to be incomplete or done poorly. This should help fix that for the Word2Vec class. |
| Please refer to the documentation for | ||
| `gensim.models.KeyedVectors.most_similar` | ||
| This is just a forwarding function. | ||
| In the future please use the `gensim.models.KeyedVectors` instance in wv |
There was a problem hiding this comment.
Strange line breaks + docstring a bit obscure. I'm not sure reading this would help me if I didn't already know what it's talking about.
How about simply Deprecated; use self.ww.most_similar() instead.?
Same with all the other "forwarding" functions.
There was a problem hiding this comment.
Hmm, The strange line breaks were added by me in the fix pep8 commit! I'm new to following pep8 all the time, do you think I overdid it there?
Is a depreciated warning to be added to these methods? Will they become unavailable in a later version? If yes, then this should surely be changed asap and I'll send a new PR with the same.
There was a problem hiding this comment.
It's a question for @tmylk , but I think we want to nudge users toward using the new API, yes.
The line breaks are definitely not good, hurts readability.
There was a problem hiding this comment.
Ok, changes made as suggested. #1274
Thanks for the line breaks tip 👍 . Will line break only if comments go excessively above PEP8 standards!
Do you think we should add depreciated warnings to these forwarding functions as well? @gojomo.
Quoting @tmylk for
Word2Vecclass.