PFPGrowth

class PAMI.periodicFrequentPattern.basic.PFPGrowth.PFPGrowth(iFile, minSup, maxPer, sep='\t')[source]

Bases: _periodicFrequentPatterns

Description:

PFPGrowth is one of the fundamental algorithm to discover periodic-frequent patterns in a transactional database.

Reference:

Syed Khairuzzaman Tanbeer, Chowdhury Farhan, Byeong-Soo Jeong, and Young-Koo Lee, “Discovering Periodic-Frequent Patterns in Transactional Databases”, PAKDD 2009, https://doi.org/10.1007/978-3-642-01307-2_24

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

  • oFile – str : Name of the output file to store complete set of periodic frequent pattern’s

  • minSup – str: Controls the minimum number of transactions in which every item must appear in a database.

  • maxPer – float: Controls the maximum number of transactions in which any two items within a pattern can reappear.

  • 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:
iFilefile

Name of the Input file or path of the input file

oFilefile

Name of the output file or path of the output file

minSupint or float or str

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

maxPerint or float or str

The user can specify maxPer either in count or proportion of database size. If the program detects the data type of maxPer is integer, then it treats maxPer is expressed in count. Otherwise, it will be treated as float. Example: maxPer=10 will be treated as integer, while maxPer=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

To represent the total no of transaction

treeclass

To represents the Tree class

itemSetCountint

To represents the total no of patterns

finalPatternsdict

To store the complete patterns

Methods:
mine()

Mining process will start from here

getPatterns()

Complete set of patterns will be retrieved with this function

save(oFile)

Complete set of periodic-frequent patterns will be loaded in to a output file

getPatternsAsDataFrame()

Complete set of periodic-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

creatingItemSets(fileName)

Scans the dataset and stores in a list format

PeriodicFrequentOneItem()

Extracts the one-periodic-frequent patterns from database

updateDatabases()

Update the database by removing aperiodic items and sort the Database by item decreased support

buildTree()

After updating the Database, remaining items will be added into the tree by setting root node as null

convert()

to convert the user specified value

Credits:

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

Mine() None[source]

Mining process will start from this function :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, Tuple[int, int]][source]

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

Returns:

returning periodic-frequent patterns

Return type:

dict

getPatternsAsDataFrame() DataFrame[source]

Storing final periodic-frequent patterns in a dataframe

Returns:

returning periodic-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 periodic-frequent patterns will be loaded in to an output file

Parameters:

outFile (csv file) – name of the output file

Returns:

None

startMine() None[source]

Mining process will start from this function :return: None