filter_topn
Sort a dataset by selected columns and pick the first N rows (or exclude them).
Usage
The following shows how the step can be used in a recipe.
Examples
Examples
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.
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
An input dataset to filter.
Outputs
Outputs
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
Parameters
How many of the leading rows to keep after sorting.
One or more columns to sort by before picking the first n rows. May be a column name or a list of column names.
Options
Options
Examples
Examples
- salary
- [‘salary’, ‘time_spend_company’, ‘last_evaluation’]
If true
, the first n rows after sorting will be excluded from the resulting dataset.
Whether to sort in ascending order rather than descending.