Skip to content

Latest commit

 

History

History
324 lines (311 loc) · 14.7 KB

available_structure_learning_algorithms.rst

File metadata and controls

324 lines (311 loc) · 14.7 KB

Algorithms

.. toctree::
    :hidden:
    :glob:
    :maxdepth: 3
    :name: Structure learning algorithms
    :caption: Structure learning algorithms

    structure_learning_algorithms/athomas_jtsamplers
    structure_learning_algorithms/bdgraph
    structure_learning_algorithms/bidag_itsearch
    structure_learning_algorithms/bidag_order_mcmc
    structure_learning_algorithms/bidag_partition_mcmc
    structure_learning_algorithms/bnlearn_fastiamb
    structure_learning_algorithms/bnlearn_gs
    structure_learning_algorithms/bnlearn_h2pc
    structure_learning_algorithms/bnlearn_hc
    structure_learning_algorithms/bnlearn_hpc
    structure_learning_algorithms/bnlearn_iamb
    structure_learning_algorithms/bnlearn_iambfdr
    structure_learning_algorithms/bnlearn_interiamb
    structure_learning_algorithms/bnlearn_mmhc
    structure_learning_algorithms/bnlearn_mmpc
    structure_learning_algorithms/bnlearn_pcstable
    structure_learning_algorithms/bnlearn_rsmax2
    structure_learning_algorithms/bnlearn_sihitonpc
    structure_learning_algorithms/bnlearn_tabu
    structure_learning_algorithms/causaldag_gsp
    structure_learning_algorithms/causallearn_ges
    structure_learning_algorithms/causallearn_grasp
    structure_learning_algorithms/corr_thresh
    structure_learning_algorithms/dualpc
    structure_learning_algorithms/equsa_psilearner
    structure_learning_algorithms/gcastle_anm
    structure_learning_algorithms/gcastle_corl
    structure_learning_algorithms/gcastle_direct_lingam
    structure_learning_algorithms/gcastle_gae
    structure_learning_algorithms/gcastle_golem
    structure_learning_algorithms/gcastle_grandag
    structure_learning_algorithms/gcastle_ica_lingam
    structure_learning_algorithms/gcastle_mcsl
    structure_learning_algorithms/gcastle_notears
    structure_learning_algorithms/gcastle_notears_low_rank
    structure_learning_algorithms/gcastle_notears_nonlinear
    structure_learning_algorithms/gcastle_pc
    structure_learning_algorithms/gcastle_rl
    structure_learning_algorithms/gobnilp
    structure_learning_algorithms/grues
    structure_learning_algorithms/huge_glasso
    structure_learning_algorithms/huge_mb
    structure_learning_algorithms/huge_tiger
    structure_learning_algorithms/paralleldg
    structure_learning_algorithms/pcalg_gies
    structure_learning_algorithms/pcalg_pc
    structure_learning_algorithms/prec_thresh
    structure_learning_algorithms/rblip_asobs
    structure_learning_algorithms/sklearn_glasso
    structure_learning_algorithms/tetrad_boss
    structure_learning_algorithms/tetrad_fas
    structure_learning_algorithms/tetrad_fask
    structure_learning_algorithms/tetrad_fges
    structure_learning_algorithms/tetrad_fofc
    structure_learning_algorithms/tetrad_ftfc
    structure_learning_algorithms/tetrad_grasp
    structure_learning_algorithms/tetrad_ica-lingam
    structure_learning_algorithms/tetrad_pc
    structure_learning_algorithms/trilearn_pgibbs


Apart from the original parameters of the underlying software, each algorithm module is equipped with an additional parameter, timeout, which is the maximum time in seconds allowed for the algorithm to run. After the timeout, the algorithm will be terminated and either an empty file will be created or the current best graph will be saved (if the algorithm supports that).

Modules for MCMC algorithms can be used seamlessly with the other modules. However, apart from the original parameters and timeout, these modules have four additional fields:

  • mcmc_seed is the random seed for the algorithm.
  • mcmc_estimator specifies which estimator to use (threshold or map).
  • threshold specifies the threshold for the posterior edge probabilities if mcmc_estimator is set to threshold.
  • burnin_frac is a value in (0, 1) that specifies the fraction of the samples at the beginning of the graph trajectory to be discarded as burn-in.

The available modules are listed below. To add new modules, see :ref:`new_modules`.

Algorithm Graph Package Module
Chordal graph samplers DG Alun Thomas :ref:`athomas_jtsamplers`
BDgraph UG BDgraph :ref:`bdgraph`
Iterative MCMC DAG, CPDAG BiDAG :ref:`bidag_itsearch`
Order MCMC DAG, CPDAG BiDAG :ref:`bidag_order_mcmc`
Partition MCMC DAG, CPDAG BiDAG :ref:`bidag_partition_mcmc`
Fast IAMB DAG bnlearn :ref:`bnlearn_fastiamb`
Grow-shrink DAG bnlearn :ref:`bnlearn_gs`
H2PC DAG bnlearn :ref:`bnlearn_h2pc`
HC DAG bnlearn :ref:`bnlearn_hc`
HPC DAG bnlearn :ref:`bnlearn_hpc`
IAMB DAG bnlearn :ref:`bnlearn_iamb`
IAMB-FDR DAG bnlearn :ref:`bnlearn_iambfdr`
INTER-IAMB DAG bnlearn :ref:`bnlearn_interiamb`
MMHC DAG bnlearn :ref:`bnlearn_mmhc`
MMPC DAG bnlearn :ref:`bnlearn_mmpc`
PC DAG bnlearn :ref:`bnlearn_pcstable`
RSMAX2 DAG bnlearn :ref:`bnlearn_rsmax2`
S-I HITON-PC DAG bnlearn :ref:`bnlearn_sihitonpc`
Tabu DAG bnlearn :ref:`bnlearn_tabu`
GSP DAG CausalDAG :ref:`causaldag_gsp`
GRaSP CPDAG causal-learn :ref:`causallearn_grasp`
Corrmat thresh UG Benchpress :ref:`corr_thresh`
Dual PC CG, CPDAG dualPC :ref:`dualpc`
Psi-learning UG equSA :ref:`equsa_psilearner`
ANM DAG gCastle :ref:`gcastle_anm`
CORL DAG gCastle :ref:`gcastle_corl`
Direct LINGAM DAG gCastle :ref:`gcastle_direct_lingam`
GAE DAG gCastle :ref:`gcastle_gae`
GOLEM DAG gCastle :ref:`gcastle_golem`
GraNDAG DAG gCastle :ref:`gcastle_grandag`
ICALiNGAM DAG gCastle :ref:`gcastle_ica_lingam`
MCSL DAG gCastle :ref:`gcastle_mcsl`
NO TEARS DAG gCastle :ref:`gcastle_notears`
NO TEARS low rank DAG gCastle :ref:`gcastle_notears_low_rank`
NO TEARS non-linear DAG gCastle :ref:`gcastle_notears_nonlinear`
PC DAG gCastle :ref:`gcastle_pc`
RL DAG gCastle :ref:`gcastle_rl`
GOBNILP DAG GOBNILP (BitBucket) :ref:`gobnilp`
GrUES UDG gues :ref:`grues`
Graphical lasso UG huge :ref:`huge_glasso`
Meinshausen & Buhlmann cov est UG huge :ref:`huge_mb`
TIGER UG huge :ref:`huge_tiger`
Parallel DG DG parallelDG :ref:`paralleldg`
GIES CPDAG pcalg :ref:`pcalg_gies`
PC CPDAG, CG pcalg :ref:`pcalg_pc`
Precmat thresh UG Benchpress :ref:`prec_thresh`
ASOBS DAG r.blip :ref:`rblip_asobs`
Graphical Lasso UG scikit-learn :ref:`sklearn_glasso`
BOSS CPDAG causal-cmd :ref:`tetrad_boss`
FASK DAG causal-cmd :ref:`tetrad_fask`
FGES CPDAG causal-cmd :ref:`tetrad_fges`
FOFC DAG causal-cmd :ref:`tetrad_fofc`
FTFC DAG causal-cmd :ref:`tetrad_ftfc`
GRaSP CPDAG causal-cmd :ref:`tetrad_grasp`
ICA-LINGAM DAG causal-cmd :ref:`tetrad_ica-lingam`
PC DAG causal-cmd :ref:`tetrad_pc`
Particle Gibbs DG trilearn :ref:`trilearn_pgibbs`