Skip to content

Documentation for FeatureSet and related classes

The object model represents a Feature Set in the Engine

description() property

Description of the feature set

Returns:

Name Type Description
str str

Description of the feature set

feature_names() property

Selected column names that used as features

Returns:

Type Description
Set[str]

Set[str]: set of column names that used as features

name() property

Name of the feature set

Returns:

Name Type Description
str str

Name of the feature set

Get recommeneded models based on a given metric

Parameters:

Name Type Description Default
n int

top N recommended algorithms

required
by_metric str

ranking metric

required

Returns:

Type Description
List[str]

List[str]: list of algorithm (model template name)

wait_for_processed(timeout=DEFAULT_TIMEOUT)

Waiting for the feature set processed

Parameters:

Name Type Description Default
timeout int

waiting time in seconds. Defaults to DEFAULT_TIMEOUT (600s).

DEFAULT_TIMEOUT