Metadata-Version: 2.1
Name: FIMProject
Version: 0.0.4
Summary: FIM Algorithms package for ARM
Home-page: https://github.com/fatihsen20/FIM
Author: Fatih Sen
Author-email: fatih.sn2000@gmail.com
Keywords: FIM,Frequent Itemset Mining,Association Rule Mining,ARM
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: numpy
Requires-Dist: numpy ; extra == 'numpy'

 # How to Install
```shell
pip install FIMProject
```
# How to Use It
```python
from FIM.FIMAlgorithms import Apriori

ap = Apriori(DATABASE, SingleItems, 2)
freq = ap.findFrequentItems()
ap.showFrequentItems()
ap.showRules(0.9, 0.4)
```
# What is DATABASE and SingleItems?  

<p>The database consisting of string items is represented as a binary database as can be seen in the figure. There are as many columns as the number of single items. If there is an item in the line, it is represented by "1", otherwise it is represented by "0". The reason we keep the database as a binary database is that it is more costly to calculate over strings. All algorithms in this library work on this type of database.</p>         

<table>
  <tr>
    <th>Index</th>
    <th>String Transaction</th>
    <th>Indices Transaction</th>
  </tr>
  <tr>
  	<td>0</td>
    <td>['A' 'B' 'E' 'G']</td>
    <td>[1 1 0 0 1 0 1]</td>
  </tr>
  <tr>
    <td>1</td>
    <td>['B' 'C' 'E' 'F']</td>
    <td>[0 1 1 0 1 1 0]</td>
  </tr>
  <tr>
    <td>2</td>
    <td>['A' 'E' 'F']</td>
    <td>[1 0 0 0 1 1 0]</td>
  </tr>
  <tr>
    <td>3</td>
    <td>['B' 'F' 'G']</td>
    <td>[0 1 0 0 0 1 1]</td>
  </tr>
  <tr>
    <td>4</td>
    <td>['A' 'B' 'D' 'E']</td>
    <td>[1 1 0 1 1 0 0]</td>
  </tr>
  <tr>
    <td>5</td>
    <td>['A' 'F' 'G']</td>
    <td>[1 0 0 0 0 1 1]</td>
  </tr>
  <tr>
    <td>6</td>
    <td>['A' 'B' 'D' 'E' 'F' 'G']</td>
    <td>[1 1 0 1 1 1 1]</td>
  </tr>
  <tr>
    <td>7</td>
    <td>['A' 'B' 'E' 'F']</td>
    <td>[1 1 0 0 1 1 0]</td>
  </tr>
  <tr>
    <td>8</td>
    <td>['B' 'C' 'D' 'F']</td>
    <td>[0 1 1 1 0 1 0]</td>
  </tr>
  <tr>
    <td>9</td>
    <td>['A' 'E' 'F' 'G']</td>
    <td>[1 0 0 0 1 1 1]</td>
  </tr>
  <tr>
    <td>10</td>
    <td>['B' 'D' 'E' 'F']</td>
    <td>[0 1 0 1 1 1 0]</td>
  </tr>
</table>
</div>
<div>

<p>SingleItems is a list of single items in the database. The reason why we keep this list is to show the results found in string type.</p>  

<table>
 <th>SingleItems</th>
 <th>["A","B","C","D","E","F","G"]</th>
</table>
