Document (aika 0.13 API)

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.Queue

class Document.UpperBoundQueue

class Document.ValueQueue

Nested Classes
Modifier and Type	Class and Description
`class`	`Document.Queue`
`class`	`Document.UpperBoundQueue`
`class`	`Document.ValueQueue`

Field Summary

Fields
Modifier and Type	Field and Description
`TreeSet<INeuron>`	`activatedNeurons`
`int`	`activationIdCounter`
`static Comparator<NodeActivation>`	`ACTIVATIONS_OUTPUT_COMPARATOR`
`TreeMap<NodeActivation.Key,Activation>`	`activationsByRid`
`TreeSet<Node>`	`addedNodes`
`static boolean`	`APPLY_DEBUG_OUTPUT`
`List<InterpretationNode>`	`bestInterpretation`
`InterpretationNode`	`bottom`
`ArrayList<Candidate>`	`candidates`
`static int`	`CLEANUP_INTERVAL`
`TreeSet<INeuron>`	`finallyActivatedNeurons`
`int`	`id`
`TreeSet<Activation>`	`inputNeuronActivations`
`int`	`interpretationIdCounter`
`static int`	`MAX_ROUND`
`Model`	`model`
`TreeMap<INeuron,Set<Synapse>>`	`modifiedWeights`
`static boolean`	`OPTIMIZE_DEBUG_OUTPUT`
`Document.Queue`	`queue`
`List<InterpretationNode>`	`rootRefs`
`SearchNode`	`rootSearchNode`
`int`	`searchNodeIdCounter`
`int`	`searchStepCounter`
`SearchNode`	`selectedSearchNode`
`SupervisedTraining`	`supervisedTraining`
`int`	`threadId`
`Document.UpperBoundQueue`	`ubQueue`
`long`	`visitedCounter`
`Document.ValueQueue`	`vQueue`

Constructor Summary

Constructors
Constructor and Description

Document(int id, String content, Model model, int threadId)

Constructors
Constructor and Description
`Document(int id, String content, Model model, int threadId)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`bestInterpretationToString()`
`void`	`clearActivations()` Removes the activations of this document from the model again.
`void`	`commit()` Updates the model after the training step.
`int`	`compareTo(Document doc)`
`void`	`dumpDebugCandidateStatistics()`
`void`	`generateCandidates()`
`String`	`generateOutputText()`
`Collection<NodeActivation>`	`getAllNodeActivations()`
`String`	`getContent()`
`Stream<Activation>`	`getFinalActivations()`
`String`	`getText(Range r)`
`int`	`length()`
`String`	`neuronActivationsToString(boolean withWeights)`
`String`	`neuronActivationsToString(boolean withWeights, boolean withTextSnipped, boolean withLogic)`
`String`	`neuronActivationsToString(SearchNode sn, boolean withWeights, boolean withTextSnipped, boolean withLogic)`
`void`	`notifyWeightsModified(INeuron n, Collection<Synapse> inputSynapses)`
`void`	`process()` The method `process` needs to be called after all the input activations have been added to the network.
`void`	`propagate()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

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
```

id
```
public final int id
```

visitedCounter
```
public long visitedCounter
```

interpretationIdCounter
```
public int interpretationIdCounter
```

activationIdCounter
```
public int activationIdCounter
```

searchNodeIdCounter
```
public int searchNodeIdCounter
```

searchStepCounter
```
public int searchStepCounter
```

bottom
```
public InterpretationNode bottom
```

model
```
public Model model
```

threadId
```
public int threadId
```

queue
```
public Document.Queue queue
```

vQueue
```
public Document.ValueQueue vQueue
```

ubQueue

public Document.UpperBoundQueue ubQueue

activatedNeurons

public TreeSet<INeuron> activatedNeurons

finallyActivatedNeurons

public TreeSet<INeuron> finallyActivatedNeurons

inputNeuronActivations

public TreeSet<Activation> inputNeuronActivations

modifiedWeights

public TreeMap<INeuron,Set<Synapse>> modifiedWeights

supervisedTraining

public SupervisedTraining supervisedTraining

activationsByRid

public TreeMap<NodeActivation.Key,Activation> activationsByRid

addedNodes
```
public TreeSet<Node> addedNodes
```

rootSearchNode
```
public SearchNode rootSearchNode
```

selectedSearchNode
```
public SearchNode selectedSearchNode
```

rootRefs

public List<InterpretationNode> rootRefs

candidates
```
public ArrayList<Candidate> candidates
```

bestInterpretation

public List<InterpretationNode> bestInterpretation

ACTIVATIONS_OUTPUT_COMPARATOR

public static Comparator<NodeActivation> ACTIVATIONS_OUTPUT_COMPARATOR

Constructor Detail

Document

public Document(int id,
                String content,
                Model model,
                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)
```

getFinalActivations

public Stream<Activation> getFinalActivations()

bestInterpretationToString

public String bestInterpretationToString()

compareTo
```
public int compareTo(Document doc)
```
Specified by:

compareTo in interface Comparable<Document>

propagate
```
public void propagate()
```

generateCandidates
```
public void generateCandidates()
```

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.

dumpDebugCandidateStatistics

public void dumpDebugCandidateStatistics()

notifyWeightsModified

public void notifyWeightsModified(INeuron n,
                                  Collection<Synapse> inputSynapses)

commit
```
public void commit()
```
Updates the model after the training step. It applies the weight and bias delta values and reflects the changes in the logic node structure.

getAllNodeActivations

public Collection<NodeActivation> getAllNodeActivations()

clearActivations
```
public void clearActivations()
```
Removes the activations of this document from the model again.

generateOutputText
```
public String generateOutputText()
```

neuronActivationsToString

public String neuronActivationsToString(boolean withWeights)

neuronActivationsToString

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

neuronActivationsToString

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

Class Document

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

APPLY_DEBUG_OUTPUT

OPTIMIZE_DEBUG_OUTPUT

CLEANUP_INTERVAL

MAX_ROUND

id

visitedCounter

interpretationIdCounter

activationIdCounter

searchNodeIdCounter

searchStepCounter

bottom

model

threadId

queue

vQueue

ubQueue

activatedNeurons

finallyActivatedNeurons

inputNeuronActivations

modifiedWeights

supervisedTraining

activationsByRid

addedNodes

rootSearchNode

selectedSearchNode

rootRefs

candidates

bestInterpretation

ACTIVATIONS_OUTPUT_COMPARATOR

Constructor Detail

Document

Method Detail

getContent

length

toString

getText

getFinalActivations

bestInterpretationToString

compareTo

propagate

generateCandidates

process

dumpDebugCandidateStatistics

notifyWeightsModified

commit

getAllNodeActivations

clearActivations

generateOutputText

neuronActivationsToString

neuronActivationsToString

neuronActivationsToString