Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-association-rules Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 17:06:26 2020 GMT+0.
| • Introduction | What cl-association-rules is all about | |
| • Systems | The systems documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
This project aims to implement the most well known strategies and utilities when mining association rules from a dataset of transactions. For now, only the apriori algorithm is implemented. It works at least on sbcl, ecl, ccl, abcl and clisp.
This section assumes you use quicklisp. If you don't, you should! Download and learn about it here.
Once you have quicklisp loaded, simply do:
(ql:quickload :cl-association-rules)
And it's all up and running. To run the tests do:
(ql:quickload :cl-association-rules-tests)
Please report if any tests fail in your Common Lisp implementation.
To make it easier to write, the cl-association-rules package also has the nickname "rules".
> (ql:quickload :cl-association-rules)
(:CL-ASSOCIATION-RULES)
> (rules:apriori '((1 2 3 4) ;; each of these lines is a transaction
(1 2 4)
(1 2)
(2 3 4)
(2 3)
(3 4)
(2 4)))
((3) => (2). Support is 3/7 and confidence is 3/4.
(4 1) => (2). Support is 2/7 and confidence is 1.
(4) => (2). Support is 4/7 and confidence is 4/5.
(1) => (2). Support is 3/7 and confidence is 1.
(3) => (4). Support is 3/7 and confidence is 3/4.)
Apriori calculates the association rules in "dataset" using the apriori algorithm. Expects a dataset of the form ((1 2 3 4) (3 2 7 9) (9) (2 3 8) (2 0)), where each line is a transaction. You can also costumize the support (defaults to 0.17), the confidence (defaults to 0.68) and the equality operator (defaults to the lisp "equalp" function). The output is a list of mined rules, where each rule is an instance of a struct with fields posttuple, pretuple, support and confidence. This method may signal type-error.
> (defvar *mined-rules* (rules:apriori '((1 2 3 4)
(1 2 3 7)
(1 9)
(2 10 15 4)
(1 3 4 11)
(15 3 1 20))))
*MINED-RULES* ;; ((2 1) => (3). Support is 1/3 and confidence is 1.
;; (3 2) => (1). Support is 1/3 and confidence is 1.
;; (1) => (3). Support is 2/3 and confidence is 4/5.
;; (3) => (1). Support is 2/3 and confidence is 1.)
> (rules:rule-pretuple (first *MINED-RULES*))
(2 1) ;; accessing member "pretuple" of the rule struct. Other members are
;; "posttuple", "support" and "confidence".
If you have any suggestions, bug reports, etc, please fill in an issue describing it. If you have the time and want to contribute, that is even better! Submit some tests too :)
Here is what I'm thinking might make sense to implement next:
MIT
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The cl-association-rules system |
Diogo Franco
MIT
An implementation of the apriori algorithm to mine association rules in Common Lisp.
0.0.1
cl-association-rules.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
| • The cl-association-rules.asd file | ||
| • The cl-association-rules/package.lisp file | ||
| • The cl-association-rules/rule.lisp file | ||
| • The cl-association-rules/apriori.lisp file |
Next: The cl-association-rules/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-association-rules.asd
cl-association-rules (system)
Next: The cl-association-rules/rule․lisp file, Previous: The cl-association-rules․asd file, Up: Lisp files [Contents][Index]
cl-association-rules (system)
package.lisp
Next: The cl-association-rules/apriori․lisp file, Previous: The cl-association-rules/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
cl-association-rules (system)
rule.lisp
Previous: The cl-association-rules/rule․lisp file, Up: Lisp files [Contents][Index]
rule.lisp (file)
cl-association-rules (system)
apriori.lisp
apriori (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The cl-association-rules package |
package.lisp (file)
rules
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported functions |
Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Calculates the association rules in the dataset using the apriori
algorithm. Expects a dataset of the form
((1 2 3 4)
(3 2 7 9)
(9)
(2 3 8)
(2 0)),
where each line is a transaction.
Returns a list of the mined rules.
apriori.lisp (file)
rule.lisp (file)
rule.lisp (file)
rule.lisp (file)
rule.lisp (file)
rule.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal functions | ||
| • Internal structures |
Next: Internal structures, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
rule.lisp (file)
Generates the next candidate set, from the previous frequent and non-frequent itemsets.
apriori.lisp (file)
From the frequent itemsets found by apriori, generate association rules for a given min-confidence.
apriori.lisp (file)
From a dataset, return the unique items as a list.
apriori.lisp (file)
From a candidate set and support threshold, return the items that are frequent and non-frequent in the dataset.
apriori.lisp (file)
rule.lisp (file)
Returns t if two sets of elements are equal
apriori.lisp (file)
Previous: Internal functions, Up: Internal definitions [Contents][Index]
rule.lisp (file)
structure-object (structure)
print-object (method)
rule-pretuple (function)
(setf rule-pretuple) (function)
rule-posttuple (function)
(setf rule-posttuple) (function)
rule-support (function)
(setf rule-support) (function)
rule-confidence (function)
(setf rule-confidence) (function)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index | ||
| • Function index | ||
| • Variable index | ||
| • Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | C F L |
|---|
| Jump to: | C F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | (
A C F G M R S |
|---|
| Jump to: | (
A C F G M R S |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | C P S |
|---|
| Jump to: | C P S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C P R S |
|---|
| Jump to: | C P R S |
|---|