Update documentation

arnedb · May 23, 2022 · 0522978 · 0522978
1 parent 8443e50
commit 0522978
Show file tree

Hide file tree

Showing 65 changed files with 23,787 additions and 1 deletion.
diff --git a/docs/_images/angles.png b/docs/_images/angles.png
diff --git a/docs/_images/quickstart_17_0.svg b/docs/_images/quickstart_17_0.svg
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,23 @@
+Welcome to TSFuse's documentation!
+==================================
+
+TSFuse is a Python package for automatically constructing features from
+multiple time series. Instead of extracting univariate time series features,
+TSFuse generates new series by applying time series fusion operations.
+
+.. toctree::
+   :caption: Contents
+   :maxdepth: 1
+
+   installation
+   quickstart.ipynb
+
+.. toctree::
+   :caption: Modules
+   :maxdepth: 1
+
+   modules/tsfuse
+   modules/tsfuse.data
+   modules/tsfuse.computation
+   modules/tsfuse.construction
+   modules/tsfuse.transformers
diff --git a/docs/_sources/installation.rst.txt b/docs/_sources/installation.rst.txt
@@ -0,0 +1,15 @@
+Installation
+------------
+
+Install the latest release using pip:
+
+::
+
+    $ pip install tsfuse
+
+
+Alternatively, you can install the unreleased version from GitHub:
+
+::
+
+    $ pip install git+https://github.com/arnedb/tsfuse#egg=tsfuse
diff --git a/docs/_sources/modules/tsfuse.computation.rst.txt b/docs/_sources/modules/tsfuse.computation.rst.txt
@@ -0,0 +1,5 @@
+tsfuse.computation
+==================
+
+.. automodule:: tsfuse.computation
+   :members:
diff --git a/docs/_sources/modules/tsfuse.construction.rst.txt b/docs/_sources/modules/tsfuse.construction.rst.txt
@@ -0,0 +1,5 @@
+tsfuse.construction
+===================
+
+.. automodule:: tsfuse.construction
+   :members:
diff --git a/docs/_sources/modules/tsfuse.data.rst.txt b/docs/_sources/modules/tsfuse.data.rst.txt
@@ -0,0 +1,5 @@
+tsfuse.data
+===========
+
+.. automodule:: tsfuse.data
+   :members:
diff --git a/docs/_sources/modules/tsfuse.rst.txt b/docs/_sources/modules/tsfuse.rst.txt
@@ -0,0 +1,5 @@
+tsfuse
+======
+
+.. automodule:: tsfuse
+   :members:
diff --git a/docs/_sources/modules/tsfuse.transformers.rst.txt b/docs/_sources/modules/tsfuse.transformers.rst.txt
@@ -0,0 +1,68 @@
+.. _transformers:
+
+tsfuse.transformers
+===================
+
+tsfuse.transformers.boolean
+---------------------------
+
+.. automodule:: tsfuse.transformers.boolean
+   :members:
+   :undoc-members:
+   :exclude-members: apply, graph, unit
+
+tsfuse.transformers.frequency
+-----------------------------
+
+.. automodule:: tsfuse.transformers.frequency
+   :members:
+   :undoc-members:
+   :exclude-members: apply, graph, unit
+
+tsfuse.transformers.geometry
+----------------------------
+
+.. automodule:: tsfuse.transformers.geometry
+   :members:
+   :undoc-members:
+   :exclude-members: apply, graph, unit
+
+tsfuse.transformers.mathematics
+-------------------------------
+
+.. automodule:: tsfuse.transformers.mathematics
+   :members:
+   :undoc-members:
+   :exclude-members: apply, graph, unit, Sin, Cos, Tan, ArcSin, ArcCos, ArcTan
+
+tsfuse.transformers.peaks
+-------------------------
+
+.. automodule:: tsfuse.transformers.peaks
+   :members:
+   :undoc-members:
+   :exclude-members: apply, graph, unit
+
+tsfuse.transformers.sampling
+----------------------------
+
+.. automodule:: tsfuse.transformers.sampling
+   :members:
+   :undoc-members:
+   :exclude-members: apply, graph, unit
+
+tsfuse.transformers.statistics
+------------------------------
+
+.. automodule:: tsfuse.transformers.statistics
+   :members:
+   :undoc-members:
+   :exclude-members: apply, graph, unit, SinglePassStatistics
+
+tsfuse.transformers.uniqueness
+------------------------------
+
+.. automodule:: tsfuse.transformers.uniqueness
+   :members:
+   :undoc-members:
+   :exclude-members: apply, graph, unit