PPP_ECLAT

class PAMI.partialPeriodicPattern.basic.PPP_ECLAT.PPP_ECLAT(iFile, minPS, period, sep='\t')[source]

Bases: _partialPeriodicPatterns

Descripition:

3pEclat is the fundamental approach to mine the partial periodic frequent patterns.

Reference:

R. Uday Kirana,b,∗ , J.N. Venkateshd, Masashi Toyodaa , Masaru Kitsuregawaa,c , P. Krishna Reddy Discovering partial periodic-frequent patterns in a transactional database https://www.tkl.iis.u-tokyo.ac.jp/new/uploads/publication_file/file/774/JSS_2017.pdf

Parameters:
  • iFile – str : Name of the Input file to mine complete set of frequent pattern’s

  • oFile – str : Name of the output file to store complete set of frequent patterns

  • minPS – float: Minimum partial periodic pattern…

  • period – float: Minimum partial periodic…

  • sep – str : This variable is used to distinguish items from one another in a transaction. The default seperator is tab space. However, the users can override their default separator.

Attributes:
self.iFilefile

Name of the Input file or path of the input file

self. oFilefile

Name of the output file or path of the output file

minPS: float or int or str

The user can specify minPS either in count or proportion of database size. If the program detects the data type of minPS is integer, then it treats minPS is expressed in count. Otherwise, it will be treated as float. Example: minPS=10 will be treated as integer, while minPS=10.0 will be treated as float

period: float or int or str

The user can specify period either in count or proportion of database size. If the program detects the data type of period is integer, then it treats period is expressed in count. Otherwise, it will be treated as float. Example: period=10 will be treated as integer, while period=10.0 will be treated as float

sepstr

This variable is used to distinguish items from one another in a transaction. The default seperator is tab space or . However, the users can override their default separator.

memoryUSSfloat

To store the total amount of USS memory consumed by the program

memoryRSSfloat

To store the total amount of RSS memory consumed by the program

startTime:float

To record the start time of the mining process

endTime:float

To record the completion time of the mining process

Databaselist

To store the transactions of a database in list

mapSupportDictionary

To maintain the information of item and their frequency

lnoint

it represents the total no of transactions

treeclass

it represents the Tree class

finalPatternsdict

it represents to store the patterns

tidListdict

stores the timestamps of an item

Methods:
mine()

Mining process will start from here

getPatterns()

Complete set of patterns will be retrieved with this function

save(oFile)

Complete set of frequent patterns will be loaded in to an output file

getPatternsAsDataFrame()

Complete set of frequent patterns will be loaded in to a dataframe

getMemoryUSS()

Total amount of USS memory consumed by the mining process will be retrieved from this function

getMemoryRSS()

Total amount of RSS memory consumed by the mining process will be retrieved from this function

getRuntime()

Total amount of runtime taken by the mining process will be retrieved from this function

creatingOneitemSets()

Scan the database and store the items with their timestamps which are periodic frequent

getPeriodAndSupport()

Calculates the support and period for a list of timestamps.

Generation()

Used to implement prefix class equivalence method to generate the periodic patterns recursively

Executing the code on terminal:

Format:

(.venv) $ python3 PPP_ECLAT.py <inputFile> <outputFile> <minPS> <period>

Examples:

(.venv) $ python3 PPP_ECLAT.py sampleDB.txt patterns.txt 0.3 0.4

Sample run of importing the code:

… code-block:: python

from PAMI.periodicFrequentPattern.basic import PPP_ECLAT as alg

obj = alg.PPP_ECLAT(iFile, minPS,period)

obj.mine()

Patterns = obj.getPatterns()

print(“Total number of partial periodic patterns:”, len(Patterns))

obj.save(oFile)

Df = obj.getPatternsAsDataFrame()

memUSS = obj.getMemoryUSS()

print(“Total Memory in USS:”, memUSS)

memRSS = obj.getMemoryRSS()

print(“Total Memory in RSS”, memRSS)

run = obj.getRuntime()

print(“Total ExecutionTime in seconds:”, run)

Credits:

The complete program was written by P.RaviKumar under the supervision of Professor Rage Uday Kiran.

Mine() None[source]

Main program start with extracting the periodic frequent items from the database and performs prefix equivalence to form the combinations and generates partial-periodic patterns. :return: None

getMemoryRSS() float[source]

Total amount of RSS memory consumed by the mining process will be retrieved from this function

Returns:

returning RSS memory consumed by the mining process

Return type:

float

getMemoryUSS() float[source]

Total amount of USS memory consumed by the mining process will be retrieved from this function

Returns:

returning USS memory consumed by the mining process

Return type:

float

getPatterns() Dict[str, int][source]

Function to send the set of frequent patterns after completion of the mining process

Returns:

returning frequent patterns

Return type:

dict

getPatternsAsDataFrame() DataFrame[source]

Storing final frequent patterns in a dataframe

Returns:

returning frequent patterns in a dataframe

Return type:

pd.DataFrame

getRuntime() float[source]

Calculating the total amount of runtime taken by the mining process

Returns:

returning total amount of runtime taken by the mining process

Return type:

float

printResults() None[source]

This function is used to print the results :return: None

save(outFile: str) None[source]

Complete set of frequent patterns will be loaded in to an output file

Parameters:

outFile (file) – name of the output file

Returns:

None

startMine() None[source]

Main program start with extracting the periodic frequent items from the database and performs prefix equivalence to form the combinations and generates partial-periodic patterns. :return: None