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.

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

Update keyedvectors.py #3311

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from
Open

Conversation

annagiabelli
Copy link

Following the discussion in the Gensim google group at https://groups.google.com/u/1/g/gensim/c/gCJK7-2QwRw, here is my suggestion for modifying the first part of the explanation of the function evaluate_word_pairs(). Thank you!

Following the discussion in the Gensim google group at https://groups.google.com/u/1/g/gensim/c/gCJK7-2QwRw, here is my suggestion for modifying the first part of the explanation of the function evaluate_word_pairs(). Thank you!
@piskvorky piskvorky mentioned this pull request Mar 23, 2022
@piskvorky piskvorky added feature Issue described a new feature documentation Current issue related to documentation labels Mar 23, 2022
@annagiabelli
Copy link
Author

Hi, do I need to make any changes for it to get approved? Thank you!

Copy link
Owner

@piskvorky piskvorky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you post a screenshot of the rendered HTML for evaluate_word_pairs? Because looking at the code, the formatting looks wild. Thanks.

"""Compute correlation of the model with human similarity judgments.
"""Compute correlation of the model with human annotated or taxonomy‐based semantic similarity measures.
More information on the evaluation of word embeddings through gold benchmark similarity data
can be found at * https://link.springer.com/article/10.1007/s12559-021-09987-7.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does the * do?

See `test/test_data/wordsim353.tsv` as example of human similarity judgments,
and test/test_data/HSS4570.tsv as an example of taxonomy‐based semantic similarity.
What you should use and why:
- human similarity judgments:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a nested list, with several nested :?

What you should use and why:
- human similarity judgments:
`why`: they are the most used benchmarks in word embedding evaluation.
`why not`:
Copy link
Owner

@piskvorky piskvorky Nov 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why literal formatting for this list heading?

@annagiabelli
Copy link
Author

annagiabelli commented Nov 3, 2022

Can you post a screenshot of the rendered HTML for evaluate_word_pairs? Because looking at the code, the formatting looks wild. Thanks.

You are right, there are too many nested lists for it to be clear. I modified it to leave the parameters section clean and to add after the returns section another section explaining when to use the human similarity judgments and the taxonomy‐based semantic similarity measures with a nested list of why and why not for each.

I will attach a screenshot of the rendered HTML for the section "What you should use and why" that should be added after the "Returns" section:

html_out

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Current issue related to documentation feature Issue described a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants