CELOE (DL-Learner Javadoc)

java.lang.Object
- org.dllearner.core.AbstractComponent
- - org.dllearner.core.AbstractCELA
  - - org.dllearner.algorithms.celoe.CELOE

All Implemented Interfaces:

Cloneable, ClassExpressionLearningAlgorithm, Component, LearningAlgorithm, StoppableLearningAlgorithm
```
public class CELOE
extends AbstractCELA
implements Cloneable
```
The CELOE (Class Expression Learner for Ontology Engineering) algorithm. It adapts and extends the standard supervised learning algorithm for the ontology engineering use case.

Author:

Jens Lehmann

Field Summary
- Fields inherited from class org.dllearner.core.AbstractCELA
  MAX_NR_OF_RESULTS

Constructor Summary

Constructors
Constructor and Description

CELOE()

CELOE(AbstractClassExpressionLearningProblem problem, AbstractReasonerComponent reasoner)

CELOE(CELOE celoe)

Constructors
Constructor and Description
`CELOE()`
`CELOE(AbstractClassExpressionLearningProblem problem, AbstractReasonerComponent reasoner)`
`CELOE(CELOE celoe)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`int`	`getClassExpressionTests()`
`double`	`getCurrentlyBestAccuracy()`
`org.semanticweb.owlapi.model.OWLClassExpression`	`getCurrentlyBestDescription()`
`List<org.semanticweb.owlapi.model.OWLClassExpression>`	`getCurrentlyBestDescriptions()`
`EvaluatedDescription<? extends Score>`	`getCurrentlyBestEvaluatedDescription()` Returns the best descriptions obtained so far.
`NavigableSet<? extends EvaluatedDescription<? extends Score>>`	`getCurrentlyBestEvaluatedDescriptions()` Returns a sorted set of the best descriptions found so far.
`AbstractHeuristic`	`getHeuristic()`
`int`	`getMaxClassExpressionTests()`
`int`	`getMaxClassExpressionTestsAfterImprovement()`
`double`	`getMaxDepth()`
`int`	`getMaxExecutionTimeInSecondsAfterImprovement()`
`int`	`getMaximumHorizontalExpansion()`
`int`	`getMaxNrOfResults()`
`int`	`getMinimumHorizontalExpansion()`
`double`	`getNoisePercentage()`
`LengthLimitedRefinementOperator`	`getOperator()`
`SortedMap<Long,Double>`	`getRuntimeVsBestScore()`
`SortedMap<Long,Double>`	`getRuntimeVsBestScore(long ticksIntervalTimeValue, TimeUnit ticksIntervalTimeUnit)` Return a map that contains entries with time points at which a hypothesis with a better score than before has been found entries with the current best score for each defined interval time point
`String`	`getSearchTreeFile()`
`org.semanticweb.owlapi.model.OWLClassExpression`	`getStartClass()`
`long`	`getTotalRuntimeNs()`
`void`	`init()` Method to be called after the component has been configured.
`boolean`	`isExpandAccuracy100Nodes()`
`boolean`	`isFilterDescriptionsFollowingFromKB()`
`boolean`	`isReplaceSearchTree()`
`boolean`	`isReuseExistingDescription()`
`boolean`	`isRunning()` Returns whether the learning algorithm is running.
`boolean`	`isSingleSuggestionMode()`
`boolean`	`isStopOnFirstDefinition()`
`boolean`	`isTerminateOnNoiseReached()`
`boolean`	`isWriteSearchTree()`
`static void`	`main(String[] args)`
`void`	`setExpandAccuracy100Nodes(boolean expandAccuracy100Nodes)`
`void`	`setFilterDescriptionsFollowingFromKB(boolean filterDescriptionsFollowingFromKB)`
`void`	`setHeuristic(AbstractHeuristic heuristic)`
`void`	`setKeepTrackOfBestScore(boolean keepTrackOfBestScore)` Whether to keep track of the best score during the algorithm run.
`void`	`setMaxClassExpressionTests(int maxClassExpressionTests)`
`void`	`setMaxClassExpressionTestsAfterImprovement(int maxClassExpressionTestsAfterImprovement)`
`void`	`setMaxDepth(double maxDepth)`
`void`	`setMaxExecutionTimeInSecondsAfterImprovement(int maxExecutionTimeInSecondsAfterImprovement)`
`void`	`setMaxNrOfResults(int maxNrOfResults)`
`void`	`setNoisePercentage(double noisePercentage)`
`void`	`setOperator(LengthLimitedRefinementOperator operator)`
`void`	`setReplaceSearchTree(boolean replaceSearchTree)`
`void`	`setReuseExistingDescription(boolean reuseExistingDescription)`
`void`	`setSearchTreeFile(String searchTreeFile)`
`void`	`setSingleSuggestionMode(boolean singleSuggestionMode)`
`void`	`setStartClass(org.semanticweb.owlapi.model.OWLClassExpression startClass)`
`void`	`setStopOnFirstDefinition(boolean stopOnFirstDefinition)`
`void`	`setTerminateOnNoiseReached(boolean terminateOnNoiseReached)`
`void`	`setWriteSearchTree(boolean writeSearchTree)`
`void`	`start()` Starts the algorithm.
`void`	`stop()` Stops the algorithm gracefully.
`static Collection<Class<? extends AbstractClassExpressionLearningProblem>>`	`supportedLearningProblems()`

Methods inherited from class org.dllearner.core.AbstractComponent
isInitialized

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

- Constructor Detail
  - CELOE
```
public CELOE()
```
  - CELOE
```
public CELOE(CELOE celoe)
```
  - CELOE
```
public CELOE(AbstractClassExpressionLearningProblem problem,
             AbstractReasonerComponent reasoner)
```
- Method Detail
  - supportedLearningProblems
```
public static Collection<Class<? extends AbstractClassExpressionLearningProblem>> supportedLearningProblems()
```
  - init
```
public void init()
          throws ComponentInitException
```
    Description copied from interface: Component
    
    Method to be called after the component has been configured. Implementation of components can overwrite this method to perform setup and initialisation tasks for this component.
    
    Specified by:
    
    init in interface Component
    
    Throws:
    
    ComponentInitException - This exception is thrown if any exceptions occur within the initialisation process of this component. As component developer, you are encouraged to re-throw occurring exception as ComponentInitException and giving an error message as well as the actually exception by using the constructor ComponentInitException(String, Throwable).
  - start
```
public void start()
```
    Description copied from interface: LearningAlgorithm
    
    Starts the algorithm. It runs until paused, stopped, or a termination criterion has been reached.
    
    Specified by:
    
    start in interface LearningAlgorithm
  - getCurrentlyBestDescription
```
public org.semanticweb.owlapi.model.OWLClassExpression getCurrentlyBestDescription()
```
    Overrides:
    
    getCurrentlyBestDescription in class AbstractCELA
    
    Returns:
    
    The best class OWLClassExpression found by the learning algorithm so far.
    
    See Also:
    
    AbstractCELA.getCurrentlyBestEvaluatedDescription()
  - getCurrentlyBestDescriptions
```
public List<org.semanticweb.owlapi.model.OWLClassExpression> getCurrentlyBestDescriptions()
```
    Overrides:
    
    getCurrentlyBestDescriptions in class AbstractCELA
    
    Returns:
    
    The best class descriptions found by the learning algorithm so far.
    
    See Also:
    
    AbstractCELA.getCurrentlyBestEvaluatedDescriptions()
  - getCurrentlyBestEvaluatedDescription
```
public EvaluatedDescription<? extends Score> getCurrentlyBestEvaluatedDescription()
```
    Description copied from class: AbstractCELA
    
    Returns the best descriptions obtained so far.
    
    Overrides:
    
    getCurrentlyBestEvaluatedDescription in class AbstractCELA
    
    Returns:
    
    Best class class expression found so far.
  - getCurrentlyBestEvaluatedDescriptions
```
public NavigableSet<? extends EvaluatedDescription<? extends Score>> getCurrentlyBestEvaluatedDescriptions()
```
    Description copied from class: AbstractCELA
    
    Returns a sorted set of the best descriptions found so far. We assume that they are ordered such that the best ones come in last. (In Java, iterators traverse a SortedSet in ascending order.)
    
    Overrides:
    
    getCurrentlyBestEvaluatedDescriptions in class AbstractCELA
    
    Returns:
    
    Best class descriptions found so far.
  - getCurrentlyBestAccuracy
```
public double getCurrentlyBestAccuracy()
```
  - isRunning
```
public boolean isRunning()
```
    Description copied from interface: StoppableLearningAlgorithm
    
    Returns whether the learning algorithm is running. Implementation should use a boolean status variable in their implementations of the start and resume methods.
    
    Specified by:
    
    isRunning in interface StoppableLearningAlgorithm
    
    Overrides:
    
    isRunning in class AbstractCELA
    
    Returns:
    
    True if the algorithm is running, false otherwise.
  - stop
```
public void stop()
```
    Description copied from interface: StoppableLearningAlgorithm
    
    Stops the algorithm gracefully. A stopped algorithm cannot be resumed anymore. Use this method for cleanup and freeing memory.
    
    Specified by:
    
    stop in interface StoppableLearningAlgorithm
    
    Overrides:
    
    stop in class AbstractCELA
  - getMaximumHorizontalExpansion
```
public int getMaximumHorizontalExpansion()
```
  - getMinimumHorizontalExpansion
```
public int getMinimumHorizontalExpansion()
```
  - getClassExpressionTests
```
public int getClassExpressionTests()
```
    Returns:
    
    the expressionTests
  - getOperator
```
public LengthLimitedRefinementOperator getOperator()
```
  - setOperator
```
@Autowired(required=false)
public void setOperator(LengthLimitedRefinementOperator operator)
```
  - getStartClass
```
public org.semanticweb.owlapi.model.OWLClassExpression getStartClass()
```
  - setStartClass
```
public void setStartClass(org.semanticweb.owlapi.model.OWLClassExpression startClass)
```
  - isWriteSearchTree
```
public boolean isWriteSearchTree()
```
  - setWriteSearchTree
```
public void setWriteSearchTree(boolean writeSearchTree)
```
  - getSearchTreeFile
```
public String getSearchTreeFile()
```
  - setSearchTreeFile
```
public void setSearchTreeFile(String searchTreeFile)
```
  - getMaxNrOfResults
```
public int getMaxNrOfResults()
```
  - setMaxNrOfResults
```
public void setMaxNrOfResults(int maxNrOfResults)
```
  - getNoisePercentage
```
public double getNoisePercentage()
```
  - setNoisePercentage
```
public void setNoisePercentage(double noisePercentage)
```
  - isFilterDescriptionsFollowingFromKB
```
public boolean isFilterDescriptionsFollowingFromKB()
```
  - setFilterDescriptionsFollowingFromKB
```
public void setFilterDescriptionsFollowingFromKB(boolean filterDescriptionsFollowingFromKB)
```
  - isReplaceSearchTree
```
public boolean isReplaceSearchTree()
```
  - setReplaceSearchTree
```
public void setReplaceSearchTree(boolean replaceSearchTree)
```
  - isTerminateOnNoiseReached
```
public boolean isTerminateOnNoiseReached()
```
  - setTerminateOnNoiseReached
```
public void setTerminateOnNoiseReached(boolean terminateOnNoiseReached)
```
  - isReuseExistingDescription
```
public boolean isReuseExistingDescription()
```
  - setReuseExistingDescription
```
public void setReuseExistingDescription(boolean reuseExistingDescription)
```
  - getHeuristic
```
public AbstractHeuristic getHeuristic()
```
  - setHeuristic
```
@Autowired(required=false)
public void setHeuristic(AbstractHeuristic heuristic)
```
  - getMaxExecutionTimeInSecondsAfterImprovement
```
public int getMaxExecutionTimeInSecondsAfterImprovement()
```
  - setMaxExecutionTimeInSecondsAfterImprovement
```
public void setMaxExecutionTimeInSecondsAfterImprovement(int maxExecutionTimeInSecondsAfterImprovement)
```
  - isSingleSuggestionMode
```
public boolean isSingleSuggestionMode()
```
  - setSingleSuggestionMode
```
public void setSingleSuggestionMode(boolean singleSuggestionMode)
```
  - getMaxClassExpressionTests
```
public int getMaxClassExpressionTests()
```
  - setMaxClassExpressionTests
```
public void setMaxClassExpressionTests(int maxClassExpressionTests)
```
  - getMaxClassExpressionTestsAfterImprovement
```
public int getMaxClassExpressionTestsAfterImprovement()
```
  - setMaxClassExpressionTestsAfterImprovement
```
public void setMaxClassExpressionTestsAfterImprovement(int maxClassExpressionTestsAfterImprovement)
```
  - getMaxDepth
```
public double getMaxDepth()
```
  - setMaxDepth
```
public void setMaxDepth(double maxDepth)
```
  - isStopOnFirstDefinition
```
public boolean isStopOnFirstDefinition()
```
  - setStopOnFirstDefinition
```
public void setStopOnFirstDefinition(boolean stopOnFirstDefinition)
```
  - getTotalRuntimeNs
```
public long getTotalRuntimeNs()
```
  - isExpandAccuracy100Nodes
```
public boolean isExpandAccuracy100Nodes()
```
    Returns:
    
    the expandAccuracy100Nodes
  - setExpandAccuracy100Nodes
```
public void setExpandAccuracy100Nodes(boolean expandAccuracy100Nodes)
```
    Parameters:
    
    expandAccuracy100Nodes - the expandAccuracy100Nodes to set
  - setKeepTrackOfBestScore
```
public void setKeepTrackOfBestScore(boolean keepTrackOfBestScore)
```
    Whether to keep track of the best score during the algorithm run.
    
    Parameters:
    
    keepTrackOfBestScore -
  - getRuntimeVsBestScore
```
public SortedMap<Long,Double> getRuntimeVsBestScore()
```
    Returns:
    
    a map containing time points at which a hypothesis with a better score than before has been found
  - getRuntimeVsBestScore
```
public SortedMap<Long,Double> getRuntimeVsBestScore(long ticksIntervalTimeValue,
                                                    TimeUnit ticksIntervalTimeUnit)
```
    Return a map that contains
    1. entries with time points at which a hypothesis with a better score than before has been found
    2. entries with the current best score for each defined interval time point
    Parameters:
    
    ticksIntervalTimeValue - at which time point the current best score is tracked periodically
    
    ticksIntervalTimeUnit - the time unit of the periodic time point values
    
    Returns:
    
    the map
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Throws:
    
    Exception

Class CELOE

Field Summary

Fields inherited from class org.dllearner.core.AbstractCELA

Constructor Summary

Method Summary

Methods inherited from class org.dllearner.core.AbstractCELA

Methods inherited from class org.dllearner.core.AbstractComponent

Methods inherited from class java.lang.Object

Constructor Detail

CELOE

CELOE

CELOE

Method Detail

supportedLearningProblems

init

start

getCurrentlyBestDescription

getCurrentlyBestDescriptions

getCurrentlyBestEvaluatedDescription

getCurrentlyBestEvaluatedDescriptions

getCurrentlyBestAccuracy

isRunning

stop

getMaximumHorizontalExpansion

getMinimumHorizontalExpansion

getClassExpressionTests

getOperator

setOperator

getStartClass

setStartClass

isWriteSearchTree

setWriteSearchTree

getSearchTreeFile

setSearchTreeFile

getMaxNrOfResults

setMaxNrOfResults

getNoisePercentage

setNoisePercentage

isFilterDescriptionsFollowingFromKB

setFilterDescriptionsFollowingFromKB

isReplaceSearchTree

setReplaceSearchTree

isTerminateOnNoiseReached

setTerminateOnNoiseReached

isReuseExistingDescription

setReuseExistingDescription

getHeuristic

setHeuristic

getMaxExecutionTimeInSecondsAfterImprovement

setMaxExecutionTimeInSecondsAfterImprovement

isSingleSuggestionMode

setSingleSuggestionMode

getMaxClassExpressionTests

setMaxClassExpressionTests

getMaxClassExpressionTestsAfterImprovement

setMaxClassExpressionTestsAfterImprovement

getMaxDepth

setMaxDepth

isStopOnFirstDefinition

setStopOnFirstDefinition

getTotalRuntimeNs

isExpandAccuracy100Nodes

setExpandAccuracy100Nodes

setKeepTrackOfBestScore

getRuntimeVsBestScore

getRuntimeVsBestScore

clone

main