Metadata-Version: 2.1
Name: quality-covers
Version: 1.0.6
Summary: Python Package with quality covers C++ extension
Home-page: UNKNOWN
Author: Nicolas Gros
Author-email: nicolas.gros01@u-bourgogne.fr
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown

# Quality covers

Quality covers is a pattern mining algorithm.

# How to use

```shell
pip install --upgrade quality_covers
```

## Transactional file

If your file looks like this

chess.dat: 
```
1 3 5 7 10 
1 3 5 7 10 
1 3 5 8 9 
1 3 6 7 9 
1 3 6 8 9 
```

use

```python
import quality_covers

quality_covers.run_classic_size("chess.dat", False)
```

## Binary file

If your file looks like this

chess.data: 
```
1 0 1 0 1 0 1 0 0 1
1 0 1 0 1 0 1 0 0 1
1 0 1 0 1 0 0 1 1 0
1 0 1 0 0 1 1 0 1 0
1 0 1 0 0 1 0 1 1 0
```

use

```python
import quality_covers

quality_covers.run_classic_size("chess.data", True)
```

## Output of the functions

The functions will create two files in current directory:
- *chess.data.out*: the result file
- *chess.data.clock*: information about time execution

# More info

## Paper associated

To come

## Research lab

- http://www.ciad-lab.fr/

## More tools about association rules

- https://marm.checksem.fr/api/ui/
- https://app.marm.checksem.fr/

## Authors

Amira Mouakher (<amira.mouakher@u-bourgogne.fr>)
Nicolas Gros (<nicolas.gros01@u-bourgogne.fr>)
Sebastien Gerin (<sebastien.gerin@sayens.fr>)


