featuretools.describe_feature

featuretools.describe_feature(feature, feature_descriptions=None, primitive_templates=None, metadata_file=None)

Generates an English language description of a feature.

Parameters:

• feature (FeatureBase) – Feature to describe

• feature_descriptions (dict, optional) – dictionary mapping features or unique feature names to custom descriptions

• primitive_templates (dict, optional) – dictionary mapping primitives or primitive names to description templates

• metadata_file (str, optional) – path to json metadata file

Returns:

English description of the feature

Return type:

str