Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved speed #681

Merged
merged 24 commits into from
May 11, 2020
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
52c1a69
Started refactoring the rolling function
nils-braun Apr 13, 2020
0d5fd4e
Unfinished test fix
nils-braun Apr 13, 2020
b0006cd
Fixed remaining rolling tests
nils-braun Apr 13, 2020
c4e90a8
Correct the shifted values and the index
nils-braun Apr 13, 2020
3c3c0e9
Added test for min timeshift
nils-braun Apr 13, 2020
ffae951
Added parallelization to the rolling function
nils-braun Apr 13, 2020
c480005
Be python 3.5 compatible...
nils-braun Apr 14, 2020
304f450
Reworked the rolling documentation
nils-braun Apr 16, 2020
7bf7b9e
Copy-paste error
nils-braun Apr 16, 2020
08e7343
Improved forecasting documentation
Apr 16, 2020
c6e41e2
pep8ify
nils-braun Apr 16, 2020
ab24c93
Speed up quantile calculation
nils-braun Apr 20, 2020
ce493e5
Replace sample_entropy by corrected and faster reference implementati…
nils-braun Apr 20, 2020
c44080c
Added task file for testing
nils-braun Apr 22, 2020
d0465c6
Bump the requirement for numpy to use the quantile function
nils-braun Apr 29, 2020
bc59a0d
Move to correct location
nils-braun May 1, 2020
9c79823
Merge remote-tracking branch 'origin/master' into feature/improved-speed
nils-braun May 1, 2020
b209b93
pep8ify
nils-braun May 1, 2020
85ad39b
Does not make sense to include script in coverage
nils-braun May 2, 2020
51e0ccd
The linear_trend_timewise is not a high computation costs calculator …
nils-braun May 3, 2020
b1499da
Remove unneeded import
nils-braun May 3, 2020
ce15784
Make the random-seed seeting more explicit
nils-braun May 9, 2020
888fb98
Added more tests, more documentation and fixed another bug in the imp…
nils-braun May 9, 2020
b3fa7e8
Added changelog
nils-braun May 11, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ omit = tsfresh/utilities/profiling.py
tsfresh/examples/driftbif_simulation.py
tsfresh/examples/test_tsfresh_baseline_dataset.py
tsfresh/scripts/test_timing.py
tsfresh/scripts/measure_execution_time.py

[report]
# Regexes for lines to exclude from consideration
Expand Down
4 changes: 2 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,10 @@ jobs:
# python 3.7 requires pandas >= 0.23.2
python: 3.7

- env: NUMPY="1.12.0" PANDAS="0.20.3" SCIKITLEARN="0.19.0" DASK="0.15.2" DISTRIBUTED="1.18.3" SCIPY="1.2.0" STATSMODELS="0.9.0"
- env: NUMPY="1.15.1" PANDAS="0.20.3" SCIKITLEARN="0.19.0" DASK="0.15.2" DISTRIBUTED="1.18.3" SCIPY="1.2.0" STATSMODELS="0.9.0"
python: 3.6

- env: NUMPY="1.12.0" PANDAS="0.20.3" SCIKITLEARN="0.19.0" DASK="0.15.2" DISTRIBUTED="1.18.3" SCIPY="1.2.0" STATSMODELS="0.9.0"
- env: NUMPY="1.15.1" PANDAS="0.20.3" SCIKITLEARN="0.19.0" DASK="0.15.2" DISTRIBUTED="1.18.3" SCIPY="1.2.0" STATSMODELS="0.9.0"
python: 3.5.3


Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
requests>=2.9.1
numpy>=1.12.0
numpy>=1.15.1
pandas>=0.20.3,!=0.24.* # pandas dropna is buggy in 0.24.0, see https://github.com/blue-yonder/tsfresh/issues/485 and https://github.com/pandas-dev/pandas/issues/25087
scipy>=1.2.0
statsmodels>=0.8.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -794,7 +794,7 @@ def test_sample_entropy(self):
ts = [1, 4, 5, 1, 7, 3, 1, 2, 5, 8, 9, 7, 3, 7, 9, 5, 4, 3, 9, 1, 2, 3, 4, 2, 9, 6, 7, 4, 9, 2, 9, 9, 6, 5, 1,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add some more unit tests for the sample_entroy?
I am missing:

  • short time series
  • negative values in time series
  • only negative values in time series
  • np.NaN in time series
    etc.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added more tests and some documentation on the tests in my last commit.

3, 8, 1, 5, 3, 8, 4, 1, 2, 2, 1, 6, 5, 3, 6, 5, 4, 8, 9, 6, 7, 5, 3, 2, 5, 4, 2, 5, 1, 6, 5, 3, 5, 6, 7,
8, 5, 2, 8, 6, 3, 8, 2, 7, 1, 7, 3, 5, 6, 2, 1, 3, 7, 3, 5, 3, 7, 6, 7, 7, 2, 3, 1, 7, 8]
self.assertAlmostEqualOnAllArrayTypes(sample_entropy, ts, 2.21187685)
self.assertAlmostEqualOnAllArrayTypes(sample_entropy, ts, 2.374905754573672)

def test_autocorrelation(self):
self.assertAlmostEqualOnAllArrayTypes(autocorrelation, [1, 2, 1, 2, 1, 2], -1, 1)
Expand Down
56 changes: 20 additions & 36 deletions tsfresh/feature_extraction/feature_calculators.py
Original file line number Diff line number Diff line change
Expand Up @@ -1539,40 +1539,26 @@ def sample_entropy(x):
"""
x = np.array(x)

sample_length = 1 # number of sequential points of the time series
tolerance = 0.2 * np.std(x) # 0.2 is a common value for r - why?
m = 2 # common value for m, according to wikipedia...
tolerance = 0.2 * np.std(x) # 0.2 is a common value for r, according to wikipedia...

n = len(x)
prev = np.zeros(n)
curr = np.zeros(n)
A = np.zeros((1, 1)) # number of matches for m = [1,...,template_length - 1]
B = np.zeros((1, 1)) # number of matches for m = [1,...,template_length]

for i in range(n - 1):
nj = n - i - 1
ts1 = x[i]
for jj in range(nj):
j = jj + i + 1
if abs(x[j] - ts1) < tolerance: # distance between two vectors
curr[jj] = prev[jj] + 1
temp_ts_length = min(sample_length, curr[jj])
for m in range(int(temp_ts_length)):
A[m] += 1
if j < n - 1:
B[m] += 1
else:
curr[jj] = 0
for j in range(nj):
prev[j] = curr[j]
N = len(x)

# Split time series and save all templates of length m
xmi = np.array([x[i:i + m] for i in range(N - m)])
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. np.split splits without overlap.
We want to turn the array [1, 2, 3, 4] into [1, 2], [2, 3], [3, 4] but np.split would only give [1, 2], [3, 4].

xmj = np.array([x[i:i + m] for i in range(N - m + 1)])

N = n * (n - 1) / 2
B = np.vstack(([N], B[0]))
# Save all matches minus the self-match, compute B
B = np.sum([np.sum(np.abs(xmii - xmj).max(axis=1) <= tolerance) - 1 for xmii in xmi])

# sample entropy = -1 * (log (A/B))
similarity_ratio = A / B
se = -1 * np.log(similarity_ratio)
se = np.reshape(se, -1)
return se[0]
# Similar for computing A
m += 1
xm = np.array([x[i:i + m] for i in range(N - m + 1)])

A = np.sum([np.sum(np.abs(xmi - xm).max(axis=1) <= tolerance) - 1 for xmi in xm])

# Return SampEn
return -np.log(A / B)


@set_property("fctype", "simple")
Expand Down Expand Up @@ -1620,7 +1606,6 @@ def autocorrelation(x, lag):


@set_property("fctype", "simple")
@set_property("input", "pd.Series")
def quantile(x, q):
"""
Calculates the q quantile of x. This is the value of x greater than q% of the ordered values from x.
Expand All @@ -1632,9 +1617,9 @@ def quantile(x, q):
:return: the value of this feature
:return type: float
"""
if not isinstance(x, pd.Series):
x = pd.Series(x)
return pd.Series.quantile(x, q)
if len(x) == 0:
return np.NaN
return np.quantile(x, q)


@set_property("fctype", "simple")
Expand Down Expand Up @@ -1961,7 +1946,6 @@ def energy_ratio_by_chunks(x, param):
@set_property("fctype", "combiner")
@set_property("input", "pd.Series")
@set_property("index_type", pd.DatetimeIndex)
@set_property("high_comp_cost", True)
def linear_trend_timewise(x, param):
"""
Calculate a linear least-squares regression for the values of the time series versus the sequence from 0 to
Expand Down
162 changes: 162 additions & 0 deletions tsfresh/scripts/measure_execution_time.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
# This script extracts the execution time for
# various different settings of tsfresh
# using different input data
# Attention: it will run for ~half a day
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on how many cores?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On two. I have described the machine setup on my blog-post: https://nils-braun.github.io/execution-time/

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, maybe to be more clear:
it does not matter on how many cores, as the number of cores is a parameter which is set to 0, 1 and 4 for the tests (to see the scaling).
But I did my studies on a google cloud 2-core (4 threads) virtual machine.

# Do these calculations in a controlled environment
# (e.g. a cloud provider VM)
# You will need to have b2luigi installed.
from tsfresh.feature_extraction import ComprehensiveFCParameters, MinimalFCParameters, extract_features

import pandas as pd
import numpy as np
from time import time
import b2luigi as luigi
import json

np.random.seed(42)
nils-braun marked this conversation as resolved.
Show resolved Hide resolved


class DataCreationTask(luigi.Task):
"""Create random data for testing"""
num_ids = luigi.IntParameter(default=100)
time_series_length = luigi.IntParameter()

def output(self):
yield self.add_to_output("data.csv")

def run(self):
df = pd.concat([
pd.DataFrame({
"id": [i] * self.time_series_length,
"time": range(self.time_series_length),
"value": np.random.randn(self.time_series_length)
})
for i in range(self.num_ids)
])

with self._get_output_target("data.csv").open("w") as f:
df.to_csv(f)


@luigi.requires(DataCreationTask)
class TimingTask(luigi.Task):
"""Run tsfresh with the given parameters"""
feature_parameter = luigi.DictParameter(hashed=True)
n_jobs = luigi.IntParameter()
try_number = luigi.IntParameter()

def output(self):
yield self.add_to_output("result.json")

def run(self):
input_file = self._get_input_targets("data.csv")[0]

with input_file.open("r") as f:
df = pd.read_csv(f)

start_time = time()
extract_features(df, column_id="id", column_sort="time", n_jobs=self.n_jobs,
default_fc_parameters=self.feature_parameter,
disable_progressbar=True)
end_time = time()

single_parameter_name = list(self.feature_parameter.keys())[0]
single_parameter_params = self.feature_parameter[single_parameter_name]

result_json = {
"time": end_time - start_time,
"n_ids": self.num_ids,
"n_jobs": self.n_jobs,
"feature": single_parameter_name,
"number_parameters": len(single_parameter_params) if single_parameter_params else 0,
"time_series_length": int((df["id"] == 0).sum()),
"try_number": self.try_number,
}

with self._get_output_target("result.json").open("w") as f:
json.dump(result_json, f)


@luigi.requires(DataCreationTask)
class FullTimingTask(luigi.Task):
"""Run tsfresh with all calculators for comparison"""
n_jobs = luigi.IntParameter()

def output(self):
yield self.add_to_output("result.json")

def run(self):
input_file = self._get_input_targets("data.csv")[0]

with input_file.open("r") as f:
df = pd.read_csv(f)

start_time = time()
extract_features(df, column_id="id", column_sort="time", n_jobs=self.n_jobs,
disable_progressbar=True)
end_time = time()

result_json = {
"time": end_time - start_time,
"n_ids": self.num_ids,
"n_jobs": self.n_jobs,
"time_series_length": int((df["id"] == 0).sum()),
}

with self._get_output_target("result.json").open("w") as f:
json.dump(result_json, f)


class CombinerTask(luigi.Task):
"""Collect all tasks into a single result.csv file"""
def complete(self):
return False

def requires(self):
settings = ComprehensiveFCParameters()
for job in [0, 1, 4]:
for time_series_length in [100, 500, 1000, 5000]:
yield FullTimingTask(time_series_length=time_series_length,
n_jobs=job,
num_ids=10)
yield FullTimingTask(time_series_length=time_series_length,
n_jobs=job,
num_ids=100)

for feature_name in settings:
yield TimingTask(
feature_parameter={feature_name: settings[feature_name]},
time_series_length=time_series_length,
n_jobs=job,
num_ids=100,
try_number=0,
)

for try_number in range(3):
yield TimingTask(
feature_parameter={feature_name: settings[feature_name]},
n_jobs=job,
try_number=try_number,
num_ids=10,
time_series_length=time_series_length
)

def output(self):
yield self.add_to_output("results.csv")

def run(self):
results = []

for input_file in self._get_input_targets("result.json"):
with input_file.open("r") as f:
results.append(json.load(f))

df = pd.DataFrame(results)

with self._get_output_target("results.csv").open("w") as f:
df.to_csv(f)


if __name__ == "__main__":
luigi.set_setting("result_path", "results")
luigi.process(CombinerTask())