Available algorithms

apriori(miner::Miner; verbose::Bool=true)::Nothing

Apriori algorithm, as described here but generalized to also work with modal logic.

Arguments

• miner::M: miner containing the data and the extraction parameterization;
• prune_strategy::Function=grow_prune: strategy to prune candidates between one iteration

and the successive;

• verbose::Bool=false: print informations about each iteration.

See also grow_prune, Miner, MineableData.

fpgrowth(miner::AbstractMiner; verbose::Bool=true)::Nothing

(Modal) FP-Growth algorithm, as described here.

Arguments

• miner: miner containing the extraction parameterization;
• X: data from which you want to mine association rules;
• parallel: enable multi-threaded execution, using Threads.nthreads() threads;
• distributed: enable multi-processing execution, with Distributed.nworkers() processes;
• verbose: print detailed informations while the algorithm runs.

Requirements

This implementation requires a custom Bulldozer constructor capable of handling the given AbstractMiner. In particular, the following dispatch must be implemented:

Bulldozer(miner::MyMinerType, ith_instance::Integer)

See also AbstractMiner, Bulldozer, FPTree, HeaderTable, SoleBase.AbstractDataset

patternbase(
    item::Item,
    htable::HeaderTable,
    miner::AbstractMiner
)::ConditionalPatternBase

Retrieve the ConditionalPatternBase of fptree based on item.

The conditional pattern based on a FPTree is the set of all the paths from the tree root to nodes containing item (not included). Each of these paths is represented by an EnhancedItemset.

The EnhancedItemsets in the returned ConditionalPatternBase are sorted decreasingly by gsupport.

See also AbstractMiner, ConditionalPatternBase, EnhancedItemset, fpgrowth, FPTree, Item, Itemset, WorldMask.

function projection(pbase::ConditionalPatternBase, miner::AbstractMiner)

Return respectively a FPTree and a HeaderTable starting from pbase. An AbstractMiner must be provided to guarantee the generated header table internal state is OK, that is, its items are sorted decreasingly by gsupport.

See also ConditionalPatternBase, FPTree, gsupport, HeaderTable, AbstractMiner.

initminingstate(::typeof(fpgrowth), ::MineableData)::MiningState

MiningState fields levereged when executing FP-Growth algorithm.

See also hasminingstate, MiningState, miningstate.