NOTICE

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

pip install featuretools==1.0.0rc1

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.get_valid_primitives

featuretools.get_valid_primitives(entityset, target_entity, max_depth=2, selected_primitives=None)[source]

Returns two lists of primitives (transform and aggregation) containing primitives that can be applied to the specific target entity to create features. If the optional ‘selected_primitives’ parameter is not used, all discoverable primitives will be considered.

Note

When using a max_depth greater than 1, some primitives returned by this function may not create any features if passed to DFS alone. These primitives relied on features created by other primitives as input (primitive stacking).

Parameters
  • entityset (EntitySet) – An already initialized entityset

  • target_entity (str) – Entity id of entity to create features for.

  • max_depth (int, optional) – Maximum allowed depth of features.

  • selected_primitives (list[str or AggregationPrimitive/TransformPrimitive], optional) – list of primitives to consider when looking for valid primitives. If None, all primitives will be considered

Returns

The list of valid aggregation primitives and the list of valid transform primitives.

Return type

list[AggregationPrimitive], list[TransformPrimitive]