SupervisedLearningSettings (Bayesia Engine Javadoc)

java.lang.Object
- com.bayesia.api.learning.settings.AbstractLearningSettings
- - com.bayesia.api.learning.settings.SupervisedLearningSettings

All Implemented Interfaces:

LearningSettings, java.lang.Cloneable

Direct Known Subclasses:

MarkovBlanketSettings, NaiveSettings
```
public abstract class SupervisedLearningSettings
extends AbstractLearningSettings
```

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract SupervisedLearningSettings`	`copy()` Make a deep copy of the learning settings.
`double`	`getMarkovBlanketRestrictionFrequencyThreshold()`
`long`	`getMarkovBlanketRestrictionSeed()`
`int`	`getMarkovBlanketRestrictionTestCount()`
`java.lang.String`	`getTargetNodeName()` Return the name of the target node if the learning algorithm is supervised.
`boolean`	`isMarkovBlanketRestrictionBlocked()`
`boolean`	`isMarkovBlanketRestrictionEnabled()`
`boolean`	`isMarkovBlanketRestrictionFixedSeed()`
`boolean`	`isMarkovBlanketRestrictionUsed()`
`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.
`void`	`setMarkovBlanketRestrictionBlocked(boolean markovBlanketBlocked)`
`void`	`setMarkovBlanketRestrictionEnabled(boolean markovBlanketEnabled)`
`void`	`setMarkovBlanketRestrictionFixedSeed(boolean fixedSeed)`
`void`	`setMarkovBlanketRestrictionFrequencyThreshold(double frequencyThreshold)`
`void`	`setMarkovBlanketRestrictionSeed(long seed)`
`void`	`setMarkovBlanketRestrictionTestCount(int testCount)`
`void`	`setMarkovBlanketRestrictionUsed(boolean markovBlanket)`
`void`	`setTargetNodeName(java.lang.String target)`
`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

Methods inherited from interface com.bayesia.api.learning.settings.LearningSettings
getLearningAlgorithm

- Method Detail
  - copy
```
public abstract SupervisedLearningSettings copy()
```
    Description copied from interface: LearningSettings
    
    Make a deep copy of the learning settings.
    
    Returns:
    
    a deep copy of the current instance
  - isMarkovBlanketRestrictionUsed
```
public boolean isMarkovBlanketRestrictionUsed()
```
  - setMarkovBlanketRestrictionUsed
```
public void setMarkovBlanketRestrictionUsed(boolean markovBlanket)
```
  - isMarkovBlanketRestrictionEnabled
```
public boolean isMarkovBlanketRestrictionEnabled()
```
  - setMarkovBlanketRestrictionEnabled
```
public void setMarkovBlanketRestrictionEnabled(boolean markovBlanketEnabled)
```
  - isMarkovBlanketRestrictionBlocked
```
public boolean isMarkovBlanketRestrictionBlocked()
```
  - setMarkovBlanketRestrictionBlocked
```
public void setMarkovBlanketRestrictionBlocked(boolean markovBlanketBlocked)
```
  - getMarkovBlanketRestrictionTestCount
```
public int getMarkovBlanketRestrictionTestCount()
```
  - setMarkovBlanketRestrictionTestCount
```
public void setMarkovBlanketRestrictionTestCount(int testCount)
```
  - getMarkovBlanketRestrictionFrequencyThreshold
```
public double getMarkovBlanketRestrictionFrequencyThreshold()
```
  - setMarkovBlanketRestrictionFrequencyThreshold
```
public void setMarkovBlanketRestrictionFrequencyThreshold(double frequencyThreshold)
```
  - isMarkovBlanketRestrictionFixedSeed
```
public boolean isMarkovBlanketRestrictionFixedSeed()
```
  - setMarkovBlanketRestrictionFixedSeed
```
public void setMarkovBlanketRestrictionFixedSeed(boolean fixedSeed)
```
  - getMarkovBlanketRestrictionSeed
```
public long getMarkovBlanketRestrictionSeed()
```
  - setMarkovBlanketRestrictionSeed
```
public void setMarkovBlanketRestrictionSeed(long seed)
```
  - 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
  - setTargetNodeName
```
public void setTargetNodeName(java.lang.String target)
```
  - 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()
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface LearningSettings
    
    Overrides:
    
    toString in class AbstractLearningSettings
  - 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

Class SupervisedLearningSettings

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.bayesia.api.learning.settings.LearningSettings

Method Detail

copy

isMarkovBlanketRestrictionUsed

setMarkovBlanketRestrictionUsed

isMarkovBlanketRestrictionEnabled

setMarkovBlanketRestrictionEnabled

isMarkovBlanketRestrictionBlocked

setMarkovBlanketRestrictionBlocked

getMarkovBlanketRestrictionTestCount

setMarkovBlanketRestrictionTestCount

getMarkovBlanketRestrictionFrequencyThreshold

setMarkovBlanketRestrictionFrequencyThreshold

isMarkovBlanketRestrictionFixedSeed

setMarkovBlanketRestrictionFixedSeed

getMarkovBlanketRestrictionSeed

setMarkovBlanketRestrictionSeed

getTargetNodeName

setTargetNodeName

isSupervised

toString

isValid