org.dllearner.algorithms.refinement
Class ROLearner

java.lang.Object
  org.dllearner.core.AbstractComponent
      org.dllearner.core.AbstractCELA
          org.dllearner.algorithms.refinement.ROLearner

All Implemented Interfaces:

ClassExpressionLearningAlgorithm, Component, LearningAlgorithm, StoppableLearningAlgorithm

public class ROLearner
extends AbstractCELA

Nested Class Summary

static class

ROLearner.Heuristic

Field Summary

Fields inherited from class org.dllearner.core.AbstractCELA

MAX_NR_OF_RESULTS

Constructor Summary

ROLearner(PosNegLP learningProblem, AbstractReasonerComponent reasoningService)

Method Summary

<T> void	applyConfigEntry(ConfigEntry<T> entry) Applies a configuration option to this component.
static Collection<ConfigOption<?>>	createConfigOptions()
ROLearnerConfigurator	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(int nrOfSolutions)
EvaluatedDescriptionPosNeg	getCurrentlyBestEvaluatedDescription() Returns the best descriptions obtained so far.
TreeSet<EvaluatedDescriptionPosNeg>	getCurrentlyBestEvaluatedDescriptions() Returns a sorted set of the best descriptions found so far.
static String	getName()
ScorePosNeg	getSolutionScore()
ScorePosNeg	getSolutionScore(Description d)
Node	getStartNode()
void	init() Method to be called after the component has been configured.
boolean	isRunning() Returns whether the learning algorithm is running.
void	printBestSolutions(int nrOfSolutions)
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

ROLearner

public ROLearner(PosNegLP learningProblem,
                 AbstractReasonerComponent reasoningService)

Method Detail

getConfigurator

public ROLearnerConfigurator 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.

supportedLearningProblems

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

createConfigOptions

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

applyConfigEntry

public <T> void applyConfigEntry(ConfigEntry<T> entry)
                      throws InvalidConfigOptionValueException

Description copied from class: AbstractComponent

Applies a configuration option to this component. Implementations of components should use option and value of the config entry to perform an action (usually setting an internal variable to an appropriate value). Since the availability of configurators, it is optional for components to implement this method. Instead of using this method to take an action based on a configuration value, components can also use the getters defined in the components configurator. Important note: Never call this method directly. All calls are done via the ComponentManager.

Type Parameters:

T - Type of the config entry (Integer, String etc.).

Parameters:

entry - A configuration entry.

Throws:

InvalidConfigOptionValueException - This exception is thrown if the value of the config entry is not valid. For instance, a config option may only accept values, which are within intervals 0.1 to 0.3 or 0.5 to 0.8. If the value is outside of those intervals, an exception is thrown. Note that many of the common cases are already caught in the constructor of ConfigEntry (for instance for a DoubleConfigOption you can specify an interval for the value). This means that, as a component developer, you often do not need to implement further validity checks.

See Also:

AbstractComponent.getConfigurator()

init

public void init()

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.

getName

public static String getName()

start

public void start()

Description copied from interface: LearningAlgorithm

Starts the algorithm. It runs until paused, stopped, or a termination criterion has been reached.

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()

getCurrentlyBestEvaluatedDescription

public EvaluatedDescriptionPosNeg 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<EvaluatedDescriptionPosNeg> 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.

printBestSolutions

public void printBestSolutions(int nrOfSolutions)

getCurrentlyBestDescriptions

public List<Description> getCurrentlyBestDescriptions(int nrOfSolutions)

Specified by:

getCurrentlyBestDescriptions in interface ClassExpressionLearningAlgorithm

Overrides:

getCurrentlyBestDescriptions in class AbstractCELA

Parameters:

nrOfSolutions - Limit for the number or returned descriptions.

Returns:

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

See Also:

AbstractCELA.getCurrentlyBestEvaluatedDescriptions(int)

getSolutionScore

public ScorePosNeg getSolutionScore()

getSolutionScore

public ScorePosNeg getSolutionScore(Description d)

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.

getStartNode

public Node getStartNode()

Returns:

the startNode

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.