search

aws / random-cut-forest-by-aws

An implementation of the Random Cut Forest data structure for sketching streaming data, with support for anomaly detection, density estimation, imputation, and more.
https://github.com/aws/random-cut-forest-by-aws
Apache License 2.0
210 stars 33 forks source link

Add more document #296

Closed ylwu-amzn closed 2 years ago

ylwu-amzn commented 2 years ago

We are adding more and more interesting features to this library like ForestMode and ThresholdedRandomCutForest. But seems there are little doc to explain how to use these new feature/parameters correctly. Yes, we can learn from the code directly, but that takes time and not efficient especially when people just want to use RCF directly rather than develop code. Will highly appreciate it if anyone can add more tutorial documents with some example code. For example, how to use RCF to do non-time-series anomaly detection or population analysis, and how to use RCF to forecast and what's the limitation.

ylwu-amzn commented 2 years ago

Seems the README doc doesn't have developer guide like how to setup development env, how to build etc. Refer to AD's REAME. https://github.com/opensearch-project/anomaly-detection, check

See developer guide and how to contribute to this project.

sudiptoguha commented 2 years ago

likely resolved with PR 333.