Teradata Package for Python Function Reference on VantageCloud Lake - display_analytic_functions - Teradata Package for Python - Look here for syntax, methods and examples for the functions included in the Teradata Package for Python.
Teradata® Package for Python Function Reference on VantageCloud Lake
- Deployment
- VantageCloud
- Edition
- Lake
- Product
- Teradata Package for Python
- Release Number
- 20.00.00.03
- Published
- December 2024
- ft:locale
- en-US
- ft:lastEdition
- 2024-12-19
- dita:id
- TeradataPython_FxRef_Lake_2000
- Product Category
- Teradata Vantage
- teradataml.analytics.utils.display_analytic_functions = display_analytic_functions(type=None, name=None)
- DESCRIPTION:
Display list of analytic functions available to use on the Teradata Vantage system, user is connected to.
PARAMETERS:
type:
Optional Argument.
Specifies the type(s) of functions to list down.
Permitted Values: "BYOM", "TABLE OPERATOR", "SQLE", "UAF", "VAL".
Types: str or list of str(s)
name:
Optional Argument.
Specifies the search string for function name. When this argument
is used, all functions matching the name are listed.
Types: str or list of str(s)
RETURNS:
None
RAISES:
TeradataMlException.
EXAMPLES:
>>> from teradataml import create_context, display_analytic_functions
# Example 1: Displaying a list of available analytic functions
>>> connection_name = create_context(host = host, username=user, password=password)
>>> display_analytic_functions()
List of available functions:
Analytics Database Functions:
* PATH AND PATTERN ANALYSIS functions:
1. Attribution
2. NPath
3. Sessionize
.
.
.
5. VectorDistance
* FEATURE ENGINEERING UTILITY functions:
1. FillRowId
2. NumApply
3. RoundColumns
4. StrApply
.
.
Unbounded Array Framework (UAF) Functions:
* MODEL PREPARATION AND PARAMETER ESTIMATION functions:
1. ACF
2. ArimaEstimate
3. ArimaValidate
4. DIFF
5. LinearRegr
6. MultivarRegr
7. PACF
8. PowerTransform
9. SeasonalNormalize
.
.
TABLE OPERATOR Functions:
1. ReadNOS
2. WriteNOS
BYOM Functions:
1. H2OPredict
2. ONNXPredict
3. PMMLPredict
Vantage Analytic Library (VAL) Functions:
* DESCRIPTIVE STATISTICS functions:
1. AdaptiveHistogram
2. Explore
3. Frequency
...
# Example 2: When no analytic functions are available on the cluster.
>>> display_analytic_functions(name="Func_does_not_exists")
No analytic functions available with connected Teradata Vantage system with provided filters.
# Example 3: List all available SQLE analytic functions.
>>> display_analytic_functions(type="SQLE")
List of available functions:
Analytics Database Functions:
* PATH AND PATTERN ANALYSIS functions:
1. Attribution
2. NPath
3. Sessionize
* MODEL SCORING functions:
1. DecisionForestPredict
2. DecisionTreePredict
3. GLMPredict
4. KMeansPredict
.
.
.
4. KNN
5. VectorDistance
* FEATURE ENGINEERING UTILITY functions:
1. FillRowId
2. NumApply
3. RoundColumns
4. StrApply
...
# Example 4: List all functions with function name containing string "fit".
>>> display_analytic_functions(name="fit")
List of available functions:
Analytics Database Functions:
* FEATURE ENGINEERING TRANSFORM functions:
1. BincodeFit
2. Fit
3. NonLinearCombineFit
4. OneHotEncodingFit
5. OrdinalEncodingFit
6. PolynomialFeaturesFit
7. RandomProjectionFit
8. RowNormalizeFit
9. ScaleFit
10. SimpleImputeFit
* DATA CLEANING functions:
1. OutlierFilterFit
Unbounded Array Framework (UAF) Functions:
* DIAGNOSTIC STATISTICAL TEST functions:
1. FitMetrics
# Example 5: List all SQLE functions with function name containing string "fit".
>>> display_analytic_functions(type="SQLE", name="fit")
List of available functions:
Analytics Database Functions:
* FEATURE ENGINEERING TRANSFORM functions:
1. BincodeFit
2. Fit
3. NonLinearCombineFit
4. OneHotEncodingFit
5. OrdinalEncodingFit
6. PolynomialFeaturesFit
7. RandomProjectionFit
8. RowNormalizeFit
9. ScaleFit
10. SimpleImputeFit
* DATA CLEANING functions:
1. OutlierFilterFit
# Example 6: List all functions of type "TABLE OPERATOR" and "SQLE" containing "fit" and "nos".
>>> display_analytic_functions(type=["SQLE", "TABLE OPERATOR"], name=["fit", "nos"])
List of available functions:
Analytics Database Functions:
* FEATURE ENGINEERING TRANSFORM functions:
1. BincodeFit
2. Fit
3. NonLinearCombineFit
4. OneHotEncodingFit
5. OrdinalEncodingFit
6. PolynomialFeaturesFit
7. RandomProjectionFit
8. RowNormalizeFit
9. ScaleFit
10. SimpleImputeFit
* DATA CLEANING functions:
1. OutlierFilterFit
TABLE OPERATOR Functions:
1. ReadNOS
2. WriteNOS
# Example 7: List all functions of type "UAF" containing "estimate".
>>> display_analytic_functions(type = "UAF", name = "estimate")
List of available functions:
Unbounded Array Framework (UAF) Functions:
* MODEL PREPARATION AND PARAMETER ESTIMATION functions:
1. ArimaEstimate