NOTICE

The upcoming release of Featuretools 1.0.0 contains several breaking changes. Users are encouraged to test this version prior to release by installing from GitHub:

pip install https://github.com/alteryx/featuretools/archive/woodwork-integration.zip

For details on migrating to the new version, refer to Transitioning to Featuretools Version 1.0. Please report any issues in the Featuretools GitHub repo or by messaging in Alteryx Open Source Slack.


featuretools.describe_feature

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

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