public final class SearchStructuralLearningOptions extends Object implements StructuralLearningOptions
com.bayesserver.learning.structure.search.SearchStructuralLearning
class.Constructor and Description |
---|
SearchStructuralLearningOptions() |
Modifier and Type | Method and Description |
---|---|
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 |
getMaximumIterations()
Gets the optional maximum number of iterations (moves) made during the search procedure.
|
int |
getPartitionCount()
Gets the number of partitions used by scoring functions that use cross validation.
|
StructuralLearningProgress |
getProgress()
Gets of sets the instance implementing
StructuralLearningProgress , used for progress notifications. |
ScoreMethod |
getScoreMethod()
Gets the scoring method used to evaluate search moves.
|
Stop |
getStopping()
Gets the instance implementing
Stop used for early stopping. |
boolean |
getTestIndependence()
Gets a value which when true uses independence tests to reduce the search space.
|
Double |
getTolerance()
Gets the tolerance used to determine whether or not a search move is a significant improvement.
|
double |
getToleranceOrDefault()
If Tolerance is null, this returns the default tolerance for the given scoring method, otherwise Tolerance is returned.
|
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 |
setMaximumIterations(Integer value)
Sets the optional maximum number of iterations (moves) made during the search procedure.
|
void |
setPartitionCount(int value)
Sets the number of partitions used by scoring functions that use cross validation.
|
void |
setProgress(StructuralLearningProgress value)
Gets of sets the instance implementing
StructuralLearningProgress , used for progress notifications. |
void |
setScoreMethod(ScoreMethod value)
Sets the scoring method used to evaluate search moves.
|
void |
setStopping(Stop value)
Sets the instance implementing
Stop used for early stopping. |
void |
setTestIndependence(boolean value)
Sets a value which when true uses independence tests to reduce the search space.
|
void |
setTolerance(Double value)
Sets the tolerance used to determine whether or not a search move is a significant improvement.
|
public int getPartitionCount()
public void setPartitionCount(int value)
public StructuralLearningProgress getProgress()
StructuralLearningProgress
, used for progress notifications.getProgress
in interface StructuralLearningOptions
public void setProgress(StructuralLearningProgress value)
StructuralLearningProgress
, used for progress notifications.setProgress
in interface StructuralLearningOptions
public Integer getMaximumIterations()
public void setMaximumIterations(Integer value)
public double getToleranceOrDefault()
public Double getTolerance()
When null, a default value is used which depends on the Score Method in use.
public void setTolerance(Double value)
When null, a default value is used which depends on the Score Method in use.
value
- The tolerance.public ScoreMethod getScoreMethod()
public void setScoreMethod(ScoreMethod value)
public InferenceFactory getInferenceFactory()
public void setInferenceFactory(InferenceFactory value)
public Stop getStopping()
Stop
used for early stopping.
Stopping is different to cancellation, as stopping will still complete the learning process, albeit having performed fewer iterations.public void setStopping(Stop value)
Stop
used for early stopping.
Stopping is different to cancellation, as stopping will still complete the learning process, albeit having performed fewer iterations.value
- The instance used for stopping.public Cancellation getCancellation()
Cancellation
, used for cancellation.getCancellation
in interface StructuralLearningOptions
Cancellation
public void setCancellation(Cancellation value)
Cancellation
, used for cancellation.setCancellation
in interface StructuralLearningOptions
Cancellation
public LinkConstraintCollection getLinkConstraints()
getLinkConstraints
in interface StructuralLearningOptions
public boolean getTestIndependence()
public void setTestIndependence(boolean value)
Copyright © 2021. All rights reserved.