PAMI.highUtilitySpatialPattern package

Subpackages

• PAMI.highUtilitySpatialPattern.basic package
  • Submodules
  • PAMI.highUtilitySpatialPattern.basic.HDSHUIM module
    • HDSHUIM
      • HDSHUIM.getMemoryRSS()
      • HDSHUIM.getMemoryUSS()
      • HDSHUIM.getPatterns()
      • HDSHUIM.getPatternsAsDataFrame()
      • HDSHUIM.getRuntime()
      • HDSHUIM.mine()
      • HDSHUIM.printResults()
      • HDSHUIM.save()
      • HDSHUIM.mine()
  • PAMI.highUtilitySpatialPattern.basic.SHUIM module
    • SHUIM
      • SHUIM.getMemoryRSS()
      • SHUIM.getMemoryUSS()
      • SHUIM.getPatterns()
      • SHUIM.getPatternsAsDataFrame()
      • SHUIM.getRuntime()
      • SHUIM.mine()
      • SHUIM.printResults()
      • SHUIM.save()
      • SHUIM.mine()
  • PAMI.highUtilitySpatialPattern.basic.abstract module
  • Module contents
• PAMI.highUtilitySpatialPattern.topk package
  • Submodules
  • PAMI.highUtilitySpatialPattern.topk.TKSHUIM module
    • Dataset
      • Dataset.createTransaction()
      • Dataset.getMaxItem()
      • Dataset.getTransactions()
      • Dataset.maxItem
      • Dataset.transactions
    • TKSHUIM
      • TKSHUIM.Neighbours
      • TKSHUIM.additemset()
      • TKSHUIM.backtrackingEFIM()
      • TKSHUIM.calculateNeighbourIntersection()
      • TKSHUIM.candidateCount
      • TKSHUIM.endTime
      • TKSHUIM.finalPatterns
      • TKSHUIM.getMemoryRSS()
      • TKSHUIM.getMemoryUSS()
      • TKSHUIM.getPatterns()
      • TKSHUIM.getPatternsAsDataFrame()
      • TKSHUIM.getRuntime()
      • TKSHUIM.heapList
      • TKSHUIM.iFile
      • TKSHUIM.intTostr
      • TKSHUIM.intersection()
      • TKSHUIM.is_equal()
      • TKSHUIM.maxMemory
      • TKSHUIM.memoryRSS
      • TKSHUIM.memoryUSS
      • TKSHUIM.minUtil
      • TKSHUIM.mine()
      • TKSHUIM.nFile
      • TKSHUIM.newNamesToOldNames
      • TKSHUIM.oFile
      • TKSHUIM.oldNamesToNewNames
      • TKSHUIM.output()
      • TKSHUIM.printResults()
      • TKSHUIM.save()
      • TKSHUIM.sep
      • TKSHUIM.sortDatabase()
      • TKSHUIM.sort_transaction()
      • TKSHUIM.mine()
      • TKSHUIM.startTime
      • TKSHUIM.strToint
      • TKSHUIM.temp
      • TKSHUIM.useUtilityBinArrayToCalculateLocalUtilityFirstTime()
      • TKSHUIM.useUtilityBinArrayToCalculateSubtreeUtilityFirstTime()
      • TKSHUIM.useUtilityBinArraysToCalculateUpperBounds()
      • TKSHUIM.utilityBinArrayLU
      • TKSHUIM.utilityBinArraySU
    • Transaction
      • Transaction.getItems()
      • Transaction.getLastPosition()
      • Transaction.getPmus()
      • Transaction.getUtilities()
      • Transaction.insertionSort()
      • Transaction.offset
      • Transaction.prefixUtility
      • Transaction.projectTransaction()
      • Transaction.removeUnpromisingItems()
    • main()
  • PAMI.highUtilitySpatialPattern.topk.abstract module
    • utilityPatterns
      • utilityPatterns.endTime()
      • utilityPatterns.finalPatterns()
      • utilityPatterns.getMemoryRSS()
      • utilityPatterns.getMemoryUSS()
      • utilityPatterns.getPatterns()
      • utilityPatterns.getPatternsAsDataFrame()
      • utilityPatterns.getRuntime()
      • utilityPatterns.iFile()
      • utilityPatterns.memoryRSS()
      • utilityPatterns.memoryUSS()
      • utilityPatterns.nFile()
      • utilityPatterns.oFile()
      • utilityPatterns.printResults()
      • utilityPatterns.save()
      • utilityPatterns.mine()
      • utilityPatterns.startTime()
  • Module contents

Submodules

PAMI.highUtilitySpatialPattern.abstract module

class PAMI.highUtilitySpatialPattern.abstract.utilityPatterns(iFile, nFile, minUtil, sep='\t')

Bases: ABC

Description:

This abstract base class defines the variables and methods that every frequent pattern mining algorithm must employ in PAMI

Attributes:

iFilestr

Input file name or path of the input file

minUtil: integer

The user can specify minUtil either 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

startTime:float

To record the start time of the algorithm

endTime:float

To record the completion time of the algorithm

finalPatterns: dict

Storing the complete set of patterns in a dictionary variable

oFilestr

Name of the output file to store complete set of frequent patterns

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

Methods:

mine()

Calling this function will start the actual mining process

getPatterns()

This function will output all interesting patterns discovered by an algorithm

save(oFile)

This function will store the discovered patterns in an output file specified by the user

getPatternsAsDataFrame()

The function outputs the patterns generated by an algorithm as a data frame

getMemoryUSS()

This function outputs the total amount of USS memory consumed by a mining algorithm

getMemoryRSS()

This function outputs the total amount of RSS memory consumed by a mining algorithm

getRuntime()

This function outputs the total runtime of a mining algorithm

abstract endTime()

Variable to store the end time of the complete program

abstract finalPatterns()

Variable to store the complete set of patterns in a dictionary

abstract getMemoryRSS()

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

abstract getMemoryUSS()

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

abstract getPatterns()

Complete set of frequent patterns generated will be retrieved from this function

abstract getPatternsAsDataFrame()

Complete set of frequent patterns will be loaded in to data frame from this function

abstract getRuntime()

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

abstract iFile()

Variable to store the input file path/file name

abstract memoryRSS()

Variable to store RSS memory consumed by the program

abstract memoryUSS()

Variable to store USS memory consumed by the program

abstract minUtil()

Variable to store the user-specified minimum support value

abstract nFile()

Variable to store the neighbourhood file path/file name

abstract oFile()

Variable to store the name of the output file to store the complete set of frequent patterns

abstract save(oFile)

Complete set of frequent patterns will be saved in to an output file from this function

Parameters:

oFile (csv file) – Name of the output file

abstract startMine()

Code for the mining process will start from this function

abstract startTime()

Variable to store the start time of the mining process

Module contents