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

Tidy up KeyedVectors.most_similar() API #3000

Merged
merged 14 commits into from
Aug 13, 2021
Merged

Tidy up KeyedVectors.most_similar() API #3000

Changes from 5 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
b4915c0
Allow supplying a string-key as the negative arg. to most_similar()
simonwiles Nov 17, 2020
ace8321
Allow a single vector as a positive or negative arg. to most_similar()
simonwiles Nov 17, 2020
15bfd1b
Update comments
simonwiles Nov 17, 2020
475b013
Accept single arguments when positive and negative are both supplied
simonwiles Nov 17, 2020
571cff9
Update most_similar_cosmul to match most_similar
simonwiles Nov 17, 2020
647a2eb
minor code cleanup
mpenkov Jul 23, 2021
54b6709
add unit tests
mpenkov Jul 23, 2021
28dd3ea
Merge branch 'develop' into fix/2998
mpenkov Jul 23, 2021
d67f225
Update CHANGELOG.md
mpenkov Jul 23, 2021
bec3c7f
remove redundant variable declaration
mpenkov Jul 23, 2021
80364cf
enforce consistency
mpenkov Jul 23, 2021
498bbcc
respond to review feedback
mpenkov Aug 12, 2021
40f7b3c
Merge remote-tracking branch 'upstream/develop' into fix/2998
mpenkov Aug 12, 2021
6ead381
Update keyedvectors.py
mpenkov Aug 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions gensim/models/keyedvectors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,10 +742,14 @@ def most_similar(
clip_start = 0
clip_end = restrict_vocab

if isinstance(positive, KEY_TYPES) and not negative:
# allow calls like most_similar('dog'), as a shorthand for most_similar(['dog'])
if isinstance(positive, KEY_TYPES + (ndarray,)):
# allow passing a single string-key or vector for the positive argument
piskvorky marked this conversation as resolved.
Show resolved Hide resolved
positive = [positive]

if isinstance(negative, KEY_TYPES + (ndarray,)):
# allow passing a single string-key or vector for the negative argument
negative = [negative]

# add weights for each key, if not already present; default to 1.0 for positive and -1.0 for negative keys
positive = [
(item, 1.0) if isinstance(item, KEY_TYPES + (ndarray,))
Expand Down Expand Up @@ -985,10 +989,14 @@ def most_similar_cosmul(self, positive=None, negative=None, topn=10):

self.fill_norms()

if isinstance(positive, str) and not negative:
# allow calls like most_similar_cosmul('dog'), as a shorthand for most_similar_cosmul(['dog'])
if isinstance(positive, KEY_TYPES + (ndarray,)):
# allow passing a single string-key or vector for the positive argument
positive = [positive]

if isinstance(negative, KEY_TYPES + (ndarray,)):
mpenkov marked this conversation as resolved.
Show resolved Hide resolved
# allow passing a single string-key or vector for the negative argument
negative = [negative]

all_words = {
self.get_index(word) for word in positive + negative
if not isinstance(word, ndarray) and word in self.key_to_index
Expand Down