Help Foreign Function Command

Teradata® Vantage User Guide

brand
Teradata Vantage
prodname
Teradata Vantage
vrm_release
1.0
category
User Guide
featnum
B700-4002-098K
The output of the HELP FOREIGN FUNCTION command shows detailed information about the Teradata ML Engine function specified.

You must use the coprocessor function name as input to this command and append @coprocessor to it. See Teradata ML Engine Analytic Function Mapping to map your function with its coprocessor function name.

HELP FOREIGN FUNCTION kmeans@coprocessor;
Function Help
----------------------------------------------------------------------
Function Name:
kmeans

Function Type:
driver

Short Description:
Performs K-Means clustering on a data set

Long Description:
Finds cluster centroids and assigns data points to clusters using the k-means
algorithm.

Usage Syntax:
kmeans@coprocessor(
ON(...) as InputTable
[ON(...) as CentroidsTable]
[MaxIterNum('INTEGER')]
[Seed('INTEGER')]
[UnpackColumns('BOOLEAN')]
[InitialSeeds('STRING')]
[NumClusters('INTEGER')]
[Threshold('DOUBLE')]
[ClusteredOutput('TABLE_NAME')]
OutputTable('TABLE_NAME')
)

Input Columns:
<Input Table> should be in the following format< id ,point1 real ...pointn
real>

Output Columns:
<Output Table will be in the following format <clusterid, packedColumn, size,
withinss>

Function Owner:
db_superuser

Creation Time:
2017-08-29 16:02:06.230091

Function Version:
7.0_rel_1.7_r65218

Interfaces Implemented:
Partition function

For information on function arguments, see Teradata® Vantage Machine Learning Engine Analytic Function Reference, B700-4003.