Update usage example of sst (README.md)

tsurubee · Oct 8, 2017 · 866c6a0 · 866c6a0
1 parent 1553211
commit 866c6a0
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,3 @@
 /.idea/*
-*/__pycache__/*
+__pycache__/
 *egg-info/*
diff --git a/README.md b/README.md
@@ -18,6 +18,18 @@ $ python
 >>> import banpei
 ```
 
+## Usage
+#### Example
+*Singular spectrum transformation(sst)*
+```python
+import banpei 
+model   = banpei.SST(data, w=50)
+results = model.detect()
+```
+The graph below shows the change-point scoring calculated by sst for the periodic data. (The data used is placed in '/tests/test_data/periodic_wave.csv')
+
+![sst example](./docs/images/sst_example.png)
+
 ## The implemented algorithm
 #### Outlier detection
 * Hotelling's theory

diff --git a/docs/images/sst_example.png b/docs/images/sst_example.png