nltk.corpus.reader.ConllCorpusReader

class documentation

class ConllCorpusReader(CorpusReader): (source)

Known subclasses: nltk.corpus.reader.ConllChunkCorpusReader

Constructor: ConllCorpusReader(root, fileids, columntypes, chunk_types, ...)

A corpus reader for CoNLL-style files. These files consist of a series of sentences, separated by blank lines. Each sentence is encoded using a table (or "grid") of values, where each line corresponds to a single word, and each column corresponds to an annotation type. The set of columns used by CoNLL-style files can vary from corpus to corpus; the ConllCorpusReader constructor therefore takes an argument, columntypes, which is used to specify the columns that are used by a given corpus. By default columns are split by consecutive whitespaces, with the separator argument you can set a string to split by (e.g. ' ').

@todo: Add support for reading from corpora where different: parallel files contain different columns.
@todo: Possibly add caching of the grid corpus view? This would: allow the same grid view to be used by different data access methods (eg words() and parsed_sents() could both share the same grid corpus view object).
@todo: Better support for -DOCSTART-. Currently, we just ignore: it, but it could be used to define methods that retrieve a document at a time (eg parsed_documents()).

Method	`__init__`	No summary
Method	`chunked_sents`	Undocumented
Method	`chunked_words`	Undocumented
Method	`iob_sents`	No summary
Method	`iob_words`	No summary
Method	`parsed_sents`	Undocumented
Method	`raw`	Undocumented
Method	`sents`	Undocumented
Method	`srl_instances`	Undocumented
Method	`srl_spans`	Undocumented
Method	`tagged_sents`	Undocumented
Method	`tagged_words`	Undocumented
Method	`words`	Undocumented
Constant	`CHUNK`	Undocumented
Constant	`COLUMN_TYPES`	Undocumented
Constant	`IGNORE`	Undocumented
Constant	`NE`	Undocumented
Constant	`POS`	Undocumented
Constant	`SRL`	Undocumented
Constant	`TREE`	Undocumented
Constant	`WORDS`	Undocumented
Instance Variable	`sep`	Undocumented
Static Method	`_get_column`	Undocumented
Method	`_get_chunked_words`	Undocumented
Method	`_get_iob_words`	Undocumented
Method	`_get_parsed_sent`	Undocumented
Method	`_get_srl_instances`	Undocumented
Method	`_get_srl_spans`	list of list of (start, end), tag) tuples
Method	`_get_tagged_words`	Undocumented
Method	`_get_words`	Undocumented
Method	`_grids`	Undocumented
Method	`_read_grid_block`	Undocumented
Method	`_require`	Undocumented
Instance Variable	`_chunk_types`	Undocumented
Instance Variable	`_colmap`	Undocumented
Instance Variable	`_pos_in_tree`	Undocumented
Instance Variable	`_root_label`	Undocumented
Instance Variable	`_srl_includes_roleset`	Undocumented
Instance Variable	`_tagset`	Undocumented
Instance Variable	`_tree_class`	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	`fileids`	Return a list of file identifiers for the fileids that make up this 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.

def __init__(self, root, fileids, columntypes, chunk_types=None, root_label='S', pos_in_tree=False, srl_includes_roleset=True, encoding='utf8', tree_class=Tree, tagset=None, separator=None): (source) ¶

overrides nltk.corpus.reader.CorpusReader.__init__

overridden in nltk.corpus.reader.ConllChunkCorpusReader

Parameters
root:PathPointer or str	A path pointer identifying the root directory for this corpus. If a string is specified, then it will be converted to a `PathPointer` automatically.
fileids	A 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.
columntypes	Undocumented
chunk_types	Undocumented
root_label	Undocumented
pos_in_tree	Undocumented
srl_includes_roleset	Undocumented
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.
tree_class	Undocumented
tagset	The name of the tagset used by this corpus, to be used for normalizing or converting the POS tags returned by the tagged_...() methods.
separator	Undocumented

def chunked_sents(self, fileids=None, chunk_types=None, tagset=None): (source) ¶

Undocumented

def chunked_words(self, fileids=None, chunk_types=None, tagset=None): (source) ¶

Undocumented

def iob_sents(self, fileids=None, tagset=None): (source) ¶

Parameters
fileids:None or str or list	the list of fileids that make up this corpus
tagset	Undocumented
Returns
list(list)	a list of lists of word/tag/IOB tuples

def iob_words(self, fileids=None, tagset=None): (source) ¶

Parameters
fileids:None or str or list	the list of fileids that make up this corpus
tagset	Undocumented
Returns
list(tuple)	a list of word/tag/IOB tuples

def parsed_sents(self, fileids=None, pos_in_tree=None, tagset=None): (source) ¶

Undocumented

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

Undocumented

def sents(self, fileids=None): (source) ¶

Undocumented

def srl_instances(self, fileids=None, pos_in_tree=None, flatten=True): (source) ¶

Undocumented

def srl_spans(self, fileids=None): (source) ¶

Undocumented

def tagged_sents(self, fileids=None, tagset=None): (source) ¶

Undocumented

def tagged_words(self, fileids=None, tagset=None): (source) ¶

Undocumented

def words(self, fileids=None): (source) ¶

Undocumented

CHUNK: str = (source) ¶

Undocumented

Value

'chunk'

COLUMN_TYPES = (source) ¶

Undocumented

Value

(WORDS, POS, TREE, CHUNK, NE, SRL, IGNORE)

IGNORE: str = (source) ¶

Undocumented

Value

'ignore'

NE: str = (source) ¶

Undocumented

Value

'ne'

POS: str = (source) ¶

Undocumented

Value

'pos'

SRL: str = (source) ¶

Undocumented

Value

'srl'

TREE: str = (source) ¶

Undocumented

Value

'tree'

WORDS: str = (source) ¶

Undocumented

Value

'words'

sep = (source) ¶

Undocumented

@staticmethod
def _get_column(grid, column_index): (source) ¶

Undocumented

def _get_chunked_words(self, grid, chunk_types, tagset=None): (source) ¶

Undocumented

def _get_iob_words(self, grid, tagset=None): (source) ¶

Undocumented

def _get_parsed_sent(self, grid, pos_in_tree, tagset=None): (source) ¶

Undocumented

def _get_srl_instances(self, grid, pos_in_tree): (source) ¶

Undocumented

def _get_srl_spans(self, grid): (source) ¶

list of list of (start, end), tag) tuples

def _get_tagged_words(self, grid, tagset=None): (source) ¶

Undocumented

def _get_words(self, grid): (source) ¶

Undocumented

def _grids(self, fileids=None): (source) ¶

Undocumented

def _read_grid_block(self, stream): (source) ¶

Undocumented

def _require(self, *columntypes): (source) ¶

Undocumented

_chunk_types = (source) ¶

Undocumented

_colmap = (source) ¶

Undocumented

_pos_in_tree = (source) ¶

Undocumented

_root_label = (source) ¶

Undocumented

_srl_includes_roleset = (source) ¶

Undocumented

_tagset = (source) ¶

overrides nltk.corpus.reader.CorpusReader._tagset

Undocumented

_tree_class = (source) ¶

Undocumented