diff --git a/.gitignore b/.gitignore index ccc6bae..56c5d42 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ /.idea/* -*/__pycache__/* +__pycache__/ *egg-info/* diff --git a/README.md b/README.md index d895deb..559c23e 100644 --- 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 new file mode 100644 index 0000000..55627d3 Binary files /dev/null and b/docs/images/sst_example.png differ