Item Clustering and Trade-Off

For the next section, you will be:

  • Clustering the items at different cluster sizes
  • Obtaining clustering results
  • Choosing the right clustering size

Clustering The Items

The first step of this section is to test each cluster size to get the MSE(mean square error).

Xineoh recommends cluster counts between 10 and 20 for most use cases.

Item Clustering API Call:
POST - /builder/cluster
Params: { version: v3.0 }
Body: { clusters_min: MIN_CLUSTER_COUNT, clusters_max: MAX_CLUSTER_COUNT, cluster_type: ‘item’ }
Successful Response:
{
    "status_code": 200,
    "success": "We will notify you when it's finished",
    "process_id": PROCESS_ID
}

Using the process_id from the response we can get updates on the progress with the View Process API Request.

Once the cluster sizes have been tested, Xineoh will email you.

Email Notification:

User Trade-Off Chart

The next step is to view the MSE results for each cluster size so you can choose which cluster size will suit the use case best.

Xineoh leaves this decision up to you.

User Trade-Off Chart API Call:
GET - /charts/graph
Params: { version: v3.0, graph: ‘trade-off’, type: ‘items’ }
Successful Response:
{
    "status_code": 200,
    "response": [
        {
            "number_of_clusters": "10",
            "mse": "MSE_RESULT"
        },
        {
            "number_of_clusters": "11",
            "mse": "MSE_RESULT"
        },
        …
        {
            "number_of_clusters": "14",
            "mse": "MSE_RESULT"
        },
        {
            "number_of_clusters": "20",
            "mse": "MSE_RESULT"
        },
    ]
}

Choose User Cluster

When you have decided on the cluster size, you can use the following API call to cluster the items into the chosen cluster size.

Choose User Cluster Count based on MSE results API Call:
POST - /builder/cluster_choose
Params: { version: v3.0 }
Body: { cluster_type: ‘item’,  cluster_amount: CHOSEN_CLUSTER_COUNT }
Successful Response:
{
    "status_code": 200,
    "success": "We will notify you when it's finished",
    "process_id": PROCESS_ID
}

Using the process_id from the response we can get updates on the progress with the View Process API Request.

Once the cluster sizes have been tested, Xineoh will email you.

Email Notification: