Skip to content

Configure category labels

UI • interface

Configures the labels generated for each category.

Note that for each possible kind parameter ("significantTerms", "sequential", or "originals"), this step has different configuration options. See subsections below for more details.

Usage

The following are the step's expected inputs and outputs and their specific types.

Step signature
configure_category_labels(column: category, {
    "param": value
})

where the object {"param": value} is optional in most cases and if present may contain any of the parameters described in the corresponding section below.

Example

Example call (in recipe editor)
configure_category_labels(ds.cluster, { "kind": "originals" })
More examples

E.g., to show sequentially numbered labels with the "cluster" prefix (cluster-1, cluster-2 etc.), use:

Example call (in recipe editor)
configure_category_labels(ds.cluster, { "kind": "sequential", "prefix": "cluster-" })

Inputs

column: column:category

Column to be configured.

Parameters

Specific parameters depend on the kind of labels you want to use ("significantTerms", "sequential", or "originals").

kind: string = "significantTerms"

Label categories with significant terms.

column: string

Significant terms column. This column's significant terms will be shown as category labels.

order: string

In what order to show the categories.

Must be one of: "BACKGROUND", "FOREGROUND", "UPLIFT", "TFIDF", "ORDINAL"

kind: string = "sequential"

Label categories sequentially (1..N).

prefix: string

String that will be placed at the beginning of each label.

kind: string = "originals"

Use column's original labels.