Skip to content

Commit 3f9fa9a

Browse files
committed
Small improvements in the advanced section
1 parent 7bc7866 commit 3f9fa9a

File tree

1 file changed

+34
-10
lines changed

1 file changed

+34
-10
lines changed

docs/src/advanced.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,6 @@ CurrentModule = ModalAssociationRules
44

55
# [Advanced usage](@id advanced-usage)
66

7-
The following utilities often involve performing some combinatoric trick between [`Itemset`](@ref)s and [`ARule`](@ref)s, and might be useful to avoid reinventing the wheel.
8-
9-
## Items and Itemsets
10-
11-
```@docs
12-
combine_items
13-
grow_prune
14-
```
15-
167
## Mining Policies
178

189
It is possible to limit the action of the mining, to force an [`AbstractMiner`](@ref) to only consider a subset of the available data.
@@ -38,4 +29,37 @@ arule_policies
3829
islimited_length_arule
3930
isanchored_arule
4031
isheterogeneous_arule
41-
```
32+
```
33+
34+
To apply the policies, simply call the following.
35+
36+
```@docs
37+
Base.filter!(targets::Vector{Union{ARule,Itemset}}, policies_pool::Vector{Function})
38+
```
39+
40+
## Anchored semantics
41+
42+
To ensure the mining process is *fair* when dealing with modal operators, we must ensure that the miner is compliant with *anchored semantics constraints*.
43+
44+
```@docs
45+
isanchored_miner
46+
anchored_apriori
47+
anchored_fpgrowth
48+
anchored_eclat
49+
```
50+
51+
Each algorithm above is simply a small wrapper around [`anchored_semantics`](@ref):
52+
53+
```@docs
54+
anchored_semantics
55+
```
56+
57+
## Utilities
58+
59+
The following utilities often involve performing some combinatoric trick between [`Itemset`](@ref)s and [`ARule`](@ref)s, and might be useful to avoid reinventing the wheel.
60+
61+
```@docs
62+
combine_items
63+
grow_prune
64+
anchored_grow_prune
65+
```

0 commit comments

Comments
 (0)