7.00.02 - FPGrowth Arguments - Aster Analytics

Teradata Aster® Analytics Foundation User GuideUpdate 2

Product
Aster Analytics
Release Number
7.00.02
Release Date
September 2017
Content Type
Programming Reference
User Guide
Publication ID
B700-1022-700K
Language
English (United States)
InputTable
Specifies the name of the table that contains the data set.
OutputPatternTable
[Required if PatternsOrRules is 'patterns' or 'both', otherwise disallowed.] Specifies the name of the table where the function outputs the patterns.
OutputRuleTable
[Required if PatternsOrRules is 'patterns' or 'both', otherwise disallowed.] Specifies the name of the table where the function outputs the rules.
TranItemColumns
Specifies the names of the columns that contain transaction items to analyze.
TranIDColumns
Specifies the names of the columns that contain identifiers for the transaction items.
Do not specify the same column in both this argument and the GroupByColumns argument, because this causes incorrect counting in the partitions.
PatternsOrRules
[Optional] Specifies whether the function outputs patterns, rules, or both. An example of a pattern is {onions, potatoes, hamburger}. Default: 'both'.
GroupByColumns
[Optional] Specifies the names of columns that define the partitions into which the function groups the input data and calculates output for it. At least one column must be usable as a distribution key. Default behavior: The function considers all input data to be in a single partition.
Do not specify the same column in both this argument and the TranIDColumns argument, because this causes incorrect counting in the partitions.
PatternDistributionKeyColumn
[Optional] Specifies the name of the column to use as the distribution key for output_pattern_table. Default: 'pattern_tranitemcolumns'.
RuleDistributionKeyColumn
[Optional] Specifies the name of the column to use as the distribution key for output_rule_table. Default: 'antecedent_tranitemcolumns'.
Compress
[Optional] Specifies the compression level the output tables. Default: 'nocompress'.

Realized compression ratios depend on both this value and the data characteristics. These ratios typically range from 3x to 12x. For more information about compression, see Teradata Aster® Database User Guide for Aster Appliances.

DropTable
[Optional] Specifies whether the function drops and then creates output_pattern_table or output_rule_table if it exists ('true') or issues an error message ('false'). Default: 'false'.
GroupSize
[Optional] Specifies the number of transaction items to be assigned to each worker. This value must be an INTEGER in the range from 1 to the number of distinct transaction items, inclusive. For a machine with limited RAM, use a relatively small value. Default: 4.
MinSupport
[Optional] Specifies the minimum support value of returned patterns (including the specified support value). This value must be a DECIMAL in the range [0, 1]. Default: 0.05.
MinConfidence
[Optional] Specifies the minimum confidence value of returned patterns (including the specified confidence value). This value must be a DECIMAL in the range [0, 1]. Default: 0.8.
MaxPatternLength
[Optional] Specifies the maximum length of returned patterns. The length of a pattern is the sum of the item numbers in the antecedent and consequence columns. This value must be an INTEGER greater than 2. Default: 10.

MaxPatternLength also limits the length of returned rules to this value.

AntecedentCountRange
[Optional] Specifies the range for na, the number of items in the antecedent. The function returns only patterns for which na is in the range [lower_bound, upper_bound]. The lower_bound must be greater an integer greater than 0. The lower_bound and upper_bound can be equal. Default: '1-infinite'.
ConsequenceCountRange
[Optional] Specifies the range for nc, the number of items in the consequence. The function returns only patterns for which nc is in the range [lower_bound, upper_bound]. The lower_bound must be greater an integer greater than 0. The lower_bound and upper_bound can be equal. Default: '1-1'.
Delimiter
[Optional] Specifies the delimiter that separates items in the output. Default: ',' (comma).