Make Wikipedia corpus metadata accessible #3007
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Let the users have metadata (e.g. title) if they need it. Added an argument in WikiCorpus __init__() to specify if metadata is needed. Previously, it was set to False and could not be toggled.
Make Wikipedia corpus metadata accessible.
Allow users to access metadata by allowing self.metadata in WikiCorpus to be set by a parameter. However, Dictionary() raises "TypeError: decoding to str: need a bytes-like object, list found" if metadata is returned. So, introduced a dictionary_mode parameter in get_texts() so that metadata bypasses the dictionary, and goes directly to the user.
piskvorky
requested changes
Nov 26, 2020
gensim/corpora/wikicorpus.py
Outdated
| @@ -612,6 +613,8 @@ def __init__(self, fname, processes=None, lemmatize=utils.has_pattern(), diction | |||
| If set, each XML article element will be passed to this callable before being processed. Only articles | |||
| where the callable returns an XML element are processed, returning None allows filtering out | |||
| some articles based on customised rules. | |||
| metadata: bool, optional | |||
| if True - write article titles to corpus | |||
There was a problem hiding this comment.
What "corpus"? Please make the docstring more explicit, less cryptic (and properly capitalized and punctuated, like the others).
There was a problem hiding this comment.
You can edit PRs in place – no need to open a new PR for each change.
There was a problem hiding this comment.
Thanks for being patient with my first PR (ever!).
Updated documentation. Updated PR description.
"What "corpus"? Please make the docstring more explicit, less cryptic (and properly capitalized and punctuated, like the others)."
- Updated documentation (copied an existing comment describing 'metadata' parameter).
mpenkov
reviewed
Jun 29, 2021
|
@kumar-neelabh Can you please add some tests for your new functionality? |
mpenkov
added
the
stale
mpenkov
moved this from Needs work before merge
to Handle after next release
in PR triage 2021-06
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background: I'd like article text along with the title for my project. The current implementation provides no way for the users to retrieve the title (i.e. metadata).
Allow users to access metadata by allowing self.metadata in WikiCorpus to be set by a parameter. However, Dictionary() raises "TypeError: decoding to str: need a bytes-like object, list found" if metadata is returned by get_texts(). So, introduced a dictionary_mode parameter in get_texts() so that metadata bypasses the dictionary, and goes directly to the user (if user sets metadata = True).