Class Ion
- All Implemented Interfaces:
Algorithm, MultiDataSetAlgorithm, HasParameters, TakesIndependenceWrapper, TakesScoreWrapper, TetradSerializable, Serializable
BFCI is used for the per-dataset searches, rather than FCI, because ION's correctness argument requires that its inputs be legal PAGs, and FCI is not guaranteed to produce a legal PAG, whereas BFCI is designed to. For oracle experiments the analogous choice is GRaSP-FCI with the m-separation test and score.
Reference: Danks, D., Glymour, C., & Tillman, R. E. (2008). Integrating locally learned causal structures with overlapping variables. In Advances in Neural Information Processing Systems 21 (NIPS 2008), pp. 1665-1672.
ION returns an equivalence class of PAGs, which may contain more than one graph; all of them are printed to the log. Since this interface must return a single graph, the graph with the fewest edges is returned, with ties broken by a lexicographic comparison of the printed edge lists, so that the choice is deterministic. If the input PAGs are jointly inconsistent (which can happen when they are estimated from finite samples of different datasets), ION may return no graphs at all; in that case an edgeless graph over the union of the variables is returned and a warning is logged.
Note that ION is exponential in the number of variables and is intended for problems with a small number of variables.
- Version:
- $Id: $Id
- Author:
- josephramsey
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionIon()Constructor for Ion.Ion(IndependenceWrapper test, ScoreWrapper score) Constructor for Ion. -
Method Summary
Modifier and TypeMethodDescriptiongetComparisonGraph(Graph graph) Returns that graph that the result should be compared to.Returns the data type that the search requires, whether continuous, discrete, or mixed.Returns a short, one-line description of this algorithm.Returns the independence wrapper.Returns the list of parameter names that are used.Returns the score wrapper.search(DataModel dataSet, Parameters parameters) Runs the search.search(List<DataModel> dataSets, Parameters parameters) Runs the search.voidSets the independence wrapper.voidsetScoreWrapper(ScoreWrapper score) Sets a score wrapper if not null.
-
Constructor Details
-
Ion
Constructor for Ion.
- Parameters:
test- aIndependenceWrapperobjectscore- aScoreWrapperobject
-
Ion
public Ion()Constructor for Ion.
-
-
Method Details
-
search
Runs the search.- Specified by:
searchin interfaceMultiDataSetAlgorithm- Parameters:
dataSets- The data sets.parameters- The parameters.- Returns:
- The graph.
- Throws:
InterruptedException- if any.
-
setScoreWrapper
Sets a score wrapper if not null.- Specified by:
setScoreWrapperin interfaceMultiDataSetAlgorithm- Specified by:
setScoreWrapperin interfaceTakesScoreWrapper- Parameters:
score- The wrapper
-
getScoreWrapper
Returns the score wrapper.- Specified by:
getScoreWrapperin interfaceTakesScoreWrapper- Returns:
- the score wrapper.
-
search
Runs the search.- Specified by:
searchin interfaceAlgorithm- Parameters:
dataSet- The data set to run to the search on.parameters- The paramters of the search.- Returns:
- The result graph.
- Throws:
InterruptedException- if any.
-
getComparisonGraph
Returns that graph that the result should be compared to.- Specified by:
getComparisonGraphin interfaceAlgorithm- Parameters:
graph- The true directed graph, if there is one.- Returns:
- The comparison graph.
-
getDescription
Returns a short, one-line description of this algorithm. This will be printed in the report.- Specified by:
getDescriptionin interfaceAlgorithm- Returns:
- This description.
-
getDataType
Returns the data type that the search requires, whether continuous, discrete, or mixed.- Specified by:
getDataTypein interfaceAlgorithm- Returns:
- This type.
-
getParameters
Returns the list of parameter names that are used. These are looked up in ParamMap, so if they're not- Specified by:
getParametersin interfaceHasParameters- Returns:
- Returns the list of parameter names that are used. These are looked up in ParamMap, so if they're not already defined they'll need to be defined there.
-
getIndependenceWrapper
Returns the independence wrapper.- Specified by:
getIndependenceWrapperin interfaceTakesIndependenceWrapper- Returns:
- the independence wrapper.
-
setIndependenceWrapper
Sets the independence wrapper.- Specified by:
setIndependenceWrapperin interfaceTakesIndependenceWrapper- Parameters:
test- the independence wrapper.
-