Merge pull request #92 from giotto-ai/examples

Examples

.gitignore

@@ -78,6 +78,7 @@ target/
 
 # Jupyter NB Checkpoints
 .ipynb_checkpoints/
+Untitled*
 
 # exclude data from source control by default
 /data/

examples/README.rst

@@ -0,0 +1,27 @@
+.. image:: https://www.giotto.ai/static/vector/logo.svg
+   :width: 850
+
+Examples and Tutorials
+======================
+
+In this folder you can find basic tutorials and examples: you can read through them to
+understand how `giotto-time` works.
+
+Quick start
+-----------
+
+This tutorial is about giving an overview on the basic features of `giotto-time`.
+You will learn how to train a simple time series model with custom features.
+Some considerations on input-output are presented.
+
+Details and advanced features
+-----------------------------
+
+This tutorial details more advanced features of `giotto-time`.
+You will learn more details on the feature generation and on custom linear regressor
+model for time series forecasting.
+
+Causality Tests
+---------------
+
+This tutorial details the causality tests built-in in `giotto-time`.