Skip to content

Commit

Permalink
Update apriori documentation (#245)
Browse files Browse the repository at this point in the history
* Fix a wrong word

* More precise description about support and confidence
  • Loading branch information
y-uti authored and akondas committed Feb 27, 2018
1 parent d188790 commit 9c19555
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/machine-learning/association/apriori.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Association rule learning based on [Apriori algorithm](https://en.wikipedia.org/

### Constructor Parameters

* $support - [confidence](https://en.wikipedia.org/wiki/Association_rule_learning#Support), minimum relative amount of frequent item set in train sample
* $confidence - [confidence](https://en.wikipedia.org/wiki/Association_rule_learning#Confidence), minimum relative amount of item set in frequent item sets
* $support - minimum threshold of [support](https://en.wikipedia.org/wiki/Association_rule_learning#Support), i.e. the ratio of samples which contain both X and Y for a rule "if X then Y"
* $confidence - minimum threshold of [confidence](https://en.wikipedia.org/wiki/Association_rule_learning#Confidence), i.e. the ratio of samples containing both X and Y to those containing X

```
use Phpml\Association\Apriori;
Expand Down Expand Up @@ -44,7 +44,7 @@ $associator->predict([['alpha','epsilon'],['beta','theta']]);
### Associating

Get generated association rules simply use `rules` method.

```
$associator->getRules();
// return [['antecedent' => ['alpha', 'theta'], 'consequent' => ['beta'], 'support' => 1.0, 'confidence' => 1.0], ... ]
Expand Down

0 comments on commit 9c19555

Please sign in to comment.