oracle.ifs.core.extraction.util

Class BasicInformationExtractionTrainer

java.lang.Object

oracle.ifs.core.extraction.util.BasicInformationExtractionTrainer

All Implemented Interfaces:

InformationExtractionTrainer

public class BasicInformationExtractionTrainer
extends Object
implements InformationExtractionTrainer

A BasicInformationExtractionTrainer updates the training models for an InformationExtraction that has a confirmed solution.

Author:

Dave Long

(Unpublished)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicInformationExtractionTrainer.MarkingTuple MarkingTuple holds a tuple of position within a sentence and its label.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CRLF Platform independent newline String.
static String	INDENT Amount to indent when depicting layered information.

Constructor Summary

Constructors

Constructor and Description
BasicInformationExtractionTrainer() Default constructor for an BasicInformationExtractionTrainer.

Method Summary

Modifier and Type	Method and Description
protected Document	addClassifierTrainingDocument(InformationExtraction ext, InformationExtractionOutcome confOutcome, InformationExtractionTrainingSet tset) Add a Classifier Document based on the confirmed outcome.
protected Document	addConllRelationTrainingDocument(InformationExtraction ext, InformationExtractionOutcome confOutcome, InformationExtractionTrainingSet tset) Add a CONLL Relation training Document based on the confirmed outcome.
protected Document	addSpacyClassifierTrainingDocument(InformationExtraction ext, InformationExtractionOutcome confOutcome, InformationExtractionTrainingSet tset, Document classfierDoc) Add a Spacy Classifier Document based on the confirmed outcome.
void	applyOverrideSettings() Apply override settings.
static String	determineClassifierTrainingContent(InformationExtraction ext, InformationExtractionOutcome confOutcome) Determine the contents to use for the Classifier Training document.
protected AccessControlList	determineClassifierTrainingDocumentAcl(InformationExtraction ext) Determine the ACL to use for the Classifier Training document.
protected String	determineClassifierTrainingDocumentName(InformationExtraction ext) Determine the Name to use for the Classifier Training document.
protected Folder	determineClassifierTrainingDocumentParentFolder(InformationExtraction ext) Determine the parent Folder to use for the Classifier Training document.
protected String	determineConllRelationTrainingContent(InformationExtraction ext, InformationExtractionOutcome confOutcome) Determine the contents to use for the CONLL Relation Training document.
protected String	determineConllRelationTrainingDocumentName(InformationExtraction ext) Determine the Name to use for the CONLL relation Training document.
protected String	determineSpacyClassifierTrainingDocumentName(InformationExtraction ext) Determine the Name to use for the Spacy Classifier Training document.
InformationExtraction	getInformationExtraction() Gets the InformationExtraction being processed.
AttributeValueTable	getSettings() Gets the effective settings for the current parse.
void	initialize(InformationExtractionTrainerSpecification spec) Initialize this instance.
void	invalidateTraining(InformationExtraction ext) Performs invalidation of any training performed for the target InformationExtraction, called after the InformationExtraction was confirmed and after training is performed on the confirmed InformationExtraction.
void	setInformationExtraction(InformationExtraction ext) Sets the InformationExtraction being processed.
void	train(InformationExtraction ext) Update training models for a confirmed InformationExtraction outcome.
protected void	updateTrainingModels(InformationExtraction ext, InformationExtractionOutcome confOutcome) Update the training models for an InformationExtraction with the specified confirmed outcome.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CRLF

public static final String CRLF

Platform independent newline String.

INDENT

public static final String INDENT

Amount to indent when depicting layered information.

See Also:

Constant Field Values

Constructor Detail

BasicInformationExtractionTrainer

public BasicInformationExtractionTrainer()

Default constructor for an BasicInformationExtractionTrainer.

(Published)

Method Detail

initialize

public void initialize(InformationExtractionTrainerSpecification spec)
                throws IfsException

Initialize this instance.

Called immediately after construction (via the default constructor) and used so that the implementation can initialize session-independent state. This instance may be subsequently used concurrently by multiple threads and sessions. A session can be retrieved from the specification object, but it must not be cached. The specification also has the implementation and instance specific parameters which should be cached in a session independent way.

Specified by:

initialize in interface InformationExtractionTrainer

Parameters:

spec - The specification for a given implementation.

Throws:

IfsException - if the operation fails.

getSettings

public AttributeValueTable getSettings()

Gets the effective settings for the current parse.

Returns:

The effective settings

getInformationExtraction

public InformationExtraction getInformationExtraction()

Gets the InformationExtraction being processed.

Returns:

the InformationExtraction being processed

setInformationExtraction

public void setInformationExtraction(InformationExtraction ext)

Sets the InformationExtraction being processed.

Parameters:

ext - the InformationExtraction being processed

applyOverrideSettings

public void applyOverrideSettings()
                           throws IfsException

Apply override settings.

Throws:

IfsException - if the operation fails

(Published)

train

public void train(InformationExtraction ext)
           throws IfsException

Update training models for a confirmed InformationExtraction outcome.

Specified by:

train in interface InformationExtractionTrainer

Parameters:

ext - the target InformationExtraction

Throws:

IfsException - if the operation fails

(Published)

updateTrainingModels

protected void updateTrainingModels(InformationExtraction ext,
                                    InformationExtractionOutcome confOutcome)
                             throws IfsException

Update the training models for an InformationExtraction with the specified confirmed outcome.

Parameters:

ext - the target InformationExtraction

confOutcome - the confirmed outcome of the InformationExtraction

Throws:

IfsException - if the operation fails

(Published)

addClassifierTrainingDocument

protected Document addClassifierTrainingDocument(InformationExtraction ext,
                                                 InformationExtractionOutcome confOutcome,
                                                 InformationExtractionTrainingSet tset)
                                          throws IfsException

Add a Classifier Document based on the confirmed outcome.

Parameters:

ext - the target InformationExtraction

confOutcome - the confirmed outcome of the InformationExtraction

tset - the training set

Returns:

the Document created

Throws:

IfsException - if the operation fails

(Published)

determineClassifierTrainingContent

public static String determineClassifierTrainingContent(InformationExtraction ext,
                                                        InformationExtractionOutcome confOutcome)
                                                 throws IfsException

Determine the contents to use for the Classifier Training document.

Parameters:

ext - the InformationExtraction being prepared

confOutcome - the confirmed outcome of the InformationExtraction

Returns:

the contents to use for the Classifier Training document

Throws:

IfsException - if the operation fails

(Published)

determineClassifierTrainingDocumentName

protected String determineClassifierTrainingDocumentName(InformationExtraction ext)
                                                  throws IfsException

Determine the Name to use for the Classifier Training document.

Parameters:

ext - the InformationExtraction being prepared

Returns:

the Name to use for the Classifier Training document

Throws:

IfsException - if the operation fails

(Published)

determineClassifierTrainingDocumentAcl

protected AccessControlList determineClassifierTrainingDocumentAcl(InformationExtraction ext)
                                                            throws IfsException

Determine the ACL to use for the Classifier Training document.

Parameters:

ext - the InformationExtraction being prepared

Returns:

the ACL to use for the Classifier Training document

Throws:

IfsException - if the operation fails

(Published)

determineClassifierTrainingDocumentParentFolder

protected Folder determineClassifierTrainingDocumentParentFolder(InformationExtraction ext)
                                                          throws IfsException

Determine the parent Folder to use for the Classifier Training document.

Parameters:

ext - the InformationExtraction being prepared

Returns:

the parent Folder to use for the Classifier Training document

Throws:

IfsException - if the operation fails

(Published)

addSpacyClassifierTrainingDocument

protected Document addSpacyClassifierTrainingDocument(InformationExtraction ext,
                                                      InformationExtractionOutcome confOutcome,
                                                      InformationExtractionTrainingSet tset,
                                                      Document classfierDoc)
                                               throws IfsException

Add a Spacy Classifier Document based on the confirmed outcome.

Parameters:

ext - the target InformationExtraction

confOutcome - the confirmed outcome of the InformationExtraction

tset - the training set

classfierDoc - the regular classifier Document

Returns:

the Document created for Spacy training

Throws:

IfsException - if the operation fails

(Published)

determineSpacyClassifierTrainingDocumentName

protected String determineSpacyClassifierTrainingDocumentName(InformationExtraction ext)
                                                       throws IfsException

Determine the Name to use for the Spacy Classifier Training document.

Parameters:

ext - the InformationExtraction being prepared

Returns:

the Name to use for the Spacy Classifier Training document

Throws:

IfsException - if the operation fails

(Published)

addConllRelationTrainingDocument

protected Document addConllRelationTrainingDocument(InformationExtraction ext,
                                                    InformationExtractionOutcome confOutcome,
                                                    InformationExtractionTrainingSet tset)
                                             throws IfsException

Add a CONLL Relation training Document based on the confirmed outcome.

Parameters:

ext - the target InformationExtraction

confOutcome - the confirmed outcome of the InformationExtraction

tset - the training set

Returns:

the Document created

Throws:

IfsException - if the operation fails

(Published)

determineConllRelationTrainingContent

protected String determineConllRelationTrainingContent(InformationExtraction ext,
                                                       InformationExtractionOutcome confOutcome)
                                                throws IfsException

Determine the contents to use for the CONLL Relation Training document.

Parameters:

ext - the InformationExtraction being prepared

confOutcome - the confirmed outcome of the InformationExtraction

Returns:

the contents to use for the Relation Training document

Throws:

IfsException - if the operation fails

(Published)

determineConllRelationTrainingDocumentName

protected String determineConllRelationTrainingDocumentName(InformationExtraction ext)
                                                     throws IfsException

Determine the Name to use for the CONLL relation Training document.

Parameters:

ext - the InformationExtraction being prepared

Returns:

the Name to use for the CONLL relation Training document

Throws:

IfsException - if the operation fails

(Published)

invalidateTraining

public void invalidateTraining(InformationExtraction ext)
                        throws IfsException

Performs invalidation of any training performed for the target InformationExtraction, called after the InformationExtraction was confirmed and after training is performed on the confirmed InformationExtraction.

Specified by:

invalidateTraining in interface InformationExtractionTrainer

Parameters:

ext - the target InformationExtraction.

Throws:

IfsException - if the operation fails.