com.bayesia.api.learning.settings

Class ParameterEstimationSettings

java.lang.Object

com.bayesia.api.learning.settings.AbstractLearningSettings

com.bayesia.api.learning.settings.ParameterEstimationSettings

All Implemented Interfaces:

LearningSettings, java.lang.Cloneable

public class ParameterEstimationSettings
extends AbstractLearningSettings

Learning settings for the parameter learning algorithm.

Version:

4.2

Author:

Bayesia S.A.S.

Method Summary

Modifier and Type	Method and Description
ParameterEstimationSettings	copy() Make a deep copy of the learning settings.
static ParameterEstimationSettings	createDefault() Create an instance of the learning settings initialized with the default parameters for this algorithm.
APIUtils.LEARNING_ALGORITHM	getLearningAlgorithm() Return a LEARNING_ALGORITHM indicating the learning algorithm to use
java.lang.String	getTargetNodeName() Return the name of the target node if the learning algorithm is supervised.
boolean	isSupervised() Indicate if the current learning algorithm is supervised (i.e. it needs a target) or not.
boolean	isValid() Test if the current settings are valid.
java.lang.String	toString()

Methods inherited from class com.bayesia.api.learning.settings.AbstractLearningSettings

getSmoothedProbabilityEstimation, getStructuralCoefficient, isVerbose, setSmoothedProbabilityEstimation, setStructuralCoefficient, setVerbose

Methods inherited from class java.lang.Object

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

Method Detail

copy

public ParameterEstimationSettings copy()

Description copied from interface: LearningSettings

Make a deep copy of the learning settings.

Returns:

a deep copy of the current instance

createDefault

public static ParameterEstimationSettings createDefault()

Create an instance of the learning settings initialized with the default parameters for this algorithm.

Returns:

the learning settings

toString

public java.lang.String toString()

Specified by:

toString in interface LearningSettings

Overrides:

toString in class AbstractLearningSettings

getLearningAlgorithm

public APIUtils.LEARNING_ALGORITHM getLearningAlgorithm()

Description copied from interface: LearningSettings

Return a LEARNING_ALGORITHM indicating the learning algorithm to use

Returns:

the learning algorithm to use

isSupervised

public boolean isSupervised()

Description copied from interface: LearningSettings

Indicate if the current learning algorithm is supervised (i.e. it needs a target) or not.

Returns:

true if the learning algorithm is supervised, false if unsupervised. APIUtils.LEARNING_ALGORITHM.isSupervised()

getTargetNodeName

public java.lang.String getTargetNodeName()

Description copied from interface: LearningSettings

Return the name of the target node if the learning algorithm is supervised.

Returns:

the target node's name

isValid

public boolean isValid()

Description copied from interface: LearningSettings

Test if the current settings are valid.

Returns:

true if the settings are valid, false otherwise