Skip to main content

​
Usage

The following example shows how the step can be used in a recipe.

Examples

  • Example 1
  • Signature
configure_category_order(ds.cluster, { "kind": "BACKGROUND" })

​
Inputs & Outputs

The following are the inputs expected by the step and the outputs it produces. These are generally columns (ds.first_name), datasets (ds or ds[["first_name", "last_name"]]) or models (referenced by name e.g. "churn-clf").
​
column
column[category|list[category]|text]
required
Categorical column to be configured (may be a column of lists of categories).

​
Configuration

The following parameters can be used to configure the behaviour of the step by including them in a json object as the last “input” to the step, i.e. step(..., {"param": "value", ...}) -> (output).

Parameters

​
kind
string
required
Kind of ordering. Determines the order of categories. E.g. to show first the categories having the greatest row count in the whole dataset, select "BACKGROUND". To show those categories first having the greatest number of rows in the current selection, use "FOREGROUND", etc.Values must be one of the following:
  • BACKGROUND
  • FOREGROUND
  • UPLIFT
  • TFIDF
  • ORDINAL
⌘I