featuretools.primitives.Diff#

class featuretools.primitives.Diff(periods=0)[source]#

Computes the difference between the value in a list and the previous value in that list.

Parameters:

periods (int) – The number of periods by which to shift the index row. Default is 0. Periods correspond to rows.

Description:

Given a list of values, compute the difference from the previous item in the list. The result for the first element of the list will always be NaN.

Examples

>>> diff = Diff()
>>> values = [1, 10, 3, 4, 15]
>>> diff(values).tolist()
[nan, 9.0, -7.0, 1.0, 11.0]

You can specify the number of periods to shift the values

>>> values = [1, 2, 4, 7, 11, 16]
>>> diff_periods = Diff(periods = 1)
>>> diff_periods(values).tolist()
[nan, nan, 1.0, 2.0, 3.0, 4.0]
__init__(periods=0)[source]#

Methods

__init__([periods])

flatten_nested_input_types(input_types)

Flattens nested column schema inputs into a single list.

generate_name(base_feature_names)

generate_names(base_feature_names)

get_args_string()

get_arguments()

get_description(input_column_descriptions[, ...])

get_filepath(filename)

get_function()

Attributes

base_of

base_of_exclude

commutative

compatibility

Additional compatible libraries

default_value

Default value this feature returns if no data found.

description_template

input_types

woodwork.ColumnSchema types of inputs

max_stack_depth

name

Name of the primitive

number_output_features

Number of columns in feature matrix associated with this feature

return_type

ColumnSchema type of return

series_library

stack_on

stack_on_exclude

stack_on_self

uses_calc_time

uses_full_dataframe