Document toolboxDocument toolbox

cluster

This is a clustering operator. It takes: fieldToCluster to apply clustering on, to create user defined number of clusters.

Note: this is an experimental operator

Operator Usage in Easy Mode

  1. Click + on the parent node.

  2. Enter the Cluster operator in the search field and select the operator from the Results to open the operator form.

  3. In the Table drop-down, enter or select the table to create clusters.

  4. In the Field to Cluster drop-down, select a column to apply the clustering algorithm on.

  5. Enter a value to create the number of clusters.

  6. Optional. Include all the tokens for TF_IDF parameters by clicking on Add More in the TF_IDF Params field.

  7. Click Run to view the result.

  8. Click Save to add the operator to the playbook.

  9. Click Cancel to discard the operator form.

Usage Details

LQL Command

cluster(table, fieldToCluster, numberOfClusters, tf_idfParams)

Parameters:
table - The table to create clusters
fieldToCluster - List of column names to apply clustering algorithm on
numberOfClusters - Number of clusters
tf_idfParams - Optional tf-idf parameters: minTF and minDF, by default minTF=0 and minDF=0, e.g. include all tokens.

Returns:
The input table with an additional lhub_cluster_id column and top 5 best matches e.g. string of array(tuple(cluster_id, confidence_score)).