java.lang.Object
- com.bayesserver.learning.structure.HierarchicalStructuralLearningOptions

All Implemented Interfaces:

StructuralLearningOptions
```
public final class HierarchicalStructuralLearningOptions
extends Object
implements StructuralLearningOptions
```
Options for structural learning with the com.bayesserver.learning.structure.hierarchical.HierarchicalStructuralLearning class.

Constructor Summary

Constructors
Constructor Description

HierarchicalStructuralLearningOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`getAddNodeGroups()`	Gets a value which determines whether network node groups are added for each group in a level.
`Cancellation`	`getCancellation()`	Gets of sets the instance implementing `Cancellation`, used for cancellation.
`InferenceFactory`	`getInferenceFactory()`	Gets the inference factory used during scoring.
`LinkConstraintCollection`	`getLinkConstraints()`	Gets any link constraints to use during structural learning.
`Integer`	`getMaximumClustersPerGroup()`	Gets the maximum number of clusters generated for each group.
`Integer`	`getMaximumGroupsPerLevel()`	Gets the maximum number of groups created per level.
`Integer`	`getMaximumIterations()`	Gets the maximum number of iterations used by parameter learning to score each configuration.
`Integer`	`getMaximumLevels()`	Gets the maximum number of levels generated by the algorithm.
`Integer`	`getPartitions()`	Gets the number of cross validation partitions to use when scoring each cluster count.
`StructuralLearningProgress`	`getProgress()`	Gets of sets the instance implementing `StructuralLearningProgress`, used for progress notifications.
`Integer`	`getRunsPerConfiguration()`	Gets the number of times training is re-run for each network structure tested.
`Stop`	`getStopping()`	Gets the instance implementing `Stop` used for early stopping.
`void`	`setAddNodeGroups(boolean value)`	Sets a value which determines whether network node groups are added for each group in a level.
`void`	`setCancellation(Cancellation value)`	Gets of sets the instance implementing `Cancellation`, used for cancellation.
`void`	`setInferenceFactory(InferenceFactory value)`	Sets the inference factory used during scoring.
`void`	`setMaximumClustersPerGroup(Integer value)`	Sets the maximum number of clusters generated for each group.
`void`	`setMaximumGroupsPerLevel(Integer value)`	Sets the maximum number of groups created per level.
`void`	`setMaximumIterations(Integer value)`	Sets the maximum number of iterations used by parameter learning to score each configuration.
`void`	`setMaximumLevels(Integer value)`	Sets the maximum number of levels generated by the algorithm.
`void`	`setPartitions(Integer value)`	Sets the number of cross validation partitions to use when scoring each cluster count.
`void`	`setProgress(StructuralLearningProgress value)`	Gets of sets the instance implementing `StructuralLearningProgress`, used for progress notifications.
`void`	`setRunsPerConfiguration(Integer value)`	Sets the number of times training is re-run for each network structure tested.
`void`	`setStopping(Stop value)`	Sets the instance implementing `Stop` used for early stopping.

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

- Constructor Detail
  - HierarchicalStructuralLearningOptions
```
public HierarchicalStructuralLearningOptions()
```
- Method Detail
  - getMaximumLevels
```
public Integer getMaximumLevels()
```
    Gets the maximum number of levels generated by the algorithm. A level refers to the set of latent variables introduced by the algorithm at each stage of learning, to group variables together.
  - setMaximumLevels
```
public void setMaximumLevels(Integer value)
```
    Sets the maximum number of levels generated by the algorithm. A level refers to the set of latent variables introduced by the algorithm at each stage of learning, to group variables together.
  - getPartitions
```
public Integer getPartitions()
```
    Gets the number of cross validation partitions to use when scoring each cluster count. The higher the number, the longer the tests will take.
  - setPartitions
```
public void setPartitions(Integer value)
```
    Sets the number of cross validation partitions to use when scoring each cluster count. The higher the number, the longer the tests will take.
  - getRunsPerConfiguration
```
public Integer getRunsPerConfiguration()
```
    Gets the number of times training is re-run for each network structure tested. The higher the number, the longer the tests will take, but the more accurate the tests will be.
  - setRunsPerConfiguration
```
public void setRunsPerConfiguration(Integer value)
```
    Sets the number of times training is re-run for each network structure tested. The higher the number, the longer the tests will take, but the more accurate the tests will be.
  - getMaximumIterations
```
public Integer getMaximumIterations()
```
    Gets the maximum number of iterations used by parameter learning to score each configuration. The higher the number, the longer the tests will take.
  - setMaximumIterations
```
public void setMaximumIterations(Integer value)
```
    Sets the maximum number of iterations used by parameter learning to score each configuration. The higher the number, the longer the tests will take.
  - getAddNodeGroups
```
public boolean getAddNodeGroups()
```
    Gets a value which determines whether network node groups are added for each group in a level.
  - setAddNodeGroups
```
public void setAddNodeGroups(boolean value)
```
    Sets a value which determines whether network node groups are added for each group in a level.
  - getMaximumGroupsPerLevel
```
public Integer getMaximumGroupsPerLevel()
```
    Gets the maximum number of groups created per level.
  - setMaximumGroupsPerLevel
```
public void setMaximumGroupsPerLevel(Integer value)
```
    Sets the maximum number of groups created per level.
  - getMaximumClustersPerGroup
```
public Integer getMaximumClustersPerGroup()
```
    Gets the maximum number of clusters generated for each group.
  - setMaximumClustersPerGroup
```
public void setMaximumClustersPerGroup(Integer value)
```
    Sets the maximum number of clusters generated for each group.
  - getInferenceFactory
```
public InferenceFactory getInferenceFactory()
```
    Gets the inference factory used during scoring.
  - setInferenceFactory
```
public void setInferenceFactory(InferenceFactory value)
```
    Sets the inference factory used during scoring.
  - getProgress
```
public StructuralLearningProgress getProgress()
```
    Gets of sets the instance implementing StructuralLearningProgress, used for progress notifications.
    
    Specified by:
    
    getProgress in interface StructuralLearningOptions
  - setProgress
```
public void setProgress(StructuralLearningProgress value)
```
    Gets of sets the instance implementing StructuralLearningProgress, used for progress notifications.
    
    Specified by:
    
    setProgress in interface StructuralLearningOptions
  - getStopping
```
public Stop getStopping()
```
    Gets the instance implementing Stop used for early stopping. Stopping is different to cancellation, as stopping will still complete the learning process, albeit having not run to completion.
    
    Specified by:
    
    getStopping in interface StructuralLearningOptions
    
    Returns:
    
    The instance used for stopping.
  - setStopping
```
public void setStopping(Stop value)
```
    Sets the instance implementing Stop used for early stopping. Stopping is different to cancellation, as stopping will still complete the learning process, albeit having not run to completion.
    
    Specified by:
    
    setStopping in interface StructuralLearningOptions
    
    Parameters:
    
    value - The instance used for stopping.
  - getCancellation
```
public Cancellation getCancellation()
```
    Gets of sets the instance implementing Cancellation, used for cancellation.
    
    Specified by:
    
    getCancellation in interface StructuralLearningOptions
    
    See Also:
    
    Cancellation
  - setCancellation
```
public void setCancellation(Cancellation value)
```
    Gets of sets the instance implementing Cancellation, used for cancellation.
    
    Specified by:
    
    setCancellation in interface StructuralLearningOptions
    
    See Also:
    
    Cancellation
  - getLinkConstraints
```
public LinkConstraintCollection getLinkConstraints()
```
    Gets any link constraints to use during structural learning.
    
    Specified by:
    
    getLinkConstraints in interface StructuralLearningOptions

Class HierarchicalStructuralLearningOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HierarchicalStructuralLearningOptions

Method Detail

getMaximumLevels

setMaximumLevels

getPartitions

setPartitions

getRunsPerConfiguration

setRunsPerConfiguration

getMaximumIterations

setMaximumIterations

getAddNodeGroups

setAddNodeGroups

getMaximumGroupsPerLevel

setMaximumGroupsPerLevel

getMaximumClustersPerGroup

setMaximumClustersPerGroup

getInferenceFactory

setInferenceFactory

getProgress

setProgress

getStopping

setStopping

getCancellation

setCancellation

getLinkConstraints