Skip to content

Commit a73a166

Browse files
MaxBenChristMaxBenChrist
authored
Polish docs (blue-yonder#331)
* correct references to FCParameters in doc closes issue 323 * smoother formulation * correct underlines * refer to footnotes * another missing reference to footnote * sample entropy does not have tolerance parameter * correctly reference footnotes * another two footnote references * add header for script modules * correct docstring of run script * fixed module level references * not possible to link rubric references in feature calculators * need newlines between codeblocks * fix reference of tests
1 parent 54c5431 commit a73a166

16 files changed

+202
-40
lines changed

‎docs/api/tests.integrations.rst‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
tests.integrations package
2+
==========================
3+
4+
Submodules
5+
----------
6+
7+
tests.integrations.test_full_pipeline module
8+
--------------------------------------------
9+
10+
.. automodule:: tests.integrations.test_full_pipeline
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
tests.integrations.test_notebooks module
16+
----------------------------------------
17+
18+
.. automodule:: tests.integrations.test_notebooks
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
tests.integrations.test_relevant_feature_extraction module
24+
----------------------------------------------------------
25+
26+
.. automodule:: tests.integrations.test_relevant_feature_extraction
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
32+
Module contents
33+
---------------
34+
35+
.. automodule:: tests.integrations
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:

‎docs/api/tests.rst‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,6 @@ tests.fixtures module
1212
:undoc-members:
1313
:show-inheritance:
1414

15-
tests.test_feature_significance module
16-
--------------------------------------
17-
18-
.. automodule:: tests.test_feature_significance
19-
:members:
20-
:undoc-members:
21-
:show-inheritance:
22-
2315

2416
Module contents
2517
---------------

‎docs/api/tests.units.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
tests.units package
2+
===================
3+
4+
Submodules
5+
----------
6+
7+
tests.units.test_feature_significance module
8+
--------------------------------------------
9+
10+
.. automodule:: tests.units.test_feature_significance
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
16+
Module contents
17+
---------------
18+
19+
.. automodule:: tests.units
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:

‎docs/api/tsfresh.feature_selection.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ feature_selection
77
:show-inheritance:
88

99
benjamini_hochberg_test
10-
----------------
10+
-----------------------
1111

1212
.. automodule:: tsfresh.feature_selection.benjamini_hochberg_test
1313
:members:
1414
:undoc-members:
1515
:show-inheritance:
1616

1717
relevance
18-
----------------
18+
---------
1919

2020
.. automodule:: tsfresh.feature_selection.relevance
2121
:members:

‎docs/api/tsfresh.scripts.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
tsfresh.scripts package
2+
=======================
3+
4+
Submodules
5+
----------
6+
7+
tsfresh.scripts.run_tsfresh module
8+
----------------------------------
9+
10+
.. automodule:: tsfresh.scripts.run_tsfresh
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
tsfresh.scripts.test_timing module
16+
----------------------------------
17+
18+
.. automodule:: tsfresh.scripts.test_timing
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
24+
Module contents
25+
---------------
26+
27+
.. automodule:: tsfresh.scripts
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:

‎docs/text/_generated/tsfresh.feature_extraction.feature_calculators.rst‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
.. currentmodule:: tsfresh.feature_extraction.feature_calculators
2+
3+
4+
5+
.. autosummary::
6+
7+
abs_energy
8+
absolute_sum_of_changes
9+
agg_autocorrelation
10+
agg_linear_trend
11+
approximate_entropy
12+
ar_coefficient
13+
augmented_dickey_fuller
14+
autocorrelation
15+
binned_entropy
16+
c3
17+
change_quantiles
18+
count_above_mean
19+
count_below_mean
20+
cwt_coefficients
21+
energy_ratio_by_chunks
22+
fft_coefficient
23+
first_location_of_maximum
24+
first_location_of_minimum
25+
friedrich_coefficients
26+
has_duplicate
27+
has_duplicate_max
28+
has_duplicate_min
29+
index_mass_quantile
30+
kurtosis
31+
large_standard_deviation
32+
last_location_of_maximum
33+
last_location_of_minimum
34+
length
35+
linear_trend
36+
longest_strike_above_mean
37+
longest_strike_below_mean
38+
max_langevin_fixed_point
39+
maximum
40+
mean
41+
mean_abs_change
42+
mean_change
43+
mean_second_derivate_central
44+
median
45+
minimum
46+
number_crossing_m
47+
number_cwt_peaks
48+
number_peaks
49+
partial_autocorrelation
50+
percentage_of_reoccurring_datapoints_to_all_datapoints
51+
percentage_of_reoccurring_values_to_all_values
52+
quantile
53+
range_count
54+
ratio_beyond_r_sigma
55+
ratio_value_number_to_time_series_length
56+
sample_entropy
57+
set_property
58+
skewness
59+
spkt_welch_density
60+
standard_deviation
61+
sum_of_reoccurring_data_points
62+
sum_of_reoccurring_values
63+
sum_values
64+
symmetry_looking
65+
time_reversal_asymmetry_statistic
66+
value_count
67+
variance
68+
variance_larger_than_standard_deviation
69+

‎docs/text/how_to_add_custom_feature.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Step 3. Add custom settings for your feature
102102
103103
Finally, you have to add custom settings if your feature is a simple or combiner feature with parameters. To do so,
104104
just append your feature with sane default parameters to the ``name_to_param`` dictionary inside the
105-
:class:`tsfresh.ComprehensiveFCParameters` constructor:
105+
:class:`tsfresh.feature_extraction.settings.ComprehensiveFCParameters` constructor:
106106
107107
.. code:: python
108108
@@ -117,7 +117,7 @@ just append your feature with sane default parameters to the ``name_to_param`` d
117117
That is it, tsfresh will calculate your feature the next time you run it.
118118
119119
Please make sure, that the different feature extraction settings
120-
(e.g. :class:`tsfresh.feature_extraction.settings.EfficientCParameters`,
120+
(e.g. :class:`tsfresh.feature_extraction.settings.EfficientFCParameters`,
121121
:class:`tsfresh.feature_extraction.settings.MinimalFCParameters` or
122122
:class:`tsfresh.feature_extraction.settings.ComprehensiveFCParameters`) do include different sets of
123123
feature calculators to use. You can control, which feature extraction settings object will include your new
@@ -129,5 +129,5 @@ Step 4. Add a pull request
129129
--------------------------
130130
131131
We would very happy if you contribute your implemented features to tsfresh. So make sure to create a pull request at our
132-
`github page <https://github.com/blue-yonder/tsfresh>`_. We happily accept partly implemented features that we can
133-
finalize.
132+
`github page <https://github.com/blue-yonder/tsfresh>`_. We happily accept partly implemented feature calculators, which
133+
we can finalize collaboratively.

‎tsfresh/examples/driftbif_simulation.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@
1313

1414
class velocity(object):
1515
"""
16-
Simulates the velocity of a dissipative soliton (kind of self organized particle).
17-
The equilibrium velocity without noise R=0 for $\tau>1.0/\kappa_3$ is $\kappa_3 \sqrt{(tau - 1.0/\kappa_3)/Q}. Before the drift-bifurcation $\tau \le 1.0/\kappa_3$ the velocity is zero.
16+
Simulates the velocity of a dissipative soliton (kind of self organized particle) [6]_.
17+
The equilibrium velocity without noise R=0 for
18+
$\tau>1.0/\kappa_3$ is $\kappa_3 \sqrt{(tau - 1.0/\kappa_3)/Q}.
19+
Before the drift-bifurcation $\tau \le 1.0/\kappa_3$ the velocity is zero.
1820
1921
References
2022
----------

‎tsfresh/examples/har_dataset.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
# Maximilian Christ (maximilianchrist.com), Blue Yonder Gmbh, 2016
44

55
"""
6-
This module implements functions to download and load the Human Activity Recognition dataset [4].
7-
A description of the data set can be found in [5].
6+
This module implements functions to download and load the Human Activity Recognition dataset [4]_.
7+
A description of the data set can be found in [5]_.
88
99
1010
References
1111
----------
1212
1313
.. [4] https://archive.ics.uci.edu/ml/datasets/Human+Activity+Recognition+Using+Smartphones
1414
.. [5] Davide Anguita, Alessandro Ghio, Luca Oneto, Xavier Parra and Jorge L. Reyes-Ortiz. (2013)
15-
A Public Domain Dataset for Human Activity Recognition Using Smartphones.
16-
21th European Symposium on Artificial Neural Networks,
17-
Computational Intelligence and Machine Learning, ESANN 2013. Bruges, Belgium 24-26 April 2013.
15+
A Public Domain Dataset for Human Activity Recognition Using Smartphones.
16+
21th European Symposium on Artificial Neural Networks,
17+
Computational Intelligence and Machine Learning, ESANN 2013. Bruges, Belgium 24-26 April 2013.
1818
1919
"""
2020

‎tsfresh/examples/robot_execution_failures.py‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
# Maximilian Christ (maximilianchrist.com), Blue Yonder Gmbh, 2016
44

55
"""
6-
This module implements functions to download the Robot Execution Failures LP1 Data Set[1] and load it as as DataFrame.
6+
This module implements functions to download the Robot Execution Failures LP1 Data Set [1]_, [2]_, [3]_ and load it as
7+
as DataFrame.
78
89
*Important:* You need to download the data set yourself, either manually or via the function
910
:func:`~tsfresh.examples.robot_execution_failures.download_robot_execution_failures`
@@ -41,7 +42,9 @@
4142

4243
def download_robot_execution_failures():
4344
"""
44-
Download the Robot Execution Failures LP1 Data Set[1] from the UCI Machine Learning Repository[2] and store it locally.
45+
Download the Robot Execution Failures LP1 Data Set[#1] from the UCI Machine Learning Repository [#2] and store it
46+
locally.
47+
4548
:return:
4649
4750
Examples

0 commit comments

Comments
 (0)