Merge pull request #70 from zillow/feature/citation-policy

Feature/citation policy

README.md

@@ -74,11 +74,26 @@ Luminaire can also monitor a set of data points over windows of time instead of
 
 Want to help improve Luminaire? Check out our [contributing documentation](CONTRIBUTING.rst).
 
+## Citing
+
+Please cite the following article if Luminaire is used for any research purpose or scientific publication:
+
+*Chakraborty, S., Shah, S., Soltani, K., Swigart, A., Yang, L., & Buckingham, K. (2020). Building an Automated and 
+Self-Aware Anomaly Detection System. arXiv preprint arXiv:2011.05047.* ([arxiv link](https://arxiv.org/abs/2011.05047))
+
+## Other Useful Resources
+
+1. *Chakraborty, S., Shah, S., Soltani, K., & Swigart, A. (2019, December). Root Cause Detection Among Anomalous Time 
+Series Using Temporal State Alignment. In 2019 18th IEEE International Conference On Machine Learning And Applications 
+(ICMLA) (pp. 523-528). IEEE.* ([arxiv link](https://arxiv.org/abs/2001.01056))
+
+
 ## Acknowledgements
 
 This project has leveraged methods described in the following scientific publications:
 
-1. Soule, Augustin, Kavé Salamatian, and Nina Taft. "Combining filtering and statistical methods for anomaly detection." Proceedings of the 5th ACM SIGCOMM conference on Internet Measurement. 2005.
+1. *Soule, Augustin, Kavé Salamatian, and Nina Taft. "Combining filtering and statistical methods for anomaly detection.
+" Proceedings of the 5th ACM SIGCOMM conference on Internet Measurement. 2005.*
 
 
 ## Development Team

docs/introduction.rst

@@ -39,3 +39,11 @@ Luminaire combines many techniques under hood to find the optimal model for ever
 Anomaly Detection for Streaming Data
 ------------------------------------
 Luminaire performs anomaly detection over streaming data by comparing the volume density of the incoming data stream with a preset baseline time series window. Luminaire is capable of tracking time series windows over different data frequencies and is autoconfigured to support most typical streaming use cases.
+
+Citing
+------
+Please cite the following article if Luminaire is used for any research purpose or scientific publication:
+
+*Chakraborty, S., Shah, S., Soltani, K., Swigart, A., Yang, L., & Buckingham, K. (2020). Building an Automated and Self-Aware Anomaly Detection System. arXiv preprint arXiv:2011.05047.* (`arxiv_link`_)
+
+.. _arxiv_link: https://arxiv.org/abs/2001.01056

setup.py

@@ -14,7 +14,7 @@
 
 setup(
     name='luminaire',
-    version='0.1.3',
+    version='0.1.4',
 
     license='Apache License 2.0',