framenet_tools.stages package

Submodules

framenet_tools.stages.feeID module

class framenet_tools.stages.feeID.FeeID(cM: framenet_tools.config.ConfigManager)

Bases: framenet_tools.pipelinestage.PipelineStage

The Frame evoking element identification stage

Only relies on static predictions

predict(m_reader: framenet_tools.data_handler.reader.DataReader)

Predict the given data

NOTE: Changes the object itself

Parameters:m_reader – The DataReader object
Returns:
train(m_reader: framenet_tools.data_handler.reader.DataReader, m_reader_dev: framenet_tools.data_handler.reader.DataReader)

No training needed

Parameters:
  • m_reader – The DataReader object which contains the training data
  • m_reader_dev – The DataReader object for evaluation and auto stopping (NOTE: not necessarily given, as the focus might lie on maximizing the training data)
Returns:

framenet_tools.stages.frameID module

class framenet_tools.stages.frameID.FrameID(cM: framenet_tools.config.ConfigManager)

Bases: framenet_tools.pipelinestage.PipelineStage

The Frame Identification stage

predict(m_reader: framenet_tools.data_handler.reader.DataReader)

Predict the given data

NOTE: Changes the object itself

Parameters:m_reader – The DataReader object
Returns:
train(m_reader: framenet_tools.data_handler.reader.DataReader, m_reader_dev: framenet_tools.data_handler.reader.DataReader)

Train the frame identification stage on the given data

NOTE: May overwrite a previously saved model!

Parameters:
  • m_reader – The DataReader object which contains the training data
  • m_reader_dev – The DataReader object for evaluation and auto stopping (NOTE: not necessarily given, as the focus might lie on maximizing the training data)
Returns:

framenet_tools.stages.roleID module

class framenet_tools.stages.roleID.RoleID(cM: framenet_tools.config.ConfigManager)

Bases: framenet_tools.pipelinestage.PipelineStage

The Role Identification stage

predict(m_reader: framenet_tools.data_handler.reader.DataReader)
Parameters:m_reader
Returns:
train(m_reader: framenet_tools.data_handler.reader.DataReader, m_reader_dev: framenet_tools.data_handler.reader.DataReader)

Trains the role identification stage

Parameters:
  • m_reader – The DataReader object which contains the training data
  • m_reader_dev – The DataReader object for evaluation and auto stopping (NOTE: not necessarily given, as the focus might lie on maximizing the training data)
Returns:

framenet_tools.stages.spanID module

class framenet_tools.stages.spanID.SpanID(cM: framenet_tools.config.ConfigManager)

Bases: framenet_tools.pipelinestage.PipelineStage

The Span Identification stage

predict(m_reader: framenet_tools.data_handler.reader.DataReader)
Parameters:m_reader
Returns:
train(m_reader: framenet_tools.data_handler.reader.DataReader, m_reader_dev: framenet_tools.data_handler.reader.DataReader)

Train the stage on the given data

Parameters:
  • m_reader – The DataReader object which contains the training data
  • m_reader_dev – The DataReader object for evaluation and auto stopping (NOTE: not necessarily given, as the focus might lie on maximizing the training data)
Returns:

Module contents