org.aika.corpus

Class Document

java.lang.Object

org.aika.corpus.Document

All Implemented Interfaces:

Comparable<Document>

public class Document
extends Object
implements Comparable<Document>

The Document class represents a single document which may be either used for processing a text or as training input. A document consists of the raw text, the interpretations and the activations.

When the document is not needed any more, the method clearActivations must be called, since Aika only supports a single document per thread and model.

Author:

Lukas Molzberger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Document.BackPropagationQueue
class	Document.Queue
class	Document.UpperBoundQueue
class	Document.ValueQueue

Field Summary

Fields

Modifier and Type	Field and Description
TreeSet<INeuron>	activatedNeurons
TreeSet<Node>	activatedNodes
TreeSet<Node>	activatedNodesForTraining
int	activationIdCounter
static Comparator<NodeActivation>	ACTIVATIONS_OUTPUT_COMPARATOR
TreeMap<NodeActivation.Key,NodeActivation>	activationsByRid
TreeSet<Node>	addedNodes
static boolean	APPLY_DEBUG_OUTPUT
List<InterprNode>	bestInterpretation
InterprNode	bottom
Document.BackPropagationQueue	bQueue
static int	CLEANUP_INTERVAL
int	debugActId
double	debugActWeight
String	debugOutput
static AtomicInteger	docIdCounter
TreeSet<INeuron>	finallyActivatedNeurons
int	id
TreeSet<Activation>	inputNeuronActivations
int	interprIdCounter
boolean	interrupted
Model	m
static int	MAX_ROUND
static int	numberOfPositionsDelta
static boolean	OPTIMIZE_DEBUG_OUTPUT
Document.Queue	queue
int	searchNodeIdCounter
SearchNode	selectedSearchNode
int	threadId
Document.UpperBoundQueue	ubQueue
int	visitedCounter
Document.ValueQueue	vQueue

Constructor Summary

Constructors

Constructor and Description
Document(String content, Model m, int threadId)

Method Summary

Modifier and Type	Method and Description
String	bestInterpretationToString()
void	changeNumberOfPositions(int delta)
void	clearActivations() Removes the activations of this document from the model again.
int	compareTo(Document doc)
void	count()
String	getContent()
String	getText(Range r)
int	length()
String	neuronActivationsToString(boolean withWeights)
String	neuronActivationsToString(boolean withWeights, boolean withTextSnipped, boolean withLogic)
String	nodeActivationsToString(boolean withTextSnipped, boolean withLogic)
void	process() The method process needs to be called after all the input activations have been added to the network.
void	propagate()
String	toString()
void	train(TrainConfig trainConfig)

Methods inherited from class java.lang.Object

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

Field Detail

id

public final int id

docIdCounter

public static AtomicInteger docIdCounter

activationIdCounter

public int activationIdCounter

APPLY_DEBUG_OUTPUT

public static boolean APPLY_DEBUG_OUTPUT

OPTIMIZE_DEBUG_OUTPUT

public static boolean OPTIMIZE_DEBUG_OUTPUT

CLEANUP_INTERVAL

public static int CLEANUP_INTERVAL

MAX_ROUND

public static int MAX_ROUND

visitedCounter

public int visitedCounter

interprIdCounter

public int interprIdCounter

searchNodeIdCounter

public int searchNodeIdCounter

bottom

public InterprNode bottom

selectedSearchNode

public SearchNode selectedSearchNode

bestInterpretation

public List<InterprNode> bestInterpretation

m

public Model m

threadId

public int threadId

interrupted

public boolean interrupted

queue

public Document.Queue queue

vQueue

public Document.ValueQueue vQueue

ubQueue

public Document.UpperBoundQueue ubQueue

bQueue

public Document.BackPropagationQueue bQueue

activatedNodes

public TreeSet<Node> activatedNodes

activatedNodesForTraining

public TreeSet<Node> activatedNodesForTraining

activatedNeurons

public TreeSet<INeuron> activatedNeurons

finallyActivatedNeurons

public TreeSet<INeuron> finallyActivatedNeurons

inputNeuronActivations

public TreeSet<Activation> inputNeuronActivations

activationsByRid

public TreeMap<NodeActivation.Key,NodeActivation> activationsByRid

addedNodes

public TreeSet<Node> addedNodes

numberOfPositionsDelta

public static int numberOfPositionsDelta

debugActId

public int debugActId

debugActWeight

public double debugActWeight

debugOutput

public String debugOutput

ACTIVATIONS_OUTPUT_COMPARATOR

public static Comparator<NodeActivation> ACTIVATIONS_OUTPUT_COMPARATOR

Constructor Detail

Document

public Document(String content,
                Model m,
                int threadId)

Method Detail

getContent

public String getContent()

length

public int length()

toString

public String toString()

Overrides:

toString in class Object

getText

public String getText(Range r)

bestInterpretationToString

public String bestInterpretationToString()

compareTo

public int compareTo(Document doc)

Specified by:

compareTo in interface Comparable<Document>

propagate

public void propagate()

process

public void process()

The method process needs to be called after all the input activations have been added to the network. It performs the search for the best interpretation.

count

public void count()

train

public void train(TrainConfig trainConfig)

clearActivations

public void clearActivations()

Removes the activations of this document from the model again.

changeNumberOfPositions

public void changeNumberOfPositions(int delta)

neuronActivationsToString

public String neuronActivationsToString(boolean withWeights)

neuronActivationsToString

public String neuronActivationsToString(boolean withWeights,
                                        boolean withTextSnipped,
                                        boolean withLogic)

nodeActivationsToString

public String nodeActivationsToString(boolean withTextSnipped,
                                      boolean withLogic)