sklego/add-lags-positive
| Rule | add-lags-positive |
|---|---|
| Pack | scikit-lego |
| Severity | warning |
| Fix | none, edit by hand |
| Library versions | every version |
add_lags with a positive lag copies the value of a later row, so lag 1 is the next row and leaks the future into the features. Use negative lags for features from the past.
features = add_lags(frame, "sales", [1, 2])features = add_lags(frame, "sales", [-1, -2])What the rule reports
Section titled “What the rule reports”The rule reports add_lags with a positive lag, as a number, in a list or from range.
add_lags shifts by the negative of the lag, so lag 1 puts the value of the next row on each row.
pandas shift(1) goes the other way.
How to fix it
Section titled “How to fix it”xpd has no automatic fix, so make the change by hand.
On a frame with sales 10 to 50, the two calls gave the following columns:
| Call | Values of the new column |
|---|---|
add_lags(frame, "sales", 1) |
20, 30, 40, 50 |
add_lags(frame, "sales", -1) |
10, 20, 30, 40, from the second row on |
On a series of pure noise, a model given the column from lag 1 predicted the sign of the next row with accuracy 0.996. A model given the column from lag -1 predicted the sign of its own row with accuracy 0.474. A positive lag is right when the new column is the target of a forecast, so the rule is a warning.
A range is reported when its numbers are written out and it holds a positive lag, which means it
starts at 1 or more, or counts up to a stop of 2 or more. range(0, -3, -1) holds 0, -1 and -2
and is left alone.
Message
Section titled “Message”xpd prints this message with the issue. A name that starts with $ stands for code from your file.
add_lags with a positive lag copies the value of a later row, so lag 1 is the next row and not the row before. On pure noise that column predicted the next row's sign with accuracy 0.996, where lag -1 scored 0.474. Use negative lags for features from the past.Browse the other rules of the scikit-lego pack.