create_compare_insight
Create a new insight from the Compare section.
Usage
The following shows how the step can be used in a recipe.
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").
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).
Title of the insight.
Columns from which the insight is created.
Columns that will not be used to create the insight.
Theme mode applied to the whole insight.
Values must be one of the following:
darklight
Sets the correlation graph as expanded. If true, the insight will contain an expanded chart in order to show the maximum number of categories possible.
Useful to choose the ordering kind of the columns, by difference or by similarity.
Values must be one of the following:
differentFirstsimilarFirst
Indicates if the insight can replay its original state or not.
Values must be one of the following:
drillDowndirectSelectionInGraphnonPersistedColumnTrueFalse
Sets the visualization type. In relative and absolute modes the comparing segments will be rendered as charts, but in tabular mode a table is shown.
Values must be one of the following:
relativeabsolutetabular
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 of segments to use in the insight.
Was this page helpful?