Usage
The following shows how the step can be used in a recipe.Examples
Examples
- Signature
General syntax for using the step in a recipe. Shows the inputs and outputs the step is expected to receive and will produce respectively. For futher details see sections below.
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").
Inputs
Inputs
Outputs
Outputs
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
Parameters
string
required
Title of the insight.
array[object]
Type and appearance of an insight’s elements.
A list in which each item is an object configuring the appearance of a particular insight element.
Array items
Array items
string
Specify the type of element.Values must be one of the following:
TITLE DESCRIPTION CHART GRAPH STATS LEGEND LEGEND_COLOR_SCALE TABLE_CHARTstring
The text shown for this insight element.
Element visibility.
object
The element’s position and size.
The position refers to the top-left corner of the rectangle representing the insight element,
while the size is given by its width and height. For reference, the entire insight is 12 units
wide and 9 units high, and the origin (0, 0) of the x/y coordinates is in its top-left corner.
Properties
Properties
integer
Horizontal position of the element’s top-left corner.
In increments of 1; 0 being the left-most and 8 the right-most position.Values must be in the following range:
integer
Vertical position of the element’s top-left corner.
In increments of 1; 0 being the top-most and 11 the bottom-most position.Values must be in the following range:
integer
The width of the element (in increments of 1).Values must be in the following range:
integer
The height of the element (in increments of 1).Values must be in the following range:
string
Name of the column containing the data to be used in this insight element.
Required if the element is of type CHART or STATS.