PAMI.recurringPattern.basic package
Submodules
PAMI.recurringPattern.basic.RPGrowth module
- class PAMI.recurringPattern.basic.RPGrowth.RPGrowth(iFile, maxPer, minPS, minRec, sep='\t')[source]
Bases:
_recurringPatterns- Description:
RPGrowth is one of the fundamental algorithm to discover recurring patterns in a transactional database.
- Reference:
Uday Kiran†, Haichuan Shang†, Masashi Toyoda† and Masaru Kitsuregawa† Discovering Recurring Patterns in Time Series,https://www.tkl.iis.u-tokyo.ac.jp/new/uploads/publication_file/file/693/Paper%2023.pdf
- Parameters:
iFile – str : Name of the Input file to mine complete set of Recurring patterns
oFile – str : Name of the output file to store complete set of Recurring patterns
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.
minPs – str : It could potentially represent a minimum parallelism percentage or some other value related to parallel processing.
maxPer – float : minRec It represent a maximum percentage or some other numeric value.
minRec – str : It could represent a minimum recommended value or some other string-based setting.
- 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
- 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
- minPSint or float 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
- minRecint or float or str
The user has to specify minRec in count.
- 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
- startTimefloat
To record the start time of the mining process
- endTimefloat
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
- OneItems()
Extracts the possible recurring items of size one from database
- updateDatabases()
Update the database by removing non recurring 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
Methods to execute code on terminal
Format: (.venv) $ python3 RPGrowth.py <inputFile> <outputFile> <maxPer> <minPS> <minRec> Example usage: (.venv) $ python3 RPGrowth.py sampleTDB.txt patterns.txt 0.3 0.4 2 .. note:: maxPer and minPS will be considered in percentage of database transactions
Importing this algorithm into a python program
from PAMI.periodicFrequentPattern.recurring import RPGrowth as alg obj = alg.RPGrowth(iFile, maxPer, minPS, minRec) obj.startMine() periodicFrequentPatterns = obj.getPatterns() print("Total number of Periodic Frequent Patterns:", len(periodicFrequentPatterns)) obj.savePatterns(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 C. Saideep under the supervision of Professor Rage Uday Kiran.
- getMemoryRSS()[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()[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()[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()[source]
Storing final periodic-frequent patterns in a dataframe
- Returns:
returning periodic-frequent patterns in a dataframe
- Return type:
pd.DataFrame
- getRuntime()[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