org.dllearner.algorithms.el
Class ELLearningAlgorithm

java.lang.Object
  org.dllearner.core.AbstractComponent
      org.dllearner.core.AbstractCELA
          org.dllearner.algorithms.el.ELLearningAlgorithm

All Implemented Interfaces:

ClassExpressionLearningAlgorithm, Component, LearningAlgorithm, StoppableLearningAlgorithm

public class ELLearningAlgorithm
extends AbstractCELA

A learning algorithm for EL, which will be based on a (hopefully) ideal refinement operator. TODO redundancy check

Author:

Jens Lehmann

Field Summary

Fields inherited from class org.dllearner.core.AbstractCELA

MAX_NR_OF_RESULTS

Constructor Summary

ELLearningAlgorithm(PosNegLP problem, AbstractReasonerComponent reasoner)

Method Summary

static Collection<ConfigOption<?>>	createConfigOptions()
ELLearningAlgorithmConfigurator	getConfigurator() For each component, a configurator class is generated in package org.dllearner.core.configurators using the script { org.dllearner.scripts.ConfigJavaGenerator}.
Description	getCurrentlyBestDescription()
List<Description>	getCurrentlyBestDescriptions()
EvaluatedDescription	getCurrentlyBestEvaluatedDescription() Returns the best descriptions obtained so far.
TreeSet<? extends EvaluatedDescription>	getCurrentlyBestEvaluatedDescriptions() Returns a sorted set of the best descriptions found so far.
static String	getName()
SearchTreeNode	getStartNode()
void	init() Method to be called after the component has been configured.
boolean	isRunning() Returns whether the learning algorithm is running.
void	start() Starts the algorithm.
void	stop() Stops the algorithm gracefully.
static Collection<Class<? extends AbstractLearningProblem>>	supportedLearningProblems()

Methods inherited from class org.dllearner.core.AbstractCELA

changeLearningProblem, changeReasonerComponent, getCurrentlyBestDescriptions, getCurrentlyBestDescriptions, getCurrentlyBestEvaluatedDescriptions, getCurrentlyBestEvaluatedDescriptions, getCurrentlyBestEvaluatedDescriptions, getCurrentlyBestMostGeneralEvaluatedDescriptions

Methods inherited from class java.lang.Object

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

Constructor Detail

ELLearningAlgorithm

public ELLearningAlgorithm(PosNegLP problem,
                           AbstractReasonerComponent reasoner)

Method Detail

getName

public static String getName()

supportedLearningProblems

public static Collection<Class<? extends AbstractLearningProblem>> supportedLearningProblems()

getConfigurator

public ELLearningAlgorithmConfigurator getConfigurator()

Description copied from class: AbstractComponent

For each component, a configurator class is generated in package org.dllearner.core.configurators using the script { org.dllearner.scripts.ConfigJavaGenerator}. The configurator provides set and get methods for the configuration options of a component.

Specified by:

getConfigurator in class AbstractComponent

Returns:

An object allowing to configure this component.

createConfigOptions

public static Collection<ConfigOption<?>> createConfigOptions()

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.

Throws:

ComponentInitException - This exception is thrown if any exceptions occur within the initialisation process of this component. As component developer, you are encouraged to rethrow occuring exception as ComponentInitException and giving an error message as well as the actualy exception by using the constructor ComponentInitException.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.

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.

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.

Returns:

True if the algorithm is running, false otherwise.

getCurrentlyBestDescription

public Description getCurrentlyBestDescription()

Specified by:

getCurrentlyBestDescription in class AbstractCELA

Returns:

The best class description found by the learning algorithm so far.

See Also:

AbstractCELA.getCurrentlyBestEvaluatedDescription()

getCurrentlyBestDescriptions

public List<Description> 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 getCurrentlyBestEvaluatedDescription()

Description copied from class: AbstractCELA

Returns the best descriptions obtained so far.

Specified by:

getCurrentlyBestEvaluatedDescription in class AbstractCELA

Returns:

Best class description found so far.

getCurrentlyBestEvaluatedDescriptions

public TreeSet<? extends EvaluatedDescription> 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.

getStartNode

public SearchTreeNode getStartNode()

Returns:

the startNode