Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

the doc of gensim.matutils.kullback_leibler is wrong #1358

Closed
viciousstar opened this issue May 23, 2017 · 5 comments
Closed

the doc of gensim.matutils.kullback_leibler is wrong #1358

viciousstar opened this issue May 23, 2017 · 5 comments

Comments

@viciousstar
Copy link
Contributor

gensim.matutils.kullback_leibler(vec1, vec2, num_features=None)
A distance metric between two probability distributions. Returns a distance value in range <0,1> where values closer to 0 mean less distance (and a higher similarity) Uses the scipy.stats.entropy method to identify kullback_leibler convergence value. If the distribution draws from a certain number of docs, that value must be passed.

it should be
Returns a distance value in range <0,+∞>
@souravsingh
Copy link
Contributor

@viciousstar Can you make a PR regarding the change?

@viciousstar
Copy link
Contributor Author

@souravsingh Sorry I do not know how to fix doc, can you make it?

@menshikh-iv
Copy link
Contributor

@viciousstar You can change docstring here and create PR with this change

@viciousstar
Copy link
Contributor Author

OK, I had create a PR #1373.

@menshikh-iv
Copy link
Contributor

Fixed in #1373

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@souravsingh @viciousstar @menshikh-iv