class documentation

Corpus reader designed to work with corpus created by IPI PAN. See http://korpus.pl/en/ for more details about IPI PAN corpus.

The corpus includes information about text domain, channel and categories. You can access possible values using domains(), channels() and categories(). You can use also this metadata to filter files, e.g.: fileids(channel='prasa'), fileids(categories='publicystyczny').

The reader supports methods: words, sents, paras and their tagged versions. You can get part of speech instead of full tag by giving "simplify_tags=True" parameter, e.g.: tagged_sents(simplify_tags=True).

Also you can get all tags disambiguated tags specifying parameter "one_tag=False", e.g.: tagged_paras(one_tag=False).

You can get all tags that were assigned by a morphological analyzer specifying parameter "disamb_only=False", e.g. tagged_words(disamb_only=False).

The IPIPAN Corpus contains tags indicating if there is a space between two tokens. To add special "no space" markers, you should specify parameter "append_no_space=True", e.g. tagged_words(append_no_space=True). As a result in place where there should be no space between two tokens new pair ('', 'no-space') will be inserted (for tagged data) and just '' for methods without tags.

The corpus reader can also try to append spaces between words. To enable this option, specify parameter "append_space=True", e.g. words(append_space=True). As a result either ' ' or (' ', 'space') will be inserted between tokens.

By default, xml entities like " and & are replaced by corresponding characters. You can turn off this feature, specifying parameter "replace_xmlentities=False", e.g. words(replace_xmlentities=False).

Method __init__ No summary
Method categories Undocumented
Method channels Undocumented
Method domains Undocumented
Method fileids Return a list of file identifiers for the fileids that make up this corpus.
Method paras Undocumented
Method raw Undocumented
Method sents Undocumented
Method tagged_paras Undocumented
Method tagged_sents Undocumented
Method tagged_words Undocumented
Method words Undocumented
Method _get_tag Undocumented
Method _list_header_files Undocumented
Method _list_morph_files Undocumented
Method _list_morph_files_by Undocumented
Method _map_category Undocumented
Method _parse_header Undocumented
Method _view Undocumented

Inherited from CorpusReader:

Method __repr__ Undocumented
Method abspath Return the absolute path for the given file.
Method abspaths Return a list of the absolute paths for all fileids in this corpus; or for the given list of fileids, if specified.
Method citation Return the contents of the corpus citation.bib file, if it exists.
Method encoding Return the unicode encoding for the given corpus file, if known. If the encoding is unknown, or if the given file should be processed using byte strings (str), then return None.
Method ensure_loaded Load this corpus (if it has not already been loaded). This is used by LazyCorpusLoader as a simple method that can be used to make sure a corpus is loaded -- e.g., in case a user wants to do help(some_corpus).
Method license Return the contents of the corpus LICENSE file, if it exists.
Method open Return an open stream that can be used to read the given file. If the file's encoding is not None, then the stream will automatically decode the file's contents into unicode.
Method readme Return the contents of the corpus README file, if it exists.
Class Variable root Undocumented
Method _get_root Undocumented
Instance Variable _encoding The default unicode encoding for the fileids that make up this corpus. If encoding is None, then the file contents are processed using byte strings.
Instance Variable _fileids A list of the relative paths for the fileids that make up this corpus.
Instance Variable _root The root directory for this corpus.
Instance Variable _tagset Undocumented
def __init__(self, root, fileids): (source)
Parameters
root:PathPointer or strA path pointer identifying the root directory for this corpus. If a string is specified, then it will be converted to a PathPointer automatically.
fileidsA list of the files that make up this corpus. This list can either be specified explicitly, as a list of strings; or implicitly, as a regular expression over file paths. The absolute path for each file will be constructed by joining the reader's root to each file name.
encoding

The default unicode encoding for the files that make up the corpus. The value of encoding can be any of the following: - A string: encoding is the encoding name for all files. - A dictionary: encoding[file_id] is the encoding

name for the file whose identifier is file_id. If file_id is not in encoding, then the file contents will be processed using non-unicode byte strings.
  • A list: encoding should be a list of (regexp, encoding) tuples. The encoding for a file whose identifier is file_id will be the encoding value for the first tuple whose regexp matches the file_id. If no tuple's regexp matches the file_id, the file contents will be processed using non-unicode byte strings.
  • None: the file contents of all files will be processed using non-unicode byte strings.
tagsetThe name of the tagset used by this corpus, to be used for normalizing or converting the POS tags returned by the tagged_...() methods.
def categories(self, fileids=None): (source)

Undocumented

def channels(self, fileids=None): (source)

Undocumented

def domains(self, fileids=None): (source)

Undocumented

def fileids(self, channels=None, domains=None, categories=None): (source)

Return a list of file identifiers for the fileids that make up this corpus.

@_parse_args
def paras(self, fileids=None, **kwargs): (source)

Undocumented

def raw(self, fileids=None): (source)

Undocumented

@_parse_args
def sents(self, fileids=None, **kwargs): (source)

Undocumented

@_parse_args
def tagged_paras(self, fileids=None, **kwargs): (source)

Undocumented

@_parse_args
def tagged_sents(self, fileids=None, **kwargs): (source)

Undocumented

@_parse_args
def tagged_words(self, fileids=None, **kwargs): (source)

Undocumented

@_parse_args
def words(self, fileids=None, **kwargs): (source)

Undocumented

def _get_tag(self, f, tag): (source)

Undocumented

def _list_header_files(self, fileids): (source)

Undocumented

def _list_morph_files(self, fileids): (source)

Undocumented

def _list_morph_files_by(self, tag, values, map=None): (source)

Undocumented

def _map_category(self, cat): (source)

Undocumented

def _parse_header(self, fileids, tag): (source)

Undocumented

def _view(self, filename, **kwargs): (source)

Undocumented