Skip to main content

​
Usage

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

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.
filter_topn(ds_in: dataset, {
    "param": value,
    ...
}) -> (ds_out: dataset)

​
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").
​
ds_in
dataset
required
An input dataset to filter.
​
ds_out
dataset
required
A new dataset containing the same columns as the input dataset but only those rows passing the filter condition.

​
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

​
n
integer
required
How many of the leading rows to keep after sorting.
​
sort_by
[array, string]
required
One or more columns to sort by before picking the first n rows. May be a column name or a list of column names.
  • array
  • string
​
{_}
array[string]
array.
​
Item
string (ds_in.column)
Each item in array.
  • salary
  • [‘salary’, ‘time_spend_company’, ‘last_evaluation’]
​
exclude
boolean
default:"false"
If true, the first n rows after sorting will be excluded from the resulting dataset.
​
ascending
boolean
default:"false"
Whether to sort in ascending order rather than descending.