Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ankane/midas-ruby
Edge stream anomaly detection for Ruby
https://github.com/ankane/midas-ruby
Last synced: 4 days ago
JSON representation
Edge stream anomaly detection for Ruby
- Host: GitHub
- URL: https://github.com/ankane/midas-ruby
- Owner: ankane
- License: apache-2.0
- Created: 2020-02-18T07:04:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-27T04:10:03.000Z (3 months ago)
- Last Synced: 2024-10-10T12:23:35.203Z (24 days ago)
- Language: Ruby
- Size: 51.8 KB
- Stars: 54
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# MIDAS Ruby
[MIDAS](https://github.com/bhatiasiddharth/MIDAS) - edge stream anomaly detection - for Ruby
[](https://github.com/ankane/midas-ruby/actions)
## Installation
Add this line to your application’s Gemfile:
```ruby
gem "midas-edge"
```
## Getting Started
Prep your data in the format `[source, destination, time]` (all integers) and sorted by time (ascending)
```ruby
data = [
[2, 3, 1],
[3, 4, 2],
[5, 9, 2],
[2, 3, 3]
]
```
Get anomaly scores
```ruby
midas = Midas.new
scores = midas.fit_predict(data)
```
Higher scores are more anomalous. There is [not currently](https://github.com/bhatiasiddharth/MIDAS/issues/4) a defined threshold for anomalies.
## Parameters
Pass parameters - default values below
```ruby
Midas.new(
rows: 2, # number of hash functions
buckets: 769, # number of buckets
alpha: 0.5, # temporal decay factor
threshold: nil, # todo
relations: true, # whether to use MIDAS-R or MIDAS
directed: true, # treat the graph as directed or undirected
seed: 0 # random seed
)
```
## Data
Data can be an array of arrays
```ruby
[[1, 2, 3], [4, 5, 6]]
```
Or a Numo array
```ruby
Numo::NArray.cast([[1, 2, 3], [4, 5, 6]])
```
## Performance
For large datasets, read data directly from files
```ruby
midas.fit_predict("data.csv")
```
## Resources
- [MIDAS: Microcluster-Based Detector of Anomalies in Edge Streams](https://www.comp.nus.edu.sg/~sbhatia/assets/pdf/midas.pdf)
## History
View the [changelog](https://github.com/ankane/midas-ruby/blob/master/CHANGELOG.md)
## Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- [Report bugs](https://github.com/ankane/midas-ruby/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/midas-ruby/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
To get started with development:
```sh
git clone --recursive https://github.com/ankane/midas-ruby.git
cd midas-ruby
bundle install
bundle exec rake compile
bundle exec rake test
```