Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ankane/breakout-ruby
Breakout detection for Ruby
https://github.com/ankane/breakout-ruby
Last synced: about 1 month ago
JSON representation
Breakout detection for Ruby
- Host: GitHub
- URL: https://github.com/ankane/breakout-ruby
- Owner: ankane
- License: gpl-2.0
- Created: 2021-09-03T05:30:15.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-27T04:00:04.000Z (about 2 months ago)
- Last Synced: 2024-07-27T05:21:10.162Z (about 2 months ago)
- Language: Ruby
- Size: 36.1 KB
- Stars: 44
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Breakout Ruby
:fire: [BreakoutDetection](https://github.com/twitter/BreakoutDetection) for Ruby
Learn [how it works](https://blog.twitter.com/engineering/en_us/a/2014/breakout-detection-in-the-wild)
[](https://github.com/ankane/breakout-ruby/actions)
## Installation
Add this line to your application’s Gemfile:
```ruby
gem "breakout-detection"
```
## Getting Started
Detect breakouts in a time series
```ruby
series = {
Date.parse("2023-01-01") => 100,
Date.parse("2023-01-02") => 150,
Date.parse("2023-01-03") => 136,
# ...
}
Breakout.detect(series)
```
Works great with [Groupdate](https://github.com/ankane/groupdate)
```ruby
series = User.group_by_day(:created_at).count
Breakout.detect(series)
```
Series can also be an array without times (the index is returned)
```ruby
series = [100, 150, 136, ...]
Breakout.detect(series)
```
## Options
Pass options - default values below
```ruby
Breakout.detect(
series,
min_size: 30, # minimum observations between breakouts
method: "multi", # multi or amoc (at most one change)
degree: 1, # degree of the penalization polynomial (multi only)
beta: 0.008, # penalization term (multi only)
percent: nil, # minimum percent change in goodness of fit statistic (multi only)
alpha: 2, # weight of the distance between observations (amoc only)
exact: true # exact or approximate median (amoc only)
)
```
## Plotting
Add [Vega](https://github.com/ankane/vega) to your application’s Gemfile:
```ruby
gem "vega"
```
And use:
```ruby
Breakout.plot(series, breakouts)
```
## Credits
This library uses the C++ code from the [BreakoutDetection](https://github.com/twitter/BreakoutDetection) R package and is available under the same license.
## References
- [Leveraging Cloud Data to Mitigate User Experience from ‘Breaking Bad’](https://arxiv.org/abs/1411.7955)
## History
View the [changelog](https://github.com/ankane/breakout-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/breakout-ruby/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/breakout-ruby/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
To get started with development:
```sh
git clone https://github.com/ankane/breakout-ruby.git
cd breakout-ruby
bundle install
bundle exec rake compile
bundle exec rake test
```