(add) features -> docs

elkotito · Jul 8, 2019 · 2222763 · 2222763
1 parent eecb522
commit 2222763
Show file tree

Hide file tree

Showing 13 changed files with 340 additions and 2 deletions.
diff --git a/docs/features.rst b/docs/features.rst
@@ -0,0 +1,45 @@
+========
+Features
+========
+
+Fast computation
+================
+by `Numba <https://numba.pydata.org>`_
+
+Partial alignment
+================
+
+* before alignment
+
+.. image:: img/partial_org.png
+
+* after alignment
+
+.. image:: img/partial_res.png
+
+Local constraint (step pattern)
+================
+
+example: 
+
+.. csv-table::
+  :header: "Symmetric2", "AsymmetricP2", "TypeIVc"
+  :widths: 15, 15, 15
+
+  .. image:: img/symmetric2.png, .. image:: img/asymmetricP2.png, .. image:: img/typeIVc.png
+
+Global constraint (windowing)
+================
+
+example:
+
+.. csv-table::
+  :header: "Sakoechiba", "Itakura", "User defined"
+  :widths: 15, 15, 15
+
+  .. image:: img/sakoechiba.png, .. image:: img/itakura.png, .. image:: img/user_win.png
+
+
+Alignment path visualization
+================
+.. image:: img/partial_path.png
diff --git a/docs/img/asymmetricP2.png b/docs/img/asymmetricP2.png
diff --git a/docs/img/imgs.ipynb b/docs/img/imgs.ipynb
diff --git a/docs/img/itakura.png b/docs/img/itakura.png
diff --git a/docs/img/partial_org.png b/docs/img/partial_org.png
diff --git a/docs/img/partial_path.png b/docs/img/partial_path.png
diff --git a/docs/img/partial_res.png b/docs/img/partial_res.png
diff --git a/docs/img/sakoechiba.png b/docs/img/sakoechiba.png
diff --git a/docs/img/symmetric2.png b/docs/img/symmetric2.png
diff --git a/docs/img/typeIVc.png b/docs/img/typeIVc.png
diff --git a/docs/img/user_win.png b/docs/img/user_win.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,17 +3,33 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+====================================
 Welcome to dtwalign's documentation!
 ====================================
 
+Comprehensive dynamic time warping module for python.
+
+Installation
+============
+```
+pip install dtwalign
+```
+
+Fast computation
+----------------
+
+by [Numba](https://numba.pydata.org)
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   modules
-
+   features
+   tutorial
+   api
 
 
+==================
 Indices and tables
 ==================
 

diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -0,0 +1,4 @@
+========
+Tutorial
+========
+