featuretools.primitives.Lag#

class featuretools.primitives.Lag(periods=1)[source]#

Shifts an array of values by a specified number of periods.

Parameters:

periods (int) – The number of periods by which to shift the input. Default is 1. Periods correspond to rows.

Examples

>>> lag = Lag()
>>> lag([1, 2, 3, 4, 5], pd.Series(pd.date_range(start="2020-01-01", periods=5, freq='D'))).tolist()
[nan, 1.0, 2.0, 3.0, 4.0]

You can specify the number of periods to shift the values

>>> lag_periods = Lag(periods=3)
>>> lag_periods([True, False, False, True, True], pd.Series(pd.date_range(start="2020-01-01", periods=5, freq='D'))).tolist()
[nan, nan, nan, True, False]
__init__(periods=1)[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